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
122 checks to make sure that it is different from
125 The options listed below control the formatting style imposed by
131 is specified, a blank line is forced around every conditional
133 For example, in front of every #ifdef and after every #endif.
134 Other blank lines surrounding such blocks will be swallowed.
140 is specified, a blank line is forced after every block of
147 is specified, a blank line is forced after every procedure body.
153 is specified, a blank line is forced before every block comment.
159 is specified, then a newline is forced after each comma in a declaration.
161 turns off this option.
167 lines-up compound statements like this:
168 .Bd -literal -offset indent
177 (the default) makes them look like this:
178 .Bd -literal -offset indent
184 The column in which comments on code start.
187 The column in which comments on declarations start.
189 is for these comments to start in the same column as those on code.
191 Enables (disables) the placement of comment delimiters on blank lines.
193 this option enabled, comments look like this:
194 .Bd -literal -offset indent
200 Rather than like this:
201 .Bd -literal -offset indent
202 /* this is a comment */
205 This only affects block comments, not comments to the right of
210 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
215 Sets the continuation indent to be
218 lines will be indented that far from the beginning of the first line of the
220 Parenthesized expressions have extra indentation added to
221 indicate the nesting, unless
224 or the continuation indent is exactly half of the main indent.
226 defaults to the same value as
229 Causes case labels to be indented
231 tab stops to the right of the containing
235 causes case labels to be indented half a tab stop.
240 Controls the placement of comments which are not to the
244 means that such comments are placed one indentation level to the
246 Specifying the default
248 lines-up these comments with the code.
249 See the section on comment
252 Specifies the indentation, in character positions,
253 of global variable names and all struct/union member names
254 relative to the beginning of their type declaration.
259 left justifies declarations.
261 indents declarations the same as code.
265 Enables (disables) special
272 will have the same indentation as the preceding
278 Enables (disables) extra indentation on continuation lines of
279 the expression part of
284 These continuation lines will be indented one extra level.
288 Enables (disables) splitting the function declaration and opening brace
293 Enables (disables) the formatting of comments that start in column 1.
294 Often, comments whose leading `/' is in column 1 have been carefully
295 hand formatted by the programmer.
303 Enables (disables) the formatting of block comments (ones that begin
305 Often, block comments have been not so carefully hand formatted by the
306 programmer, but reformatting that would just change the line breaks is not
311 Block comments are then handled like box comments.
315 The number of spaces for one indentation level.
318 Enables (disables) the indentation of parameter declarations from the left
323 Maximum length of an output line.
326 Specifies the indentation, in character positions,
327 of local variable names
328 relative to the beginning of their type declaration.
329 The default is for local variable names to be indented
330 by the same amount as global ones.
332 Lines-up code surrounded by parenthesis in continuation lines.
334 has a left paren which is not closed on that line, then continuation lines
335 will be lined up to start at the character position just after the left
337 For example, here is how a piece of continued code looks with
340 .Bd -literal -offset indent
341 p1 = first_procedure(second_procedure(p2, p3),
342 \ \ third_procedure(p4, p5));
347 in effect (the default) the code looks somewhat clearer:
348 .Bd -literal -offset indent
349 p1\ =\ first_procedure(second_procedure(p2,\ p3),
350 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
353 Inserting two more newlines we get:
354 .Bd -literal -offset indent
355 p1\ =\ first_procedure(second_procedure(p2,
356 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
357 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
358 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
361 Causes the profile files,
364 .Sq Pa ~/.indent.pro ,
369 all procedure calls will have a space inserted between
370 the name and the `('.
376 the names of procedures being defined are placed in
377 column 1 \- their types, if any, will be left on the previous lines.
382 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
389 is specified, indent will swallow optional blank lines.
391 get rid of blank lines after declarations.
397 to take its input from stdin and put its output to stdout.
399 Automatically add all identifiers ending in "_t" to the list
401 .It Fl T Ns Ar typename
404 to the list of type keywords.
407 can be specified more than once.
408 You need to specify all the typenames that
409 appear in your program that are defined by
412 harmed if you miss a few, but the program will not be formatted as nicely as
414 This sounds like a painful thing to have to do, but it is really
415 a symptom of a problem in C:
417 causes a syntactic change in the
426 to format the program for processing by
428 It will produce a fancy
429 listing in much the same spirit as
431 If the output file is not specified, the default is standard output,
432 rather than formatting in place.
434 Enables (disables) the use of tab characters in the output.
435 Tabs are assumed to be aligned on columns divisible by 8.
440 turns on `verbose' mode;
443 When in verbose mode,
445 reports when it splits one line of input into two or more lines of output,
446 and gives some size statistics at completion.
451 You may set up your own `profile' of defaults to
453 by creating a file called
455 in your login directory and/or the current directory and including
456 whatever switches you like.
457 A `.indent.pro' in the current directory takes
458 precedence over the one in your login directory.
461 is run and a profile file exists, then it is read to set up the program's
463 Switches on the command line, though, always override profile
465 The switches should be separated by spaces, tabs or newlines.
473 assumes that any comment with a dash or star immediately after the start of
474 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
475 Each line of such a comment is left unchanged, except that its indentation
476 may be adjusted to account for the change in indentation of the first line
480 All other comments are treated as straight text.
483 utility fits as many words (separated by blanks, tabs, or newlines) on a
485 Blank lines break paragraphs.
486 .Ss Comment indentation
487 If a comment is on a line with code it is started in the `comment column',
490 command line parameter.
491 Otherwise, the comment is started at
493 indentation levels less than where code is currently being placed, where
497 command line parameter.
498 If the code on a line extends past the comment
499 column, the comment starts further to the right, and the right margin may be
500 automatically extended in extreme cases.
501 .Ss Preprocessor lines
504 leaves preprocessor lines alone.
506 reformatting that it will do is to straighten up trailing comments.
508 leaves embedded comments alone.
509 Conditional compilation
510 .Pq Ic #ifdef...#endif
513 attempts to correctly
514 compensate for the syntactic peculiarities introduced.
518 utility understands a substantial amount about the syntax of C, but it
519 has a `forgiving' parser.
520 It attempts to cope with the usual sorts of
521 incomplete and misformed syntax.
522 In particular, the use of macros like:
524 .Dl #define forever for(;;)
532 environment variable.
534 .Bl -tag -width "./.indent.pro" -compact
548 utility has even more switches than
551 A common mistake is to try to indent all the
553 programs in a directory by typing:
557 This is probably a bug, not a feature.
projects / FreeBSD / FreeBSD.git / blob