cd8d1bf1c20217b3929d24c58ef397af822d034d
[dragonfly.git] / usr.bin / indent / indent.1
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.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
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.
21 .\"
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
32 .\" SUCH DAMAGE.
33 .\"
34 .\"     @(#)indent.1    8.1 (Berkeley) 7/1/93
35 .\" $FreeBSD: src/usr.bin/indent/indent.1,v 1.28 2010/03/31 17:05:30 avg Exp $
36 .\"
37 .Dd May 6, 2010
38 .Dt INDENT 1
39 .Os
40 .Sh NAME
41 .Nm indent
42 .Nd indent and format C program source
43 .Sh SYNOPSIS
44 .Nm
45 .Op Ar input-file Op Ar output-file
46 .Op Fl bad | Fl nbad
47 .Op Fl bap | Fl nbap
48 .Bk -words
49 .Op Fl bbb | Fl nbbb
50 .Ek
51 .Op Fl \&bc | Fl nbc
52 .Op Fl \&bl
53 .Op Fl \&br
54 .Op Fl c Ns Ar n
55 .Op Fl \&cd Ns Ar n
56 .Bk -words
57 .Op Fl cdb | Fl ncdb
58 .Ek
59 .Op Fl \&ce | Fl nce
60 .Op Fl \&ci Ns Ar n
61 .Op Fl cli Ns Ar n
62 .Op Fl d Ns Ar n
63 .Op Fl \&di Ns Ar n
64 .Bk -words
65 .Op Fl fbs | Fl nfbs
66 .Op Fl fc1 | Fl nfc1
67 .Op Fl fcb | Fl nfcb
68 .Ek
69 .Op Fl i Ns Ar n
70 .Op Fl \&ip | Fl nip
71 .Op Fl l Ns Ar n
72 .Op Fl \&lc Ns Ar n
73 .Op Fl \&ldi Ns Ar n
74 .Op Fl \&lp | Fl nlp
75 .Op Fl npro
76 .Op Fl pcs | Fl npcs
77 .Op Fl psl | Fl npsl
78 .Op Fl \&sc | Fl nsc
79 .Bk -words
80 .Op Fl sob | Fl nsob
81 .Ek
82 .Op Fl \&st
83 .Op Fl \&ta
84 .Op Fl troff
85 .Op Fl ut | Fl nut
86 .Op Fl v | Fl \&nv
87 .Sh DESCRIPTION
88 The
89 .Nm
90 utility is a
91 .Em C
92 program formatter.
93 It reformats the
94 .Em C
95 program in the
96 .Ar input-file
97 according to the switches.
98 The switches which can be specified are described below.
99 They may appear before or after the file names.
100 .Pp
101 .Sy NOTE :
102 If you only specify an
103 .Ar input-file ,
104 the formatting is
105 done `in-place', that is, the formatted file is written back into
106 .Ar input-file
107 and a backup copy of
108 .Ar input-file
109 is written in the current directory.
110 If
111 .Ar input-file
112 is named
113 .Sq Pa /blah/blah/file ,
114 the backup file is named
115 .Sq Pa file.BAK .
116 .Pp
117 If
118 .Ar output-file
119 is specified,
120 .Nm
121 checks to make sure that it is different from
122 .Ar input-file .
123 .Pp
124 The options listed below control the formatting style imposed by
125 .Nm .
126 .Bl -tag -width Op
127 .It Fl bad , nbad
128 If
129 .Fl bad
130 is specified, a blank line is forced after every block of
131 declarations.
132 Default:
133 .Fl nbad .
134 .It Fl bap , nbap
135 If
136 .Fl bap
137 is specified, a blank line is forced after every procedure body.
138 Default:
139 .Fl nbap .
140 .It Fl bbb , nbbb
141 If
142 .Fl bbb
143 is specified, a blank line is forced before every block comment.
144 Default:
145 .Fl nbbb .
146 .It Fl \&bc , nbc
147 If
148 .Fl \&bc
149 is specified, then a newline is forced after each comma in a declaration.
150 .Fl nbc
151 turns off this option.
152 Default:
153 .Fl \&nbc .
154 .It Fl \&br , \&bl
155 Specifying
156 .Fl \&bl
157 lines-up compound statements like this:
158 .Bd -literal -offset indent
159 if (...)
160 {
161   code
162 }
163 .Ed
164 .Pp
165 Specifying
166 .Fl \&br
167 (the default) makes them look like this:
168 .Bd -literal -offset indent
169 if (...) {
170   code
171 }
172 .Ed
173 .Pp
174 .It Fl c Ns Ar n
175 The column in which comments on code start.
176 The default is 33.
177 .It Fl cd Ns Ar n
178 The column in which comments on declarations start.
179 The default is for these comments to start in the same column as those on code.
180 .It Fl cdb , ncdb
181 Enables (disables) the placement of comment delimiters on blank lines.
182 With this option enabled, comments look like this:
183 .Bd -literal -offset indent
184         /*
185          * this is a comment
186          */
187 .Ed
188 .Pp
189 Rather than like this:
190 .Bd -literal -offset indent
191         /* this is a comment */
192 .Ed
193 .Pp
194 This only affects block comments, not comments to the right of code.
195 The default is
196 .Fl cdb .
197 .It Fl ce , nce
198 Enables (disables) forcing of `else's to cuddle up to the immediately preceding
199 `}'.
200 The default is
201 .Fl \&ce .
202 .It Fl \&ci Ns Ar n
203 Sets the continuation indent to be
204 .Ar n .
205 Continuation
206 lines will be indented that far from the beginning of the first line of the
207 statement.
208 Parenthesized expressions have extra indentation added to
209 indicate the nesting, unless
210 .Fl \&lp
211 is in effect or the continuation indent is exactly half of the main indent.
212 .Fl \&ci
213 defaults to the same value as
214 .Fl i .
215 .It Fl cli Ns Ar n
216 Causes case labels to be indented
217 .Ar n
218 tab stops to the right of the containing
219 .Ic switch
220 statement.
221 .Fl cli0.5
222 causes case labels to be indented half a tab stop.
223 The default is
224 .Fl cli0 .
225 .It Fl d Ns Ar n
226 Controls the placement of comments which are not to the right of code.
227 For example,
228 .Fl \&d\&1
229 means that such comments are placed one indentation level to the left of code.
230 Specifying the default
231 .Fl \&d\&0
232 lines-up these comments with the code.
233 See the section on comment indentation below.
234 .It Fl \&di Ns Ar n
235 Specifies the indentation, in character positions,
236 of global variable names and all struct/union member names
237 relative to the beginning of their type declaration.
238 The default is
239 .Fl di16 .
240 .It Fl dj , ndj
241 .Fl \&dj
242 left justifies declarations.
243 .Fl ndj
244 indents declarations the same as code.
245 The default is
246 .Fl ndj .
247 .It Fl \&ei , nei
248 Enables (disables) special
249 .Ic else-if
250 processing.
251 If it is enabled, an
252 .Ic if
253 following an
254 .Ic else
255 will have the same indentation as the preceding
256 .Ic \&if
257 statement.
258 The default is
259 .Fl ei .
260 .It Fl fbs , nfbs
261 Enables (disables) splitting the function declaration and opening brace
262 across two lines.
263 The default is
264 .Fl fbs .
265 .It Fl fc1 , nfc1
266 Enables (disables) the formatting of comments that start in column 1.
267 Often, comments whose leading `/' is in column 1 have been carefully
268 hand formatted by the programmer.
269 In such cases,
270 .Fl nfc1
271 should be used.
272 The default is
273 .Fl fc1 .
274 .It Fl fcb , nfcb
275 Enables (disables) the formatting of block comments (ones that begin
276 with `/*\\n').
277 Often, block comments have been not so carefully hand formatted by the
278 programmer, but reformatting that would just change the line breaks is not
279 wanted.
280 In such cases,
281 .Fl nfcb
282 should be used.
283 Block comments are then handled like box comments.
284 The default is
285 .Fl fcb .
286 .It Fl i Ns Ar n
287 The number of spaces for one indentation level.
288 The default is 8.
289 .It Fl \&ip , nip
290 Enables (disables) the indentation of parameter declarations from the left
291 margin.
292 The default is
293 .Fl \&ip .
294 .It Fl l Ns Ar n
295 Maximum length of an output line.
296 The default is 78.
297 .It Fl \&ldi Ns Ar n
298 Specifies the indentation, in character positions,
299 of local variable names
300 relative to the beginning of their type declaration.
301 The default is for local variable names to be indented
302 by the same amount as global ones.
303 .It Fl \&lp , nlp
304 Lines-up code surrounded by parenthesis in continuation lines.
305 If a line
306 has a left paren which is not closed on that line, then continuation lines
307 will be lined up to start at the character position just after the left
308 paren.
309 For example, here is how a piece of continued code looks with
310 .Fl nlp
311 in effect:
312 .Bd -literal -offset indent
313 p1 = first_procedure(second_procedure(p2, p3),
314 \ \ third_procedure(p4, p5));
315 .Ed
316 .Pp
317 With
318 .Fl lp
319 in effect (the default) the code looks somewhat clearer:
320 .Bd -literal -offset indent
321 p1\ =\ first_procedure(second_procedure(p2,\ p3),
322 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,\ p5));
323 .Ed
324 .Pp
325 Inserting two more newlines we get:
326 .Bd -literal -offset indent
327 p1\ =\ first_procedure(second_procedure(p2,
328 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p3),
329 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ third_procedure(p4,
330 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ p5));
331 .Ed
332 .It Fl npro
333 Causes the profile files,
334 .Sq Pa ./.indent.pro
335 and
336 .Sq Pa ~/.indent.pro ,
337 to be ignored.
338 .It Fl pcs , npcs
339 If true
340 .Pq Fl pcs
341 all procedure calls will have a space inserted between the name and the `('.
342 The default is
343 .Fl npcs .
344 .It Fl psl , npsl
345 If true
346 .Pq Fl psl
347 the names of procedures being defined are placed in
348 column 1 \- their types, if any, will be left on the previous lines.
349 The default is
350 .Fl psl .
351 .It Fl \&sc , nsc
352 Enables (disables) the placement of asterisks (`*'s) at the left edge of all
353 comments.
354 The default is
355 .Fl sc .
356 .It Fl sob , nsob
357 If
358 .Fl sob
359 is specified, indent will swallow optional blank lines.
360 You can use this to get rid of blank lines after declarations.
361 Default:
362 .Fl nsob .
363 .It Fl \&st
364 Causes
365 .Nm
366 to take its input from stdin and put its output to stdout.
367 .It Fl ta
368 Automatically add all identifiers ending in "_t" to the list
369 of type keywords.
370 .It Fl T Ns Ar typename
371 Adds
372 .Ar typename
373 to the list of type keywords.
374 Names accumulate:
375 .Fl T
376 can be specified more than once.
377 You need to specify all the typenames that
378 appear in your program that are defined by
379 .Ic typedef
380 \- nothing will be
381 harmed if you miss a few, but the program will not be formatted as nicely as
382 it should.
383 This sounds like a painful thing to have to do, but it is really
384 a symptom of a problem in C:
385 .Ic typedef
386 causes a syntactic change in the
387 language and
388 .Nm
389 cannot find all
390 instances of
391 .Ic typedef .
392 .It Fl troff
393 Causes
394 .Nm
395 to format the program for processing by
396 .Xr troff 1 .
397 It will produce a fancy
398 listing in much the same spirit as
399 .Xr vgrind 1 .
400 If the output file is not specified, the default is standard output,
401 rather than formatting in place.
402 .It Fl ut , nut
403 Enables (disables) the use of tab characters in the output.
404 Tabs are assumed to be aligned on columns divisible by 8.
405 The default is
406 .Fl ut .
407 .It Fl v , \&nv
408 .Fl v
409 turns on `verbose' mode;
410 .Fl \&nv
411 turns it off.
412 When in verbose mode,
413 .Nm
414 reports when it splits one line of input into two or more lines of output,
415 and gives some size statistics at completion.
416 The default is
417 .Fl \&nv .
418 .El
419 .Pp
420 You may set up your own `profile' of defaults to
421 .Nm
422 by creating a file called
423 .Pa .indent.pro
424 in your login directory and/or the current directory and including
425 whatever switches you like.
426 A `.indent.pro' in the current directory takes
427 precedence over the one in your login directory.
428 If
429 .Nm
430 is run and a profile file exists, then it is read to set up the program's
431 defaults.
432 Switches on the command line, though, always override profile switches.
433 The switches should be separated by spaces, tabs or newlines.
434 .Ss Comments
435 .Sq Em Box
436 .Em comments .
437 The
438 .Nm
439 utility
440 assumes that any comment with a dash or star immediately after the start of
441 comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars.
442 Each line of such a comment is left unchanged, except that its indentation
443 may be adjusted to account for the change in indentation of the first line
444 of the comment.
445 .Pp
446 .Em Straight text .
447 All other comments are treated as straight text.
448 The
449 .Nm
450 utility fits as many words (separated by blanks, tabs, or newlines) on a
451 line as possible.
452 Blank lines break paragraphs.
453 .Ss Comment indentation
454 If a comment is on a line with code it is started in the `comment column',
455 which is set by the
456 .Fl c Ns Ns Ar n
457 command line parameter.
458 Otherwise, the comment is started at
459 .Ar n
460 indentation levels less than where code is currently being placed, where
461 .Ar n
462 is specified by the
463 .Fl d Ns Ns Ar n
464 command line parameter.
465 If the code on a line extends past the comment
466 column, the comment starts further to the right, and the right margin may be
467 automatically extended in extreme cases.
468 .Ss Preprocessor lines
469 In general,
470 .Nm
471 leaves preprocessor lines alone.
472 The only reformatting that it will do is to straighten up trailing comments.
473 It leaves embedded comments alone.
474 Conditional compilation
475 .Pq Ic #ifdef...#endif
476 is recognized and
477 .Nm
478 attempts to correctly
479 compensate for the syntactic peculiarities introduced.
480 .Ss C syntax
481 The
482 .Nm
483 utility understands a substantial amount about the syntax of C, but it
484 has a `forgiving' parser.
485 It attempts to cope with the usual sorts of incomplete and misformed syntax.
486 In particular, the use of macros like:
487 .Pp
488 .Dl #define forever for(;;)
489 .Pp
490 is handled properly.
491 .Sh ENVIRONMENT
492 The
493 .Nm
494 utility uses the
495 .Ev HOME
496 environment variable.
497 .Sh FILES
498 .Bl -tag -width ".Pa /usr/share/misc/indent.pro" -compact
499 .It Pa ./.indent.pro
500 profile file
501 .It Pa ~/.indent.pro
502 profile file
503 .It Pa /usr/share/misc/indent.pro
504 example profile file
505 .El
506 .Sh HISTORY
507 The
508 .Nm
509 command appeared in
510 .Bx 4.2 .
511 .Sh BUGS
512 The
513 .Nm
514 utility has even more switches than
515 .Xr ls 1 .
516 .Pp
517 A common mistake is to try to indent all the
518 .Em C
519 programs in a directory by typing:
520 .Pp
521 .Dl indent *.c
522 .Pp
523 This is probably a bug, not a feature.