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
101 according to the switches.
102 The switches which can be
103 specified are described below.
104 They may appear before or after the file
108 If you only specify an
111 done `in-place', that is, the formatted file is written back into
115 is written in the current directory.
119 .Sq Pa /blah/blah/file ,
120 the backup file is named
127 checks to make sure that it is different from
130 The options listed below control the formatting style imposed by
136 is specified, a blank line is forced around every conditional
138 For example, in front of every #ifdef and after every #endif.
139 Other blank lines surrounding such blocks will be swallowed.
145 is specified, a blank line is forced after every block of
150 This is vaguely similar to
152 except that it only applies to the first set of declarations
153 in a procedure (just after the first `{') and it causes a blank
154 line to be generated even if there are no declarations.
160 is specified, a blank line is forced after every procedure body.
166 is specified, a blank line is forced before every block comment.
172 is specified, then a newline is forced after each comma in a declaration.
174 turns off this option.
180 lines-up compound statements like this:
181 .Bd -literal -offset indent
190 (the default) makes them look like this:
191 .Bd -literal -offset indent
197 Whether a blank should always be inserted after sizeof.
201 The column in which comments on code start.
204 The column in which comments on declarations start.
206 is for these comments to start in the same column as those on code.
208 Enables (disables) the placement of comment delimiters on blank lines.
210 this option enabled, comments look like this:
211 .Bd -literal -offset indent
217 Rather than like this:
218 .Bd -literal -offset indent
219 /* this is a comment */
222 This only affects block comments, not comments to the right of
227 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
232 Sets the continuation indent to be
235 lines will be indented that far from the beginning of the first line of the
237 Parenthesized expressions have extra indentation added to
238 indicate the nesting, unless
241 or the continuation indent is exactly half of the main indent.
243 defaults to the same value as
246 Causes case labels to be indented
248 tab stops to the right of the containing
252 causes case labels to be indented half a tab stop.
257 Controls the placement of comments which are not to the
261 means that such comments are placed one indentation level to the
263 Specifying the default
265 lines-up these comments with the code.
266 See the section on comment
269 Specifies the indentation, in character positions,
270 of global variable names and all struct/union member names
271 relative to the beginning of their type declaration.
276 left justifies declarations.
278 indents declarations the same as code.
282 Enables (disables) special
289 will have the same indentation as the preceding
295 Enables (disables) extra indentation on continuation lines of
296 the expression part of
301 These continuation lines will be indented one extra level.
305 Enables (disables) splitting the function declaration and opening brace
310 Enables (disables) the formatting of comments that start in column 1.
311 Often, comments whose leading `/' is in column 1 have been carefully
312 hand formatted by the programmer.
320 Enables (disables) the formatting of block comments (ones that begin
322 Often, block comments have been not so carefully hand formatted by the
323 programmer, but reformatting that would just change the line breaks is not
328 Block comments are then handled like box comments.
332 The number of spaces for one indentation level.
335 Enables (disables) the indentation of parameter declarations from the left
340 Maximum length of an output line.
343 Maximum length of an output line in a block comment.
344 The default is 0, which means to limit block comment lines in accordance with
347 Specifies the indentation, in character positions,
348 of local variable names
349 relative to the beginning of their type declaration.
350 The default is for local variable names to be indented
351 by the same amount as global ones.
353 Lines-up code surrounded by parenthesis in continuation lines.
355 has a left paren which is not closed on that line, then continuation lines
356 will be lined up to start at the character position just after the left
358 For example, here is how a piece of continued code looks with
361 .Bd -literal -offset indent
362 p1 = first_procedure(second_procedure(p2, p3),
363 \ \ third_procedure(p4, p5));
368 in effect (the default) the code looks somewhat clearer:
369 .Bd -literal -offset indent
370 p1\ =\ first_procedure(second_procedure(p2,\ p3),
371 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
374 Inserting two more newlines we get:
375 .Bd -literal -offset indent
376 p1\ =\ first_procedure(second_procedure(p2,
377 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
378 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
379 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
382 Causes the profile files,
385 .Sq Pa ~/.indent.pro ,
393 all procedure calls will have a space inserted between
394 the name and the `('.
400 the names of procedures being defined are placed in
401 column 1 \- their types, if any, will be left on the previous lines.
406 Control whether parenthesized type names in casts are followed by a space or
411 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
418 is specified, indent will swallow optional blank lines.
420 get rid of blank lines after declarations.
426 to take its input from stdin and put its output to stdout.
428 Automatically add all identifiers ending in "_t" to the list
430 .It Fl T Ns Ar typename
433 to the list of type keywords.
436 can be specified more than once.
437 You need to specify all the typenames that
438 appear in your program that are defined by
441 harmed if you miss a few, but the program will not be formatted as nicely as
443 This sounds like a painful thing to have to do, but it is really
444 a symptom of a problem in C:
446 causes a syntactic change in the
455 to format the program for processing by
457 It will produce a fancy
458 listing in much the same spirit as
460 If the output file is not specified, the default is standard output,
461 rather than formatting in place.
465 to the list of type keywords.
467 Enables (disables) the use of tab characters in the output.
468 Tabs are assumed to be aligned on columns divisible by 8.
473 turns on `verbose' mode;
476 When in verbose mode,
478 reports when it splits one line of input into two or more lines of output,
479 and gives some size statistics at completion.
484 You may set up your own `profile' of defaults to
486 by creating a file called
488 in your login directory and/or the current directory and including
489 whatever switches you like.
490 A `.indent.pro' in the current directory takes
491 precedence over the one in your login directory.
494 is run and a profile file exists, then it is read to set up the program's
496 Switches on the command line, though, always override profile
498 The switches should be separated by spaces, tabs or newlines.
506 assumes that any comment with a dash or star immediately after the start of
507 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
508 Each line of such a comment is left unchanged, except that its indentation
509 may be adjusted to account for the change in indentation of the first line
513 All other comments are treated as straight text.
516 utility fits as many words (separated by blanks, tabs, or newlines) on a
518 Blank lines break paragraphs.
519 .Ss Comment indentation
520 If a comment is on a line with code it is started in the `comment column',
523 command line parameter.
524 Otherwise, the comment is started at
526 indentation levels less than where code is currently being placed, where
530 command line parameter.
531 If the code on a line extends past the comment
532 column, the comment starts further to the right, and the right margin may be
533 automatically extended in extreme cases.
534 .Ss Preprocessor lines
537 leaves preprocessor lines alone.
539 reformatting that it will do is to straighten up trailing comments.
541 leaves embedded comments alone.
542 Conditional compilation
543 .Pq Ic #ifdef...#endif
546 attempts to correctly
547 compensate for the syntactic peculiarities introduced.
551 utility understands a substantial amount about the syntax of C, but it
552 has a `forgiving' parser.
553 It attempts to cope with the usual sorts of
554 incomplete and malformed syntax.
555 In particular, the use of macros like:
557 .Dl #define forever for(;;)
565 environment variable.
567 .Bl -tag -width "./.indent.pro" -compact
581 utility has even more switches than
584 A common mistake is to try to indent all the
586 programs in a directory by typing:
590 This is probably a bug, not a feature.
projects / FreeBSD / FreeBSD.git / blob