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
77 .Op Fl \&lpl | Fl nlpl
88 .Op Fl T Ns Ar typename
104 according to the switches.
105 The switches which can be
106 specified are described below.
107 They may appear before or after the file
111 If you only specify an
114 done `in-place', that is, the formatted file is written back into
118 is written in the current directory.
122 .Sq Pa /blah/blah/file ,
123 the backup file is named
126 The extension used for the backup file may be overridden using the
127 .Ev SIMPLE_BACKUP_SUFFIX
128 environment variable.
134 checks to make sure that it is different from
137 The options listed below control the formatting style imposed by
143 is specified, a blank line is forced around every conditional
145 For example, in front of every #ifdef and after every #endif.
146 Other blank lines surrounding such blocks will be swallowed.
152 is specified, a blank line is forced after every block of
157 This is vaguely similar to
159 except that it only applies to the first set of declarations
160 in a procedure (just after the first `{') and it causes a blank
161 line to be generated even if there are no declarations.
167 is specified, a blank line is forced after every procedure body.
173 is specified, a blank line is forced before every block comment.
179 is specified, then a newline is forced after each comma in a declaration.
181 turns off this option.
187 lines up compound statements like this:
188 .Bd -literal -offset indent
197 (the default) makes them look like this:
198 .Bd -literal -offset indent
204 Whether a blank should always be inserted after sizeof.
208 The column in which comments on code start.
211 The column in which comments on declarations start.
213 is for these comments to start in the same column as those on code.
215 Enables (disables) the placement of comment delimiters on blank lines.
217 this option enabled, comments look like this:
218 .Bd -literal -offset indent
224 Rather than like this:
225 .Bd -literal -offset indent
226 /* this is a comment */
229 This only affects block comments, not comments to the right of
234 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
239 Sets the continuation indent to be
242 lines will be indented that far from the beginning of the first line of the
244 Parenthesized expressions have extra indentation added to
245 indicate the nesting, unless
248 or the continuation indent is exactly half of the main indent.
250 defaults to the same value as
253 Causes case labels to be indented
255 tab stops to the right of the containing
259 causes case labels to be indented half a tab stop.
264 Control whether parenthesized type names in casts are followed by a space or
269 Controls the placement of comments which are not to the
273 means that such comments are placed one indentation level to the
275 Specifying the default
277 lines up these comments with the code.
278 See the section on comment
281 Specifies the indentation, in character positions,
282 of global variable names and all struct/union member names
283 relative to the beginning of their type declaration.
288 left justifies declarations.
290 indents declarations the same as code.
294 Enables (disables) special
301 will have the same indentation as the preceding
307 Enables (disables) extra indentation on continuation lines of
308 the expression part of
313 These continuation lines will be indented one extra level.
317 Enables (disables) splitting the function declaration and opening brace
322 Enables (disables) the formatting of comments that start in column 1.
323 Often, comments whose leading `/' is in column 1 have been carefully
324 hand formatted by the programmer.
332 Enables (disables) the formatting of block comments (ones that begin
334 Often, block comments have been not so carefully hand formatted by the
335 programmer, but reformatting that would just change the line breaks is not
340 Block comments are then handled like box comments.
344 The number of columns for one indentation level.
347 Enables (disables) the indentation of parameter declarations from the left
352 Maximum length of an output line.
355 Maximum length of an output line in a block comment.
356 The default is 0, which means to limit block comment lines in accordance with
359 Specifies the indentation, in character positions,
360 of local variable names
361 relative to the beginning of their type declaration.
362 The default is for local variable names to be indented
363 by the same amount as global ones.
365 Lines up code surrounded by parentheses in continuation lines.
369 has a left paren which is not closed on that line, then continuation lines
370 will be lined up to start at the character position just after the left
372 For example, here is how a piece of continued code looks with
375 .Bd -literal -offset indent
376 p1 = first_procedure(second_procedure(p2, p3),
377 \ \ third_procedure(p4, p5));
382 in effect (the default) the code looks somewhat clearer:
383 .Bd -literal -offset indent
384 p1\ =\ first_procedure(second_procedure(p2,\ p3),
385 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
388 Inserting two more newlines we get:
389 .Bd -literal -offset indent
390 p1\ =\ first_procedure(second_procedure(p2,
391 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
392 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
393 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
398 code surrounded by parentheses in continuation lines is lined up even if it
399 would extend past the right margin.
402 (the default), such a line that would extend past the right margin is moved
403 left to keep it within the margin, if that does not require placing it to
404 the left of the prevailing indentation level.
405 These switches have no effect if
409 Causes the profile files,
412 .Sq Pa ~/.indent.pro ,
420 all procedure calls will have a space inserted between
421 the name and the `('.
427 the names of procedures being defined are placed in
428 column 1 \- their types, if any, will be left on the previous lines.
433 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
440 is specified, indent will swallow optional blank lines.
442 get rid of blank lines after declarations.
448 to take its input from stdin and put its output to stdout.
450 Automatically add all identifiers ending in "_t" to the list
452 .It Fl T Ns Ar typename
455 to the list of type keywords.
458 can be specified more than once.
459 You need to specify all the typenames that
460 appear in your program that are defined by
463 harmed if you miss a few, but the program will not be formatted as nicely as
465 This sounds like a painful thing to have to do, but it is really
466 a symptom of a problem in C:
468 causes a syntactic change in the
475 Assumed distance between tab stops.
480 to the list of type keywords.
482 Enables (disables) the use of tab characters in the output.
487 turns on `verbose' mode;
490 When in verbose mode,
492 reports when it splits one line of input into two or more lines of output,
493 and gives some size statistics at completion.
499 to print its version number and exit.
502 You may set up your own `profile' of defaults to
504 by creating a file called
506 in your login directory and/or the current directory and including
507 whatever switches you like.
508 A `.indent.pro' in the current directory takes
509 precedence over the one in your login directory.
512 is run and a profile file exists, then it is read to set up the program's
514 Switches on the command line, though, always override profile
516 The switches should be separated by spaces, tabs or newlines.
524 assumes that any comment with a dash or star immediately after the start of
525 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
526 Each line of such a comment is left unchanged, except that its indentation
527 may be adjusted to account for the change in indentation of the first line
531 All other comments are treated as straight text.
534 utility fits as many words (separated by blanks, tabs, or newlines) on a
536 Blank lines break paragraphs.
537 .Ss Comment indentation
538 If a comment is on a line with code it is started in the `comment column',
541 command line parameter.
542 Otherwise, the comment is started at
544 indentation levels less than where code is currently being placed, where
548 command line parameter.
549 If the code on a line extends past the comment
550 column, the comment starts further to the right, and the right margin may be
551 automatically extended in extreme cases.
552 .Ss Preprocessor lines
555 leaves preprocessor lines alone.
557 reformatting that it will do is to straighten up trailing comments.
559 leaves embedded comments alone.
560 Conditional compilation
561 .Pq Ic #ifdef...#endif
564 attempts to correctly
565 compensate for the syntactic peculiarities introduced.
569 utility understands a substantial amount about the syntax of C, but it
570 has a `forgiving' parser.
571 It attempts to cope with the usual sorts of
572 incomplete and malformed syntax.
573 In particular, the use of macros like:
575 .Dl #define forever for(;;)
583 environment variable.
585 .Bl -tag -width "./.indent.pro" -compact
599 utility has even more switches than
602 A common mistake is to try to indent all the
604 programs in a directory by typing:
608 This is probably a bug, not a feature.
projects / FreeBSD / FreeBSD.git / blob