4.3BSD-Reno/share/man/cat1/indent.0

Compare this file to the similar file:
Show the results in this format:

INDENT(1) UNIX Reference Manual INDENT(1)

NNAAMMEE
iinnddeenntt - indent and format C program source

DDEESSCCRRIIPPTTIIOONN
IInnddeenntt is a _C program formatter. It reformats the _C program in the
_i_n_p_u_t-_f_i_l_e according to the switches. The switches which can be speci-
fied are described below. They may appear before or after the file names.

NNOOTTEE: If you only specify an _i_n_p_u_t-_f_i_l_e, the formatting is done `in-
place', that is, the formatted file is written back into _i_n_p_u_t-_f_i_l_e and a
backup copy of _i_n_p_u_t-_f_i_l_e is written in the current directory. If
_i_n_p_u_t-_f_i_l_e is named `/_b_l_a_h/_b_l_a_h/_f_i_l_e', the backup file is named _f_i_l_e._B_A_K.

If _o_u_t_p_u_t-_f_i_l_e is specified, iinnddeenntt checks to make sure it is different
from _i_n_p_u_t-_f_i_l_e.

The options listed below control the formatting style imposed by iinnddeenntt.

--bbaadd, --nnbbaadd If --bbaadd is specified, a blank line is forced after every
block of declarations. Default: --nnbbaadd.

--bbaapp, --nnbbaapp If --bbaapp is specified, a blank line is forced after every
procedure body. Default: --nnbbaapp.

--bbbbbb, --nnbbbbbb If --bbbbbb is specified, a blank line is forced before every
block comment. Default: --nnbbbbbb.

--bbcc, --nnbbcc If --bbcc is specified, then a newline is forced after each
comma in a declaration. --nnbbcc turns off this option. The
default is --bbcc.

--bbrr, --bbll Specifying --bbll lines up compound statements like this:
if (...)
{
code
}
Specifying --bbrr (the default) makes them look like this:
if (...) {
code
}

--cc --nn The column in which comments on code start. The default is
33.

--ccdd --nn The column in which comments on declarations start. The
default is for these comments to start in the same column
as those on code.

--ccddbb, --nnccddbb Enables (disables) the placement of comment delimiters on
blank lines. With this option enabled, comments look like
this:
/*
* this is a comment
*/
Rather than like this:
/* this is a comment */
This only affects block comments, not comments to the right
of code. The default is --ccddbb.

--ccee, --nnccee Enables (disables) forcing `else's to cuddle up to the im-
mediately preceding `}'. The default is --ccee.

--ccii_n Sets the continuation indent to be _n. Continuation lines
will be indented that far from the beginning of the first
line of the statement. Parenthesized expressions have ex-
tra indentation added to indicate the nesting, unless --llpp
is in effect. --ccii defaults to the same value as --ii.

--ccllii_n Causes case labels to be indented _n tab stops to the right
of the containing sswwiittcchh statement. --ccllii00 --..55 causes case
labels to be indented half a tab stop. The default is
--ccllii00.

--dd_n Controls the placement of comments which are not to the
right of code. The default --dd11 means that such comments
are placed one indentation level to the left of code.
Specifying --dd00 lines up these comments with the code. See
the section on comment indentation below.

--ddii_n Specifies the indentation, in character positions, from a
declaration keyword to the following identifier. The
default is --ddii1166.

--ddjj, --nnddjj --ddjj left justifies declarations. --nnddjj indents declarations
the same as code. The default is --nnddjj.

--eeii, --nneeii Enables (disables) special eellssee--iiff processing. If it's en-
abled, an iiff following an eellssee will have the same indenta-
tion as the preceding iiff statement.

