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. All advertising materials mentioning features or use of this software
15 .\" must display the following acknowledgement:
16 .\" This product includes software developed by the University of
17 .\" California, Berkeley and its contributors.
18 .\" 4. Neither the name of the University nor the names of its contributors
19 .\" may be used to endorse or promote products derived from this software
20 .\" without specific prior written permission.
22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" @(#)indent.1 8.1 (Berkeley) 7/1/93
42 .Nd indent and format C program source
45 .Op Ar input-file Op Ar output-file
97 according to the switches.
98 The switches which can be
99 specified are described below.
100 They may appear before or after the file
104 If you only specify an
107 done `in-place', that is, the formatted file is written back into
111 is written in the current directory.
115 .Sq Pa /blah/blah/file ,
116 the backup file is named
123 checks to make sure that it is different from
126 The options listed below control the formatting style imposed by
132 is specified, a blank line is forced after every block of
139 is specified, a blank line is forced after every procedure body.
145 is specified, a blank line is forced before every block comment.
151 is specified, then a newline is forced after each comma in a declaration.
153 turns off this option.
159 lines-up compound statements like this:
160 .Bd -literal -offset indent
169 (the default) makes them look like this:
170 .Bd -literal -offset indent
177 The column in which comments on code start.
180 The column in which comments on declarations start.
182 is for these comments to start in the same column as those on code.
184 Enables (disables) the placement of comment delimiters on blank lines.
186 this option enabled, comments look like this:
187 .Bd -literal -offset indent
193 Rather than like this:
194 .Bd -literal -offset indent
195 /* this is a comment */
198 This only affects block comments, not comments to the right of
203 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
208 Sets the continuation indent to be
211 lines will be indented that far from the beginning of the first line of the
213 Parenthesized expressions have extra indentation added to
214 indicate the nesting, unless
217 or the continuation indent is exactly half of the main indent.
219 defaults to the same value as
222 Causes case labels to be indented
224 tab stops to the right of the containing
228 causes case labels to be indented half a tab stop.
233 Controls the placement of comments which are not to the
237 means that such comments are placed one indentation level to the
239 Specifying the default
241 lines-up these comments with the code.
242 See the section on comment
245 Specifies the indentation, in character positions,
246 of global variable names and all struct/union member names
247 relative to the beginning of their type declaration.
252 left justifies declarations.
254 indents declarations the same as code.
258 Enables (disables) special
265 will have the same indentation as the preceding
271 Enables (disables) splitting the function declaration and opening brace
276 Enables (disables) the formatting of comments that start in column 1.
277 Often, comments whose leading `/' is in column 1 have been carefully
278 hand formatted by the programmer.
286 Enables (disables) the formatting of block comments (ones that begin
288 Often, block comments have been not so carefully hand formatted by the
289 programmer, but reformatting that would just change the line breaks is not
294 Block comments are then handled like box comments.
298 The number of spaces for one indentation level.
301 Enables (disables) the indentation of parameter declarations from the left
306 Maximum length of an output line.
309 Specifies the indentation, in character positions,
310 of local variable names
311 relative to the beginning of their type declaration.
312 The default is for local variable names to be indented
313 by the same amount as global ones.
315 Lines-up code surrounded by parenthesis in continuation lines.
317 has a left paren which is not closed on that line, then continuation lines
318 will be lined up to start at the character position just after the left
320 For example, here is how a piece of continued code looks with
323 .Bd -literal -offset indent
324 p1 = first_procedure(second_procedure(p2, p3),
325 \ \ third_procedure(p4, p5));
330 in effect (the default) the code looks somewhat clearer:
331 .Bd -literal -offset indent
332 p1\ =\ first_procedure(second_procedure(p2,\ p3),
333 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
336 Inserting two more newlines we get:
337 .Bd -literal -offset indent
338 p1\ =\ first_procedure(second_procedure(p2,
339 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
340 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
341 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
344 Causes the profile files,
347 .Sq Pa ~/.indent.pro ,
352 all procedure calls will have a space inserted between
353 the name and the `('.
359 the names of procedures being defined are placed in
360 column 1 \- their types, if any, will be left on the previous lines.
365 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
372 is specified, indent will swallow optional blank lines.
374 get rid of blank lines after declarations.
380 to take its input from stdin and put its output to stdout.
382 Automatically add all identifiers ending in "_t" to the list
384 .It Fl T Ns Ar typename
387 to the list of type keywords.
390 can be specified more than once.
391 You need to specify all the typenames that
392 appear in your program that are defined by
395 harmed if you miss a few, but the program will not be formatted as nicely as
397 This sounds like a painful thing to have to do, but it is really
398 a symptom of a problem in C:
400 causes a syntactic change in the
409 to format the program for processing by
411 It will produce a fancy
412 listing in much the same spirit as
414 If the output file is not specified, the default is standard output,
415 rather than formatting in place.
417 Enables (disables) the use of tab characters in the output.
418 Tabs are assumed to be aligned on columns divisible by 8.
423 turns on `verbose' mode;
426 When in verbose mode,
428 reports when it splits one line of input into two or more lines of output,
429 and gives some size statistics at completion.
434 You may set up your own `profile' of defaults to
436 by creating a file called
438 in your login directory and/or the current directory and including
439 whatever switches you like.
440 A `.indent.pro' in the current directory takes
441 precedence over the one in your login directory.
444 is run and a profile file exists, then it is read to set up the program's
446 Switches on the command line, though, always override profile
448 The switches should be separated by spaces, tabs or newlines.
456 assumes that any comment with a dash or star immediately after the start of
457 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
458 Each line of such a comment is left unchanged, except that its indentation
459 may be adjusted to account for the change in indentation of the first line
463 All other comments are treated as straight text.
466 utility fits as many words (separated by blanks, tabs, or newlines) on a
468 Blank lines break paragraphs.
470 .Ss Comment indentation
471 If a comment is on a line with code it is started in the `comment column',
474 command line parameter.
475 Otherwise, the comment is started at
477 indentation levels less than where code is currently being placed, where
481 command line parameter.
482 If the code on a line extends past the comment
483 column, the comment starts further to the right, and the right margin may be
484 automatically extended in extreme cases.
486 .Ss Preprocessor lines
489 leaves preprocessor lines alone.
491 reformatting that it will do is to straighten up trailing comments.
493 leaves embedded comments alone.
494 Conditional compilation
495 .Pq Ic #ifdef...#endif
498 attempts to correctly
499 compensate for the syntactic peculiarities introduced.
504 utility understands a substantial amount about the syntax of C, but it
505 has a `forgiving' parser.
506 It attempts to cope with the usual sorts of
507 incomplete and misformed syntax.
508 In particular, the use of macros like:
510 .Dl #define forever for(;;)
518 environment variable.
520 .Bl -tag -width "./.indent.pro" -compact
534 utility has even more switches than
537 A common mistake is to try to indent all the
539 programs in a directory by typing:
543 This is probably a bug, not a feature.