1 .\" Copyright (c) 1980, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
3 .\" Copyright (c) 1976 Board of Trustees of the University of Illinois.
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" @(#)indent.1 8.1 (Berkeley) 7/1/93
38 .Nd indent and format C program source
41 .Op Ar input-file Op Ar output-file
42 .Op Fl bacc | Fl nbacc
44 .Op Fl badp | Fl nbadp
102 according to the switches.
103 The switches which can be
104 specified are described below.
105 They may appear before or after the file
109 If you only specify an
112 done `in-place', that is, the formatted file is written back into
116 is written in the current directory.
120 .Sq Pa /blah/blah/file ,
121 the backup file is named
123 by default. The extension used for the backup file may be overridden using the
124 .Ev SIMPLE_BACKUP_SUFFIX
125 environment variable.
131 checks to make sure that it is different from
134 The options listed below control the formatting style imposed by
140 is specified, a blank line is forced around every conditional
142 For example, in front of every #ifdef and after every #endif.
143 Other blank lines surrounding such blocks will be swallowed.
149 is specified, a blank line is forced after every block of
154 This is vaguely similar to
156 except that it only applies to the first set of declarations
157 in a procedure (just after the first `{') and it causes a blank
158 line to be generated even if there are no declarations.
164 is specified, a blank line is forced after every procedure body.
170 is specified, a blank line is forced before every block comment.
176 is specified, then a newline is forced after each comma in a declaration.
178 turns off this option.
184 lines-up compound statements like this:
185 .Bd -literal -offset indent
194 (the default) makes them look like this:
195 .Bd -literal -offset indent
201 Whether a blank should always be inserted after sizeof.
205 The column in which comments on code start.
208 The column in which comments on declarations start.
210 is for these comments to start in the same column as those on code.
212 Enables (disables) the placement of comment delimiters on blank lines.
214 this option enabled, comments look like this:
215 .Bd -literal -offset indent
221 Rather than like this:
222 .Bd -literal -offset indent
223 /* this is a comment */
226 This only affects block comments, not comments to the right of
231 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
236 Sets the continuation indent to be
239 lines will be indented that far from the beginning of the first line of the
241 Parenthesized expressions have extra indentation added to
242 indicate the nesting, unless
245 or the continuation indent is exactly half of the main indent.
247 defaults to the same value as
250 Causes case labels to be indented
252 tab stops to the right of the containing
256 causes case labels to be indented half a tab stop.
261 Controls the placement of comments which are not to the
265 means that such comments are placed one indentation level to the
267 Specifying the default
269 lines-up these comments with the code.
270 See the section on comment
273 Specifies the indentation, in character positions,
274 of global variable names and all struct/union member names
275 relative to the beginning of their type declaration.
280 left justifies declarations.
282 indents declarations the same as code.
286 Enables (disables) special
293 will have the same indentation as the preceding
299 Enables (disables) extra indentation on continuation lines of
300 the expression part of
305 These continuation lines will be indented one extra level.
309 Enables (disables) splitting the function declaration and opening brace
314 Enables (disables) the formatting of comments that start in column 1.
315 Often, comments whose leading `/' is in column 1 have been carefully
316 hand formatted by the programmer.
324 Enables (disables) the formatting of block comments (ones that begin
326 Often, block comments have been not so carefully hand formatted by the
327 programmer, but reformatting that would just change the line breaks is not
332 Block comments are then handled like box comments.
336 The number of spaces for one indentation level.
339 Enables (disables) the indentation of parameter declarations from the left
344 Maximum length of an output line.
347 Maximum length of an output line in a block comment.
348 The default is 0, which means to limit block comment lines in accordance with
351 Specifies the indentation, in character positions,
352 of local variable names
353 relative to the beginning of their type declaration.
354 The default is for local variable names to be indented
355 by the same amount as global ones.
357 Lines-up code surrounded by parenthesis in continuation lines.
359 has a left paren which is not closed on that line, then continuation lines
360 will be lined up to start at the character position just after the left
362 For example, here is how a piece of continued code looks with
365 .Bd -literal -offset indent
366 p1 = first_procedure(second_procedure(p2, p3),
367 \ \ third_procedure(p4, p5));
372 in effect (the default) the code looks somewhat clearer:
373 .Bd -literal -offset indent
374 p1\ =\ first_procedure(second_procedure(p2,\ p3),
375 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
378 Inserting two more newlines we get:
379 .Bd -literal -offset indent
380 p1\ =\ first_procedure(second_procedure(p2,
381 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
382 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
383 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
386 Causes the profile files,
389 .Sq Pa ~/.indent.pro ,
397 all procedure calls will have a space inserted between
398 the name and the `('.
404 the names of procedures being defined are placed in
405 column 1 \- their types, if any, will be left on the previous lines.
410 Control whether parenthesized type names in casts are followed by a space or
415 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
422 is specified, indent will swallow optional blank lines.
424 get rid of blank lines after declarations.
430 to take its input from stdin and put its output to stdout.
432 Automatically add all identifiers ending in "_t" to the list
434 .It Fl T Ns Ar typename
437 to the list of type keywords.
440 can be specified more than once.
441 You need to specify all the typenames that
442 appear in your program that are defined by
445 harmed if you miss a few, but the program will not be formatted as nicely as
447 This sounds like a painful thing to have to do, but it is really
448 a symptom of a problem in C:
450 causes a syntactic change in the
459 to format the program for processing by
461 It will produce a fancy
462 listing in much the same spirit as
464 If the output file is not specified, the default is standard output,
465 rather than formatting in place.
467 Assumed distance between tab stops.
472 to the list of type keywords.
474 Enables (disables) the use of tab characters in the output.
479 turns on `verbose' mode;
482 When in verbose mode,
484 reports when it splits one line of input into two or more lines of output,
485 and gives some size statistics at completion.
490 You may set up your own `profile' of defaults to
492 by creating a file called
494 in your login directory and/or the current directory and including
495 whatever switches you like.
496 A `.indent.pro' in the current directory takes
497 precedence over the one in your login directory.
500 is run and a profile file exists, then it is read to set up the program's
502 Switches on the command line, though, always override profile
504 The switches should be separated by spaces, tabs or newlines.
512 assumes that any comment with a dash or star immediately after the start of
513 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
514 Each line of such a comment is left unchanged, except that its indentation
515 may be adjusted to account for the change in indentation of the first line
519 All other comments are treated as straight text.
522 utility fits as many words (separated by blanks, tabs, or newlines) on a
524 Blank lines break paragraphs.
525 .Ss Comment indentation
526 If a comment is on a line with code it is started in the `comment column',
529 command line parameter.
530 Otherwise, the comment is started at
532 indentation levels less than where code is currently being placed, where
536 command line parameter.
537 If the code on a line extends past the comment
538 column, the comment starts further to the right, and the right margin may be
539 automatically extended in extreme cases.
540 .Ss Preprocessor lines
543 leaves preprocessor lines alone.
545 reformatting that it will do is to straighten up trailing comments.
547 leaves embedded comments alone.
548 Conditional compilation
549 .Pq Ic #ifdef...#endif
552 attempts to correctly
553 compensate for the syntactic peculiarities introduced.
557 utility understands a substantial amount about the syntax of C, but it
558 has a `forgiving' parser.
559 It attempts to cope with the usual sorts of
560 incomplete and malformed syntax.
561 In particular, the use of macros like:
563 .Dl #define forever for(;;)
571 environment variable.
573 .Bl -tag -width "./.indent.pro" -compact
587 utility has even more switches than
590 A common mistake is to try to indent all the
592 programs in a directory by typing:
596 This is probably a bug, not a feature.
projects / FreeBSD / FreeBSD.git / blob