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
96 according to the switches.
97 The switches which can be
98 specified are described below.
99 They may appear before or after the file
103 If you only specify an
106 done `in-place', that is, the formatted file is written back into
110 is written in the current directory.
114 .Sq Pa /blah/blah/file ,
115 the backup file is named
117 by default. The extension used for the backup file may be overridden using the
118 .Ev SIMPLE_BACKUP_SUFFIX
119 environment variable.
125 checks to make sure that it is different from
128 The options listed below control the formatting style imposed by
134 is specified, a blank line is forced around every conditional
136 For example, in front of every #ifdef and after every #endif.
137 Other blank lines surrounding such blocks will be swallowed.
143 is specified, a blank line is forced after every block of
150 is specified, a blank line is forced after every procedure body.
156 is specified, a blank line is forced before every block comment.
162 is specified, then a newline is forced after each comma in a declaration.
164 turns off this option.
170 lines-up compound statements like this:
171 .Bd -literal -offset indent
180 (the default) makes them look like this:
181 .Bd -literal -offset indent
187 The column in which comments on code start.
190 The column in which comments on declarations start.
192 is for these comments to start in the same column as those on code.
194 Enables (disables) the placement of comment delimiters on blank lines.
196 this option enabled, comments look like this:
197 .Bd -literal -offset indent
203 Rather than like this:
204 .Bd -literal -offset indent
205 /* this is a comment */
208 This only affects block comments, not comments to the right of
213 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
218 Sets the continuation indent to be
221 lines will be indented that far from the beginning of the first line of the
223 Parenthesized expressions have extra indentation added to
224 indicate the nesting, unless
227 or the continuation indent is exactly half of the main indent.
229 defaults to the same value as
232 Causes case labels to be indented
234 tab stops to the right of the containing
238 causes case labels to be indented half a tab stop.
243 Controls the placement of comments which are not to the
247 means that such comments are placed one indentation level to the
249 Specifying the default
251 lines-up these comments with the code.
252 See the section on comment
255 Specifies the indentation, in character positions,
256 of global variable names and all struct/union member names
257 relative to the beginning of their type declaration.
262 left justifies declarations.
264 indents declarations the same as code.
268 Enables (disables) special
275 will have the same indentation as the preceding
281 Enables (disables) extra indentation on continuation lines of
282 the expression part of
287 These continuation lines will be indented one extra level.
291 Enables (disables) splitting the function declaration and opening brace
296 Enables (disables) the formatting of comments that start in column 1.
297 Often, comments whose leading `/' is in column 1 have been carefully
298 hand formatted by the programmer.
306 Enables (disables) the formatting of block comments (ones that begin
308 Often, block comments have been not so carefully hand formatted by the
309 programmer, but reformatting that would just change the line breaks is not
314 Block comments are then handled like box comments.
318 The number of spaces for one indentation level.
321 Enables (disables) the indentation of parameter declarations from the left
326 Maximum length of an output line.
329 Specifies the indentation, in character positions,
330 of local variable names
331 relative to the beginning of their type declaration.
332 The default is for local variable names to be indented
333 by the same amount as global ones.
335 Lines-up code surrounded by parenthesis in continuation lines.
337 has a left paren which is not closed on that line, then continuation lines
338 will be lined up to start at the character position just after the left
340 For example, here is how a piece of continued code looks with
343 .Bd -literal -offset indent
344 p1 = first_procedure(second_procedure(p2, p3),
345 \ \ third_procedure(p4, p5));
350 in effect (the default) the code looks somewhat clearer:
351 .Bd -literal -offset indent
352 p1\ =\ first_procedure(second_procedure(p2,\ p3),
353 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
356 Inserting two more newlines we get:
357 .Bd -literal -offset indent
358 p1\ =\ first_procedure(second_procedure(p2,
359 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
360 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
361 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
364 Causes the profile files,
367 .Sq Pa ~/.indent.pro ,
372 all procedure calls will have a space inserted between
373 the name and the `('.
379 the names of procedures being defined are placed in
380 column 1 \- their types, if any, will be left on the previous lines.
385 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
392 is specified, indent will swallow optional blank lines.
394 get rid of blank lines after declarations.
400 to take its input from stdin and put its output to stdout.
402 Automatically add all identifiers ending in "_t" to the list
404 .It Fl T Ns Ar typename
407 to the list of type keywords.
410 can be specified more than once.
411 You need to specify all the typenames that
412 appear in your program that are defined by
415 harmed if you miss a few, but the program will not be formatted as nicely as
417 This sounds like a painful thing to have to do, but it is really
418 a symptom of a problem in C:
420 causes a syntactic change in the
429 to format the program for processing by
431 It will produce a fancy
432 listing in much the same spirit as
434 If the output file is not specified, the default is standard output,
435 rather than formatting in place.
437 Enables (disables) the use of tab characters in the output.
438 Tabs are assumed to be aligned on columns divisible by 8.
443 turns on `verbose' mode;
446 When in verbose mode,
448 reports when it splits one line of input into two or more lines of output,
449 and gives some size statistics at completion.
454 You may set up your own `profile' of defaults to
456 by creating a file called
458 in your login directory and/or the current directory and including
459 whatever switches you like.
460 A `.indent.pro' in the current directory takes
461 precedence over the one in your login directory.
464 is run and a profile file exists, then it is read to set up the program's
466 Switches on the command line, though, always override profile
468 The switches should be separated by spaces, tabs or newlines.
476 assumes that any comment with a dash or star immediately after the start of
477 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
478 Each line of such a comment is left unchanged, except that its indentation
479 may be adjusted to account for the change in indentation of the first line
483 All other comments are treated as straight text.
486 utility fits as many words (separated by blanks, tabs, or newlines) on a
488 Blank lines break paragraphs.
489 .Ss Comment indentation
490 If a comment is on a line with code it is started in the `comment column',
493 command line parameter.
494 Otherwise, the comment is started at
496 indentation levels less than where code is currently being placed, where
500 command line parameter.
501 If the code on a line extends past the comment
502 column, the comment starts further to the right, and the right margin may be
503 automatically extended in extreme cases.
504 .Ss Preprocessor lines
507 leaves preprocessor lines alone.
509 reformatting that it will do is to straighten up trailing comments.
511 leaves embedded comments alone.
512 Conditional compilation
513 .Pq Ic #ifdef...#endif
516 attempts to correctly
517 compensate for the syntactic peculiarities introduced.
521 utility understands a substantial amount about the syntax of C, but it
522 has a `forgiving' parser.
523 It attempts to cope with the usual sorts of
524 incomplete and malformed syntax.
525 In particular, the use of macros like:
527 .Dl #define forever for(;;)
535 environment variable.
537 .Bl -tag -width "./.indent.pro" -compact
551 utility has even more switches than
554 A common mistake is to try to indent all the
556 programs in a directory by typing:
560 This is probably a bug, not a feature.
projects / FreeBSD / FreeBSD.git / blob