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
46 .Op Fl bacc | Fl nbacc
100 according to the switches.
101 The switches which can be
102 specified are described below.
103 They may appear before or after the file
107 If you only specify an
110 done `in-place', that is, the formatted file is written back into
114 is written in the current directory.
118 .Sq Pa /blah/blah/file ,
119 the backup file is named
126 checks to make sure that it is different from
129 The options listed below control the formatting style imposed by
135 is specified, a blank line is forced around every conditional
137 For example, in front of every #ifdef and after every #endif.
138 Other blank lines surrounding such blocks will be swallowed.
144 is specified, a blank line is forced after every block of
151 is specified, a blank line is forced after every procedure body.
157 is specified, a blank line is forced before every block comment.
163 is specified, then a newline is forced after each comma in a declaration.
165 turns off this option.
171 lines-up compound statements like this:
172 .Bd -literal -offset indent
181 (the default) makes them look like this:
182 .Bd -literal -offset indent
189 The column in which comments on code start.
192 The column in which comments on declarations start.
194 is for these comments to start in the same column as those on code.
196 Enables (disables) the placement of comment delimiters on blank lines.
198 this option enabled, comments look like this:
199 .Bd -literal -offset indent
205 Rather than like this:
206 .Bd -literal -offset indent
207 /* this is a comment */
210 This only affects block comments, not comments to the right of
215 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
220 Sets the continuation indent to be
223 lines will be indented that far from the beginning of the first line of the
225 Parenthesized expressions have extra indentation added to
226 indicate the nesting, unless
229 or the continuation indent is exactly half of the main indent.
231 defaults to the same value as
234 Causes case labels to be indented
236 tab stops to the right of the containing
240 causes case labels to be indented half a tab stop.
245 Controls the placement of comments which are not to the
249 means that such comments are placed one indentation level to the
251 Specifying the default
253 lines-up these comments with the code.
254 See the section on comment
257 Specifies the indentation, in character positions,
258 of global variable names and all struct/union member names
259 relative to the beginning of their type declaration.
264 left justifies declarations.
266 indents declarations the same as code.
270 Enables (disables) special
277 will have the same indentation as the preceding
283 Enables (disables) extra indentation on continuation lines of
284 the expression part of
289 These continuation lines will be indented one extra level.
293 Enables (disables) splitting the function declaration and opening brace
298 Enables (disables) the formatting of comments that start in column 1.
299 Often, comments whose leading `/' is in column 1 have been carefully
300 hand formatted by the programmer.
308 Enables (disables) the formatting of block comments (ones that begin
310 Often, block comments have been not so carefully hand formatted by the
311 programmer, but reformatting that would just change the line breaks is not
316 Block comments are then handled like box comments.
320 The number of spaces for one indentation level.
323 Enables (disables) the indentation of parameter declarations from the left
328 Maximum length of an output line.
331 Specifies the indentation, in character positions,
332 of local variable names
333 relative to the beginning of their type declaration.
334 The default is for local variable names to be indented
335 by the same amount as global ones.
337 Lines-up code surrounded by parenthesis in continuation lines.
339 has a left paren which is not closed on that line, then continuation lines
340 will be lined up to start at the character position just after the left
342 For example, here is how a piece of continued code looks with
345 .Bd -literal -offset indent
346 p1 = first_procedure(second_procedure(p2, p3),
347 \ \ third_procedure(p4, p5));
352 in effect (the default) the code looks somewhat clearer:
353 .Bd -literal -offset indent
354 p1\ =\ first_procedure(second_procedure(p2,\ p3),
355 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
358 Inserting two more newlines we get:
359 .Bd -literal -offset indent
360 p1\ =\ first_procedure(second_procedure(p2,
361 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
362 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
363 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
366 Causes the profile files,
369 .Sq Pa ~/.indent.pro ,
374 all procedure calls will have a space inserted between
375 the name and the `('.
381 the names of procedures being defined are placed in
382 column 1 \- their types, if any, will be left on the previous lines.
387 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
394 is specified, indent will swallow optional blank lines.
396 get rid of blank lines after declarations.
402 to take its input from stdin and put its output to stdout.
404 Automatically add all identifiers ending in "_t" to the list
406 .It Fl T Ns Ar typename
409 to the list of type keywords.
412 can be specified more than once.
413 You need to specify all the typenames that
414 appear in your program that are defined by
417 harmed if you miss a few, but the program will not be formatted as nicely as
419 This sounds like a painful thing to have to do, but it is really
420 a symptom of a problem in C:
422 causes a syntactic change in the
431 to format the program for processing by
433 It will produce a fancy
434 listing in much the same spirit as
436 If the output file is not specified, the default is standard output,
437 rather than formatting in place.
439 Enables (disables) the use of tab characters in the output.
440 Tabs are assumed to be aligned on columns divisible by 8.
445 turns on `verbose' mode;
448 When in verbose mode,
450 reports when it splits one line of input into two or more lines of output,
451 and gives some size statistics at completion.
456 You may set up your own `profile' of defaults to
458 by creating a file called
460 in your login directory and/or the current directory and including
461 whatever switches you like.
462 A `.indent.pro' in the current directory takes
463 precedence over the one in your login directory.
466 is run and a profile file exists, then it is read to set up the program's
468 Switches on the command line, though, always override profile
470 The switches should be separated by spaces, tabs or newlines.
478 assumes that any comment with a dash or star immediately after the start of
479 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
480 Each line of such a comment is left unchanged, except that its indentation
481 may be adjusted to account for the change in indentation of the first line
485 All other comments are treated as straight text.
488 utility fits as many words (separated by blanks, tabs, or newlines) on a
490 Blank lines break paragraphs.
491 .Ss Comment indentation
492 If a comment is on a line with code it is started in the `comment column',
495 command line parameter.
496 Otherwise, the comment is started at
498 indentation levels less than where code is currently being placed, where
502 command line parameter.
503 If the code on a line extends past the comment
504 column, the comment starts further to the right, and the right margin may be
505 automatically extended in extreme cases.
506 .Ss Preprocessor lines
509 leaves preprocessor lines alone.
511 reformatting that it will do is to straighten up trailing comments.
513 leaves embedded comments alone.
514 Conditional compilation
515 .Pq Ic #ifdef...#endif
518 attempts to correctly
519 compensate for the syntactic peculiarities introduced.
523 utility understands a substantial amount about the syntax of C, but it
524 has a `forgiving' parser.
525 It attempts to cope with the usual sorts of
526 incomplete and misformed syntax.
527 In particular, the use of macros like:
529 .Dl #define forever for(;;)
537 environment variable.
539 .Bl -tag -width "./.indent.pro" -compact
553 utility has even more switches than
556 A common mistake is to try to indent all the
558 programs in a directory by typing:
562 This is probably a bug, not a feature.
projects / FreeBSD / releng / 10.0.git / blob