--ffcc11, --nnffcc11 Enables (disables) the formatting of comments that start in
column 1. Often, comments whose leading `/' is in column 1
have been carefully hand formatted by the programmer. In
such cases, --nnffcc11 should be used. The default is --ffcc11.

--ii_n The number of spaces for one indentation level. The
default is 4.

--iipp, --nniipp Enables (disables) the indentation of parameter declara-
tions from the left margin. The default is --iipp.

--ll_n Maximum length of an output line. The default is 75.

--llpp, --nnllpp Lines up code surrounded by parenthesis in continuation
lines. If a line has a left paren which is not closed on
that line, then continuation lines will be lined up to
start at the character position just after the left paren.
For example, here is how a piece of continued code looks
with --nnllpp in effect:
p1 = first_procedure(second_procedure(p2, p3),
third_procedure(p4,p5));
With --llpp in effect (the default) the code looks somewhat
clearer:
p1 = first_procedure(second_procedure(p2, p3),
third_procedure(p4,p5));
Inserting two more newlines we get:
p1 = first_procedure(second_procedure(p2,
p3),
third_procedure(p4
p5));

--nnpprroo Causes the profile files, `./._i_n_d_e_n_t._p_r_o' and
`~/._i_n_d_e_n_t._p_r_o', to be ignored.
--ppccss, --nnppccss If true (--ppccss) all procedure calls will have a space in-
serted between the name and the `('. The default is --nnppccss.

--ppssll, --nnppssll If true (--ppssll) the names of procedures being defined are
placed in column 1 - their types, if any, will be left on
the previous lines. The default is --ppssll.

--sscc, --nnsscc Enables (disables) the placement of asterisks (`*'s) at the
left edge of all comments.

--ssoobb, --nnssoobb If --ssoobb is specified, indent will swallow optional blank
lines. You can use this to get rid of blank lines after
declarations. Default: --nnssoobb.

--sstt Causes iinnddeenntt to take its input from stdin, and put its
output to stdout.

--TT_t_y_p_e_n_a_m_e Adds _t_y_p_e_n_a_m_e to the list of type keywords. Names accumu-
late: --TT can be specified more than once. You need to
specify all the typenames that appear in your program that
are defined by ttyyppeeddeeff - nothing will be harmed if you miss
a few, but the program won't be formatted as nicely as it
should. This sounds like a painful thing to have to do,
but it's really a symptom of a problem in C: ttyyppeeddeeff causes
a syntactic change in the language and iinnddeenntt can't find
all instances of ttyyppeeddeeff.

--ttrrooffff Causes iinnddeenntt to format the program for processing by
troff. It will produce a fancy listing in much the same
spirit as vgrind(1). If the output file is not specified,
the default is standard output, rather than formatting in
place.

--vv, --nnvv --vv turns on `verbose' mode; --nnvv turns it off. When in ver-
bose mode, iinnddeenntt reports when it splits one line of input
into two or more lines of output, and gives some size
statistics at completion. The default is --nnvv.

You may set up your own `profile' of defaults to iinnddeenntt by creating a
file called ._i_n_d_e_n_t._p_r_o in your login directory and/or the current direc-
tory and including whatever switches you like. A `.indent.pro' in the
current directory takes precedence over the one in your login directory.
If iinnddeenntt is run and a profile file exists, then it is read to set up the
program's defaults. Switches on the command line, though, always over-
ride profile switches. The switches should be separated by spaces, tabs
or newlines.

CCoommmmeennttss
`_B_o_x' _c_o_m_m_e_n_t_s. IInnddeenntt assumes that any comment with a dash or star im-
mediately after the start of comment (that is, `/*-' or `/**') is a com-
ment surrounded by a box of stars. Each line of such a comment is left
unchanged, except that its indentation may be adjusted to account for the
change in indentation of the first line of the comment.

_S_t_r_a_i_g_h_t _t_e_x_t. All other comments are treated as straight text. IInnddeenntt
fits as many words (separated by blanks, tabs, or newlines) on a line as
possible. Blank lines break paragraphs.

CCoommmmeenntt iinnddeennttaattiioonn
If a comment is on a line with code it is started in the `comment
column', which is set by the --cc_n command line parameter. Otherwise, the
comment is started at _n indentation levels less than where code is
currently being placed, where _n is specified by the --dd_n command line
parameter. If the code on a line extends past the comment column, the
comment starts further to the right, and the right margin may be
automatically extended in extreme cases.
PPrreepprroocceessssoorr lliinneess
In general, iinnddeenntt leaves preprocessor lines alone. The only reformat-
ting that it will do is to straighten up trailing comments. It leaves
embedded comments alone. Conditional compilation (##iiffddeeff......##eennddiiff) is
recognized and iinnddeenntt attempts to correctly compensate for the syntactic
peculiarities introduced.

CC ssyynnttaaxx
IInnddeenntt understands a substantial amount about the syntax of C, but it has
a `forgiving' parser. It attempts to cope with the usual sorts of incom-
plete and misformed syntax. In particular, the use of macros like:
#define forever for(;;)
is handled properly.

EENNVVIIRROONNMMEENNTT
IInnddeenntt uses the HOME environment variable.

FFIILLEESS
./._i_n_d_e_n_t._p_r_o profile file
~/._i_n_d_e_n_t._p_r_o profile file

HHIISSTTOORRYY
IInnddeenntt appeared in 4.2 BSD.

BBUUGGSS
IInnddeenntt has even more switches than ls(1).

A common mistake that often causes grief is typing:
indent *.c
to the shell in an attempt to indent all the CC programs in a directory.
This is probably a bug, not a feature.