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