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
87 program formatter. It reformats the
91 according to the switches. The switches which can be
92 specified are described below. They may appear before or after the file
96 If you only specify an
99 done `in-place', that is, the formatted file is written back into
103 is written in the current directory. If
106 .Sq Pa /blah/blah/file ,
107 the backup file is named
114 checks to make sure it is different from
117 The options listed below control the formatting style imposed by
123 is specified, a blank line is forced after every block of
124 declarations. Default:
129 is specified, a blank line is forced after every procedure body. Default:
134 is specified, a blank line is forced before every block comment. Default:
139 is specified, then a newline is forced after each comma in a declaration.
141 turns off this option. Default:
146 lines-up compound statements like this:
147 .Bd -literal -offset indent
156 (the default) makes them look like this:
157 .Bd -literal -offset indent
164 The column in which comments on code start. The default is 33.
166 The column in which comments on declarations start. The default
167 is for these comments to start in the same column as those on code.
169 Enables (disables) the placement of comment delimiters on blank lines. With
170 this option enabled, comments look like this:
171 .Bd -literal -offset indent
177 Rather than like this:
178 .Bd -literal -offset indent
179 /* this is a comment */
182 This only affects block comments, not comments to the right of
186 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
190 Sets the continuation indent to be
193 lines will be indented that far from the beginning of the first line of the
194 statement. Parenthesized expressions have extra indentation added to
195 indicate the nesting, unless
199 defaults to the same value as
202 Causes case labels to be indented
204 tab stops to the right of the containing
208 causes case labels to be indented half a tab stop. The
212 Controls the placement of comments which are not to the
213 right of code. For example,
215 means that such comments are placed one indentation level to the
216 left of code. Specifying the default
218 lines-up these comments with the code. See the section on comment
221 Specifies the indentation, in character positions, from a declaration keyword
222 to the following identifier. The default is
226 left justifies declarations.
228 indents declarations the same as code. The default is
231 Enables (disables) special
233 processing. If it's enabled, an
237 will have the same indentation as the preceding
239 statement. The default is
242 Enables (disables) the formatting of comments that start in column 1.
243 Often, comments whose leading `/' is in column 1 have been carefully
244 hand formatted by the programmer. In such cases,
250 Enables (disables) the formatting of block comments (ones that begin
252 Often, block comments have been not so carefully hand formatted by the
253 programmer, but reformatting that would just change the line breaks is not
258 Block comments are then handled like box comments.
262 The number of spaces for one indentation level. The default is 8.
264 Enables (disables) the indentation of parameter declarations from the left
265 margin. The default is
268 Maximum length of an output line. The default is 78.
270 Lines-up code surrounded by parenthesis in continuation lines. If a line
271 has a left paren which is not closed on that line, then continuation lines
272 will be lined up to start at the character position just after the left
273 paren. For example, here is how a piece of continued code looks with
276 .Bd -literal -offset indent
277 p1 = first_procedure(second_procedure(p2, p3),
278 \ \ third_procedure(p4, p5));
283 in effect (the default) the code looks somewhat clearer:
284 .Bd -literal -offset indent
285 p1\ =\ first_procedure(second_procedure(p2,\ p3),
286 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
289 Inserting two more newlines we get:
290 .Bd -literal -offset indent
291 p1\ =\ first_procedure(second_procedure(p2,
292 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
293 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
294 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
297 Causes the profile files,
300 .Sq Pa ~/.indent.pro ,
305 all procedure calls will have a space inserted between
306 the name and the `('. The default is
311 the names of procedures being defined are placed in
312 column 1 \- their types, if any, will be left on the previous lines. The
316 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
317 comments. The default is
322 is specified, indent will swallow optional blank lines. You can use this to
323 get rid of blank lines after declarations. Default:
328 to take its input from stdin and put its output to stdout.
329 .It Fl T Ns Ar typename
332 to the list of type keywords. Names accumulate:
334 can be specified more than once. You need to specify all the typenames that
335 appear in your program that are defined by
338 harmed if you miss a few, but the program won't be formatted as nicely as
339 it should. This sounds like a painful thing to have to do, but it's really
340 a symptom of a problem in C:
342 causes a syntactic change in the
351 to format the program for processing by
353 It will produce a fancy
354 listing in much the same spirit as
356 If the output file is not specified, the default is standard output,
357 rather than formatting in place.
360 turns on `verbose' mode;
362 turns it off. When in verbose mode,
364 reports when it splits one line of input into two or more lines of output,
365 and gives some size statistics at completion. The default is
369 You may set up your own `profile' of defaults to
371 by creating a file called
373 in your login directory and/or the current directory and including
374 whatever switches you like. A `.indent.pro' in the current directory takes
375 precedence over the one in your login directory. If
377 is run and a profile file exists, then it is read to set up the program's
378 defaults. Switches on the command line, though, always override profile
379 switches. The switches should be separated by spaces, tabs or newlines.
385 assumes that any comment with a dash or star immediately after the start of
386 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
387 Each line of such a comment is left unchanged, except that its indentation
388 may be adjusted to account for the change in indentation of the first line
392 All other comments are treated as straight text.
394 fits as many words (separated by blanks, tabs, or newlines) on a
395 line as possible. Blank lines break paragraphs.
397 .Ss Comment indentation
398 If a comment is on a line with code it is started in the `comment column',
401 command line parameter. Otherwise, the comment is started at
403 indentation levels less than where code is currently being placed, where
407 command line parameter. If the code on a line extends past the comment
408 column, the comment starts further to the right, and the right margin may be
409 automatically extended in extreme cases.
411 .Ss Preprocessor lines
414 leaves preprocessor lines alone. The only
415 reformatting that it will do is to straighten up trailing comments. It
416 leaves embedded comments alone. Conditional compilation
417 .Pq Ic #ifdef...#endif
420 attempts to correctly
421 compensate for the syntactic peculiarities introduced.
425 understands a substantial amount about the syntax of C, but it
426 has a `forgiving' parser. It attempts to cope with the usual sorts of
427 incomplete and misformed syntax. In particular, the use of macros like:
429 .Dl #define forever for(;;)
436 environment variable.
438 .Bl -tag -width "./.indent.pro" -compact
451 has even more switches than
454 A common mistake that often causes grief is typing:
458 to the shell in an attempt to indent all the
459 C programs in a directory.
460 This is probably a bug, not a feature.