\input texinfo   @c -*-texinfo-*-
@c %**start of header
@setfilename indent.info
@settitle @code{indent}:  Indent and Format C Program Source
@c %**end of header

@c ===> NOTE! <==
@c Determine the edition number in *three* places by hand:
@c      1. First ifinfo section  2. title page  3. top node
@c To find the locations, search for !!set

@c smallbook
@c Note: some of the long options are too long for the index in
@c       smallbook format.  This will need some thought.  --rjc

@finalout

@synindex cp ky
@setchapternewpage odd

@ifinfo
Copyright (C) 1989, 1992 Free Software Foundation, Inc.

@c !!set edition, date, version
This is Edition 0.01, 6 February 1992, of the @cite{@code{indent} Manual},
for Indent Version 1.2

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

@ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
section entitled ``GNU General Public License'' is included exactly as
in the original, and provided that the entire resulting derived work is
distributed under the terms of a permission notice identical to this
one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that the section entitled ``GNU General Public License'' may be
included in a translation approved by the author instead of in the
original English.
@end ignore
@end ifinfo

@titlepage
@title Indent
@subtitle Format C Code
@sp 1
@c !!set edition, version, date
@subtitle Edition 0.01, for Indent Version 1.2
@subtitle February 1992
@author Jim Kingdon
@author Joseph Arceneaux
@page
@vskip 0pt plus1filll
Copyright @copyright{} 1989, 1992 Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation approved
by the Foundation.
@end titlepage
@page

@c put the following line in the the file dir in the info directory
@c under wherever you have installed emacs (assuming that
@c the info file made from this file is in the file "indent")
@c * indent:(indent).  How to change the appearance of a C program.

@ifinfo
@node Top,  , (dir), (dir)
@top @code{indent}:  Indent and Format C Program Source

The @code{indent} program changes the appearance of a C program by
inserting or deleting whitespace.  It can be used to make code easier
to read.  It can also convert from one style of writing C to another.
As of version 1.2, the default style used is the GNU style.

This is Edition 0.01, February 1992, of the @cite{@code{indent} Manual},
for Indent Version 1.2

@code{indent} understands a substantial amount about the syntax of C,
but it also attempts to cope with incomplete and misformed syntax.
@end ifinfo

@menu
* Invoking indent::     How to run the @code{indent} program.
* Common styles::       Common styles of formatting C programs.

        Detailed Descriptions of each Option

* Blank lines::         Options to control addition or deletion of blank lines.
* Comments::            How @code{indent} affects comments.
* Statements::          Options involving statements.
* Declarations::        Options involving declarations.
* Indentation::         How far each line is indented from the left margin.
* Miscellaneous options::  Verbose mode, and getting @code{indent}'s version number.
* Copyright::           Copyright notice for the @code{indent} program.

* Option Summary::      Alphabetical list of options with short descriptions.
* Index::
@end menu

@iftex
@chapter The @code{indent} Program

The @code{indent} program changes the appearance of a C program by
inserting or deleting whitespace.  It can be used to make code easier
to read.  It can also convert from one style of writing C to another.
As of version 1.2, the default style used is the GNU style.
@end iftex

@node Invoking indent, Common styles, Top, Top
@comment  node-name,  next,  previous,  up
@section Invoking @code{indent}
@cindex Invoking @code{indent}
@cindex Starting @code{indent}
@cindex Beginning @code{indent}

The format of the @code{indent} command is:

@example
indent [@var{input-file} [@var{output-file}]] [@var{options}]
@end example

Most options to @code{indent} control how programs are formatted.  As of
version 1.2, @code{indent} also recognizes a long name for each option
name.  Long options are prefixed by either @samp{--} or
@samp{+}.@footnote{ @samp{+} is being superseded by @samp{--} to
maintain consistency with the POSIX standard.} In most of this document,
the traditional, short names are used for the sake of brevity.
@xref{Option Summary}, for a list of options, including both long and
short names.

@need 1000
For example, to indent the program @file{munch.c} and write the indented
C program to @file{munch.out}, you would use the command

@example
indent munch.c munch.out
@end example

If an input file is specified but no output file is specified, the
formatted file is written back into the input file, and a backup copy of
the input file is written in the current directory.  The name of the
backup copy is formed by adding @samp{.BAK} to the end of the name of the
input file.

For example:

@example
indent -br test/munch.c -l85
@end example

@noindent
This will indent the program @file{test/munch.c} using the @samp{-br}
and @samp{-l85} options, write the output back to @file{test/munch.c},
and copy the original contents of @file{test/munch.c} to
@file{munch.c.BAK} in the current directory.

@cindex Long options, use of
@need 1000
Equivalent invocations using long option names for this example would
be:

@example
@group
indent --braces-on-if-line --line-length185 test/munch.c

indent +braces-on-if-line +line-length185 test/munch.c
@end group
@end example

@cindex Multiple files, indenting all
@cindex Many files at once
@cindex All files, indenting them
Note that it does not work to type @code{indent *.c} to indent all the
programs in a directory.  The shell expands this command into a command
such as @code{indent foo.c bar.c baz.c}.  If there are more than 2 files
in the current directory ending in @samp{.c}, you will get an error
message; if there are exactly 2 such files you will overwrite the second
one with the indented version of the first.  The exact command to indent
all the C programs in the current directory depends on what shell you
are using; for @code{bash} or similar shells you would use the following:

@example
@group
for file in *.c; do
indent $file
done
@end group
@end example

@cindex Standard input and output
@kindex -st
@kindex --standard-input-or-output
To cause @code{indent} to read from standard input and write to standard
output, use the @samp{-st} option.  If an input file is specified in
addition to @samp{-st}, @code{indent} will use the specified file rather
than standard input.

@cindex @file{.indent.pro} file
@cindex Initialization file
@kindex -npro
@kindex --ignore-profile
If you find that you often use @code{indent} with the same options, you
may put those options into a file called @file{.indent.pro}.
@code{indent} will first look for @file{.indent.pro} in your home
directory and then reads @file{.indent.pro} in the current directory.
After this command line switches are processed.  Options specified later
override arguments specified earlier, with one exception: Explicitly
specified options always override background options 
(@pxref{Common styles}).  You can prevent @code{indent} from reading the
@file{.indent.pro} files by specifying the @samp{-npro} option.@refill

@node Common styles, Blank lines, Invoking indent, Top
@comment  node-name,  next,  previous,  up
@section Common styles

There are several common styles of C code, including the GNU style, the
Kernighan & Ritchie style, and the original Berkeley style.  A style may
be selected with a single @dfn{background} option, which specifies a set
of values for all other options.  However, explicitly specified options
always override options implied by a background option.

@cindex GNU style
@kindex -gnu
@kindex --gnu-style
As of version 1.2, the default style of GNU @code{indent} is the GNU
style.  Thus, it is no longer neccessary to specify the option
@samp{-gnu} to obtain this format, although doing so will not cause an
error.  Option settings which correspond to the GNU style are:

@example
@group
-nbad -bap -nbbb -nbc -bl -bli2 -c33 -cd33 -ncdb -nce
-cli0 -cp1 -di0 -nfc1 -nfca -i2 -ip5 -lp -pcs -psl 
-nsc -nsob -nss -ts8
@end group
@end example

The GNU coding style is that preferred by the GNU project.  It is the
style that the GNU Emacs C mode encourages and which is used in the C
portions of GNU Emacs.  People interested in writing programs for
Project GNU should get a copy of @cite{The GNU Coding Standards}, which
also cover semantic and portability issues such as memory usage, the
size of integers, etc.

@cindex Kernighan & Ritchie style
@kindex -kr
@kindex --k-and-r-style
@comment --kernighan-and-ritchie-style works, too, as does
@comment --kernighan-and-ritchie.  Which is most intuitive?
The Kernighan & Ritchie style is the one used in their well-known book
@cite{The C Programming Language}.  It is enabled with the @samp{-kr}
option.  The Kernighan & Ritchie style corresponds to the following set
of options:

@example
@group
-nbad -bap -nbbb -nbc -br -c33 -cd33 -ncdb -ce -ci4
-cli0 -cp33 -d0 -di1 -nfc1 -nfca -i4 -ip0 -l75 -lp 
-npcs -npsl -nsc -nsob -nss -ts8
@end group
@end example

@noindent
Kernighan & Ritchie style does not put comments to the right of code in
the same column at all times (nor does it use only one space to the
right of the code), so for this style @code{indent} has arbitrarily
chosen column 33.

@cindex Berkeley style
@cindex Original Berkeley style
@kindex -orig
@kindex --original
The style of the original Berkeley @code{indent} may be obtained by
specifying @samp{-orig} (or by specifyfying @samp{--original}, using the
long option name).  This style is equivalent to the following settings:

@example
@group
-nbap -nbad -nbbb -bc -br -c33 -cd33 -cdb -ce -ci4
-cli0 -cp33 -d4 -di16 -fc1 -fca -i4 -ip4 -l75 -lp 
-npcs -psl -sc -nsob -nss -ts8
@end group
@end example

@node Blank lines,  Comments, Common styles, Top
@comment  node-name,  next,  previous,  up
@section Blank lines
@cindex Blank lines

Various programming styles use blank lines in different places.
@code{indent} has a number of options to insert or delete blank lines in
specific places.

The @samp{-bad} option causes @code{indent} to force a blank line after
every block of declarations.  The @samp{-nbad} option causes
@code{indent} not to force such blank lines.

The @samp{-bap} option forces a blank line after every procedure body.
The @samp{-nbap} option forces no such blank line.

@kindex -bbb
@kindex --blank-lines-after-block-comments
@kindex -nbbb
@kindex --no-blank-lines-after-block-comments
The @samp{-bbb} option forces a blank line before every block comment.
The exact definition of a block comment is unclear.  The @samp{-nbbb}
option does not force such blank lines.

@kindex -sob
@kindex --swallow-optional-blank-lines
@kindex -nsob
@kindex --leave-optional-blank-lines
The @samp{-sob} option causes @code{indent} to swallow optional blank
lines (that is, any optional blank lines present in the input will be
removed from the output).  If the @samp{-nsob} is specified, any blank
lines present in the input file will be copied to the output file.

@menu
* -bad::                More on the @samp{-bad} option.
* -bap::                More on the @samp{-bap} option.
@end menu

@ifinfo
@node -bad, -bap, Blank lines, Blank lines    
@comment  node-name,  next,  previous,  up
@subsection --blank-lines-after-declarations
@end ifinfo

@kindex -bad
@kindex --blank-lines-after-declarations
@kindex -nbad
@kindex --no-blank-lines-after-declarations
The @samp{-bad} option forces a blank line after every block of
declarations.  The @samp{-nbad} option does not add any such blank
lines.

For example, given the input
@example
@group
char *foo;
char *bar;
/* This separates blocks of declarations.  */
int baz;
@end group
@end example

@noindent
@code{indent -bad} produces

@example
@group
char *foo;
char *bar;

/* This separates blocks of declarations.  */
int baz;
@end group
@end example

@noindent
and @code{indent -nbad} produces

@example
@group
char *foo;
char *bar;
/* This separates blocks of declarations.  */
int baz;
@end group
@end example

@ifinfo
@node -bap,  , -bad, Blank lines    
@comment  node-name,  next,  previous,  up
@subsection --blank-lines-after-procedures
@end ifinfo

@kindex -bap
@kindex --blank-lines-after-procedures
@kindex -nbap
@kindex --no-blank-lines-after-procedures
The @samp{-bap} option forces a blank line after every procedure body.

For example, given the input

@example
@group
int
foo ()
@{
  puts("Hi");
@}
/* The procedure bar is even less interesting.  */
char *
bar ()
@{
  puts("Hello");
@}
@end group
@end example

@noindent
@code{indent -bap} produces

@example
@group
int
foo ()
@{
  puts ("Hi");
@}

/* The procedure bar is even less interesting.  */
char *
bar ()
@{
  puts ("Hello");
@}
@end group
@end example

@noindent
and @code{indent -nbap} produces

@example
@group
int
foo ()
@{
  puts ("Hi");
@}
/* The procedure bar is even less interesting.  */
char *
bar ()
@{
  puts ("Hello");
@}
@end group
@end example

@noindent
no blank line will be added after the procedure @code{foo}.

@node Comments, Statements, Blank lines, Top
@comment  node-name,  next,  previous,  up
@section Comments
@cindex Comments

@kindex -fca
@kindex --format-all-comments
@kindex -nfca
@kindex --dont-format-comments
@kindex -l@var{n}
@kindex --line-length@var{n}
Comments are no longer formatted by default as of version 1.2.  This can
be enabled with the @samp{-fca} option.  Doing so will cause newlines in
the comment text to be ignored and the line will be filled up to the
length of a line (which can be modified with @samp{-l}).  When
formatting, blank lines indicate paragraph breaks.


@kindex -fc1
@kindex --format-first-column-comments
@kindex -nfc1
@kindex --dont-format-first-column-comments
Comments not starting in the first column with @samp{-} or @samp{*}
immediately after the opening @samp{/*} are presumed to be hand
formatted, and so any formatting is disabled.  Using the @samp{-nfc1}
option will disable any formatting of first column comments.  When
formatting of comments is disabled, indentation may still be adjusted.

@kindex -d@var{n}
@kindex --line-comments-indentation@var{n}
@kindex -cdb
@kindex --comment-delimiters-on-blank-lines
@kindex -ncdb
@kindex --no-comment-delimiters-on-blank-lines
The indentation of comments which do not appear to the right of code is
set by the @samp{-d} option, which specifies the number of spaces to the
left of the surrounding code that the comment appears.  For example,
@samp{-d2} places comments two spaces to the left of code; @samp{-d0}
lines up comments with the code.  The @samp{-cdb} option controls
whether the @samp{/*} and @samp{*/} are placed on blank lines.  With
@samp{-cdb}, comments look like this:

@example
@group
/*
 * this is a comment
 */
@end group
@end example

@noindent
With @samp{-ncdb}, comments look like this:

@example
/* this is a comment */
@end example

@noindent
@samp{-cdb} only affects block comments, not comments to the right of
code.  The default is @samp{-ncdb}.

@kindex -c@var{n}
@kindex --comment-indentation@var{n}
@kindex -cd@var{n}
@kindex --declaration-comment-column@var{n}
@kindex -cp@var{n}
@kindex --else-endif-column@var{n}
Comments which appear on the same line as code are placed to the right.
The column in which comments on code start is controlled by the
@samp{-c} option.  The column in which comments to the right of
declarations start is controlled by the @samp{-cd} option.  By default,
they start in the same column as comments to the right of code.  The
column number for comments to the right of @samp{#else} and
@samp{#endif} statements is controlled by the @samp{-cp} option.  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.@refill

@kindex -sc
@kindex --start-left-side-of-comments
@kindex -nsc
@kindex --dont-star-comments
If the @samp{-sc} option is specified, @samp{*} is placed at the left
edge of all comments.  For example:

@example
@group
/* This is a comment which extends from one line 
 * onto the next line, thus causing us to consider 
 * how it should continue.  */
@end group
@end example

@noindent
instead of

@example
@group
/* This is a comment which extends from one line
   onto the next line, thus causing us to consider
   how it should continue.  */
@end group
@end example

@node Statements,  Declarations, Comments, Top    
@comment  node-name,  next,  previous,  up
@section Statements

@kindex -br
@kindex --braces-on-if-line
@kindex -bl
@kindex --braces-after-if-line
Use the @samp{-br} or @samp{-bl} option to specify how you want braces
to be formatted.  Using @samp{-br} lines up braces like this:

@example
@group
if (x > 0) @{
  x--;
@}
@end group
@end example

@noindent
Using @samp{-bl} makes them look like this:

@example
@group
if (x > 0)
  @{
    x--;
  @}
@end group
@end example

@kindex -bli@var{n}
@kindex --brace-indent@var{n}
If you use the @samp{-bl} option, you may also want to specify the
@samp{-bli} option.  This option gives the number of spaces that the
braces are indented.  @samp{-bli2}, the default, gives the result shown
above.  @samp{-bli0} results in the following appearance:

@example
@group
if (x > 0)
@{
  x--;
@}
@end group
@end example

@kindex -ce
@kindex --cuddle-else
@kindex -dce
@kindex --dont-cuddle-else
If you are using the @samp{-br} option, you probably want to also use
the @samp{-ce} option.  This causes the @code{else} in an if-then-else
construct to cuddle up to the immediately preceding @samp{@}}.  For
example, with @samp{-br -ce} you would get

@c Replaced long error message "You seem to have done something wrong."
@c with short one so example fits into smallbook.
@example
@group
if (x > 0) @{
  x--;
@} else @{
  fprintf (stderr, "...something wrong?\n");
@}
@end group
@end example

@noindent
With @samp{-br -nce} that code would appear as

@smallexample
@group
if (x > 0) @{
  x--;
@}
else @{
  fprintf (stderr, "...something wrong?\n");
@}
@end group
@end smallexample

@kindex -cli@var{n}
@kindex --case-indentation@var{n}
The @samp{-cli} option specifies the number of spaces that case labels
should be indented to the right of the containing @samp{switch}
statement.

@kindex -ss
@kindex --space-special-semicolon
If a semicolon is on the same line as a @code{for} or @code{while}
statement, the @samp{-ss} option will cause a space to be placed before
the semicolon.  This emphasizes the semicolon, making it clear that the
body of the @code{for} or @code{while} statement is an empty statement.

@kindex -nss
@kindex --dont-space-special-semicolon
@code{-nss} disables this feature.

@kindex -pcs
@kindex --space-after-procedure-calls
@kindex -npcs
@kindex --no-space-after-function-call-names
The @samp{-pcs} option causes a space to be placed between the name of
the procedure being called and the @samp{(} (for example, @w{@code{puts
("Hi");}}.  The @samp{-npcs} option would give @code{puts("Hi");}).
@refill

@kindex -cs
@kindex --space-after-cast
@kindex -ncs
@kindex --no-space-after-casts
If the @samp{-cs} option is specified, @code{indent} puts a space after
a cast operator.

@node Declarations, Indentation, Statements, Top 
@comment  node-name,  next,  previous,  up
@section Declarations

@kindex -di@var{n}
@kindex --declaration-indentation@var{n}
By default @code{indent} will line up identifiers, in the column
specified by the @samp{-di} option.  For example, @samp{-di16} makes
things look like:

@example
@group
int             foo;
char           *bar;
@end group
@end example

Using a small value (such as one or two) for the @samp{-di} option can
be used to cause the indentifiers to be placed in the first available
position, for example

@example
@group
int foo;
char *bar;
@end group
@end example

The value given to the @samp{-di} option will still affect variables
which are put on separate lines from their types, for example
@samp{-di2} will lead to

@example
@group
int
  foo;
@end group
@end example

@kindex -bc
@kindex --blank-lines-after-commas
@kindex -nbc
@kindex --no-blank-lines-after-commas
If the @samp{-bc} option is specified, a newline is forced after each
comma in a declaration.  For example,

@example
@group
int a,
  b,
  c;
@end group
@end example

@noindent
With the @samp{-nbc} option this would look like

@example
int a, b, c;
@end example

@kindex -psl
@kindex --procnames-start-lines
@kindex -npsl
@kindex --dont-break-procedure-type
@cindex @code{etags} requires @samp{-psl}
The @samp{-psl} option causes the type of a procedure being defined to
be placed on the line before the name of the procedure.  This style is
required for the @code{etags} program to work correctly, as well as some
of the @code{c-mode} functions of Emacs.

@kindex -T
@cindex Typenames
If you are not using the @samp{-di1} option to place variables being
declared immediately after their type, you need to use the @samp{-T}
option to tell @code{indent} the name of all the typenames in your
program that are defined by @code{typedef}.  @samp{-T} can be specified
more than once, and all names specified are used.  For example, if your
program contains

@example
@group
typedef unsigned long CODE_ADDR;
typedef enum @{red, blue, green@} COLOR;
@end group
@end example

@noindent
you would use the options @samp{-T CODE_ADDR -T COLOR}.

@node Indentation, Miscellaneous options, Declarations, Top    
@comment  node-name,  next,  previous,  up
@section Indentation

@kindex -i@var{n}
@kindex --indent-level@var{n}
@kindex -ci@var{n}
@kindex --continuation-indentation@var{n}
@kindex -lp
@kindex --continue-at-parentheses
@kindex -nlp
@kindex --dont-line-up-parentheses
One issue in the formatting of code is how far each line should be
indented from the left margin.  When the beginning of a statement such
as @code{if} or @code{for} is encountered, the indentation level is
increased by the value specified by the @samp{-i} option.  For example,
use @samp{-i8} to specify an eight character indentation for each level.
When a statement is continued from a previous line, it is indented by a
number of additional spaces specified by the @samp{-ci} option.
@samp{-ci} defaults to the same value as @samp{-i}.  However, if the
@samp{-lp} option is specified, and a line has a left parenthesis which
is not closed on that line, then continuation lines will be lined up to
start at the character position just after the left parenthesis.  This
processing also applies to @samp{[} and applies to @samp{@{} when it
occurs in initialization lists.  For example, a piece of continued code
might look like this with @samp{-nlp -ci3} in effect:@refill

@example
@group
  p1 = first_procedure (second_procedure (p2, p3),
     third_procedure (p4, p5));
@end group
@end example

@noindent
With @samp{-lp} in effect the code looks somewhat clearer:

@example
@group
  p1 = first_procedure (second_procedure (p2, p3),
                        third_procedure (p4, p5));
@end group
@end example

@kindex -ts@var{n}
@kindex --tab-size@var{n}
@code{indent} assumes that tabs are placed at regular intervals of both
input and output character streams.  These intervals are by default 8
columns wide, but (as of version 1.2) may be changed by the @samp{-ts}
option.  Tabs are treated as the equivalent number of spaces.

@kindex -ip@var{n}
@kindex --parameter-indentation@var{n}
The indentation of type declarations in old-style function definitions
is controlled by the @samp{-ip} parameter.  This is a numeric parameter
specifying how many spaces to indent type declarations.  For example,
the default @w{@samp{-ip5}} makes definitions look like this:

@example
@group
char *
create_world (x, y, scale)
     int x;
     int y;
     float scale;
@{
  . . .
@}
@end group
@end example

@node Miscellaneous options, Copyright, Indentation, Top    
@comment  node-name,  next,  previous,  up
@section Miscellaneous options

@kindex -version
To find out what version of @code{indent} you have, use the command
@code{indent -version}.  This will report the version number of
@code{indent}, without doing any of the normal processing.

@ignore
This is intentionally undocumented because
1.  Although GNU now has groff, it would be better to use TeX.

2.  The output of indent -troff looks awful, so we have heard.  Perhaps
    it would be reasonable to use this as a starting point to printing a
    program.

If you are printing your program, you may wish to use the @samp{-troff}
option to produce output suitable for processing by the @code{troff}
program.  When the @samp{-troff} option is specified, if the output file
is not specified, the default is standard output, rather than formatting
in place.
@end ignore

@kindex -v
@kindex --verbose
@kindex -nv
@kindex --no-verbosity
@comment Would --terse be better?  I think not, but perhaps accepting
@comment --no-verbose would avoid error messages.
The @samp{-v} option can be used to turn on verbose mode.  When in
verbose mode, @code{indent} reports when it splits one line of input
into two more more lines of output, and gives some size statistics at
completion. 

@node Copyright, Option Summary, Miscellaneous options, Top    
@comment  node-name,  next,  previous,  up
@section Copyright

The following copyright notice applies to the @code{indent} program.
The copyright and copying permissions for this manual appear near the
beginning of this document.

@display
Copyright (c) 1989, 1992 Free Software Foundation
Copyright (c) 1985 Sun Microsystems, Inc.
Copyright (c) 1980 The Regents of the University of California.
Copyright (c) 1976 Board of Trustees of the University of Illinois.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley, the University of Illinois,
Urbana, and Sun Microsystems, Inc.  The name of either University
or Sun Microsystems may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
PURPOSE.
@end display

@node Option Summary, Index, Copyright, Top
@appendix Option Summary

Here is a list of all the options for @code{indent}, alphabetized by
short option.  It is followed by a cross key alphabetized by long option.

@c The cross references are all on lines by themselves because this
@c looks better in both printed output and Info.  4 Feb 1992  --rjc
@table @samp
@item -bad
@itemx --blank-lines-after-declarations
Force blank lines after the declarations.@*
@xref{Blank lines}.

@item -bap
@itemx --blank-lines-after-procedures
Force blank lines after procedure bodies.@*
@xref{Blank lines}.

@item -bbb
@itemx --blank-lines-after-block-comments
Force blank lines after block comments.@*
@xref{Blank lines}.

@item -bc
@itemx --blank-lines-after-commas
Force newline after comma in declaration.@*
@xref{Declarations}.

@item -bl
@itemx --braces-after-if-line
Put braces on line after @code{if}, etc.@*
@xref{Statements}.

@item -bli@var{n}
@item --brace-indent@var{n}
Indent braces @var{n} spaces.@*
@xref{Statements}.

@item -br
@itemx --braces-on-if-line
Put braces on line with @code{if}, etc.@*
@xref{Statements}.

@item -c@var{n}
@itemx --comment-indentation@var{n}
Put comments to the right of code in column @var{n}.@*
@xref{Comments}.

@item -cd@var{n}
@itemx --declaration-comment-column@var{n}
Put comments to the right of the declarations in column @var{n}.@*
@xref{Comments}.

@item -cdb
@itemx --comment-delimiters-on-blank-lines
Put comment delimiters on blank lines.@*
@xref{Comments}.

@item -ce
@itemx --cuddle-else
Cuddle else and preceeding @samp{@}}.@*
@xref{Comments}.

@item -ci@var{n}
@itemx --continuation-indentation@var{n}
Continuation indent of @var{n} spaces.@*
@xref{Statements}.

@item -cli@var{n}
@itemx --case-indentation@var{n}
Case label indent of @var{n} spaces.@*
@xref{Statements}.

@item -cp@var{n}
@item --else-endif-column@var{n}
Put comments to the right of @samp{#else} and 
@samp{#endif} statements in column @var{n}.@* 
@xref{Comments}.

@item -cs
@itemx --space-after-cast
Put a space after a cast operator.@*
@xref{Statements}.

@item -d@var{n}
@itemx --line-comments-indentation@var{n}
Set indentation of comments not to the right 
of code to @var{n} spaces.@*
@xref{Comments}.

@item -di@var{n}
@itemx --declaration-indentation@var{n}
Put variables in column @var{n}.@*
@xref{Declarations}.

@item -fc1
@itemx --format-first-column-comments
Format comments in the first column.@*
@xref{Comments}.

@item -fca
@itemx --format-all-comments
Do not disable all formatting of comments.@*
@xref{Comments}

@item -gnu
@itemx --gnu-style
Use GNU coding style.  Note that this is the default.@*
@xref{Common styles}.

@item -i@var{n}
@itemx --indent-level@var{n}
Set indentation level to @var{n} spaces.@*
@xref{Indentation}.

@item -ip@var{n}
@itemx --parameter-indentation@var{n}
Indent parameter types in old-style function 
definitions by @var{n} spaces.@*
@xref{Indentation}.

@item -kr
@itemx --k-and-r-style
Use Kernighan & Ritchie coding style.@*
@xref{Common styles}.

@item -l@var{n}
@itemx --line-length@var{n}
Set maximum line length to @var{n}.@*
@xref{Comments}.

@item -lp
@itemx --continue-at-parentheses
Line up continued lines at parentheses.@*
@xref{Indentation}.

@item -nbad
@itemx --no-blank-lines-after-declarations
Do not force blank lines after declarations.@*
@xref{Blank lines}.

@item -nbap
@itemx --no-blank-lines-after-procedures
Do not force blank lines after procedure bodies.@*
@xref{Blank lines}.

@item -nbbb
@itemx --no-blank-lines-after-block-comments
Do not force blank-lines after block comments.@*
@xref{Blank lines}.

@item -nbc
@itemx --no-blank-lines-after-commas
Do not force newlines after commas in declarations.@*
@xref{Declarations}.

@item -ncdb
@itemx --no-comment-delimiters-on-blank-lines
Do not put comment delimiters on blank lines.@*
@xref{Comments}.

@item -nce
@itemx --dont-cuddle-else
Do not cuddle @code{@}} and @code{else}.
@xref{Statements}.

@item -ncs
@itemx --no-space-after-casts
Do not put a space after cast operators.@*
@xref{Statements}.

@item -nfc1
@itemx --dont-format-first-column-comments
Do not format comments in the first column as normal.@*
@xref{Comments}.

@item -nfca
@itemx --dont-format-comments
Do not format any comments.
@xref{Comments}.

@item -nlp
@itemx --dont-line-up-parentheses
Do not line up parentheses.
@xref{Statements}.

@item -npcs
@itemx --no-space-after-function-call-names
Do not put space after the function in function calls.@*
@xref{Statements}.

@item -npsl
@itemx --dont-break-procedure-type
Put the type of a procedure on the same line as its name.@*
@xref{Declarations}.

@item -nsc
@itemx --dont-star-comments
Do not put the @samp{*} character at the left of comments.@*
@xref{Comments}.

@item -nsob
@itemx --leave-optional-blank-lines
Do not swallow optional blank lines.@*
@xref{Blank lines}.

@item -nss  
@item --dont-space-special-semicolon
Do not force a space before the semicolon after certain statements.
Disables @samp{-ss}.@*
@xref{Statements}.

@item -nv
@itemx --no-verbosity
Disable verbose mode. @xref{Miscellaneous options}.

@item -orig
@itemx --original
Use the original Berkeley coding style.@*
@xref{Common styles}.

@item -npro
@itemx --ignore-profile
Do not read @file{.indent.pro} files.@*
@xref{Invoking indent}.

@item -pcs  
@itemx --space-after-procedure-calls
Insert a space between the name of the 
procedure being called and the @samp{(}.@*
@xref{Statements}.

@item -psl
@itemx --procnames-start-lines
Put the type of a procedure on the line before its name.@*
@xref{Declarations}.

@item -sc
@itemx --start-left-side-of-comments
Put the @samp{*} character at the left of comments.@*
@xref{Comments}.

@item -sob
@itemx --swallow-optional-blank-lines
Swallow optional blank lines.@*
@xref{Blank lines}.

@item -ss
@itemx --space-special-semicolon
On one-line @code{for} and @code{while} statments, 
force a blank before the semicolon.@*
@xref{Statements}.

@item -st
@itemx --standard-input-or-output
Read from standard input and write to standard output.@*
@xref{Invoking indent}.

@item -T   
Tell @code{indent} the name of typenames.@*
@xref{Declarations}.

@c Ignore the following since it is not supported.  When someone
@c rewrites this program, an effort could be made to generate TeX.
@c
@c item -troff
@c Format the program for printing with @code{troff}.  Use of this option
@c is not suggested.
@c  xref   Miscellaneous options
@c 
@c
@item -ts@var{n}
@itemx --tab-size@var{n}
Set tab size to @var{n} spaces.  @xref{Indentation}.

@item -v
@itemx --verbose
Enable verbose mode.  @xref{Miscellaneous options}.

@item -version
Output the version number of @code{indent}. @*
@xref{Miscellaneous options}.
@end table

@subheading Options' Cross Key

Here is a list of options alphabetized by long option, to help you find
the corresponding short option.

@iftex
@sp 2
@end iftex
@tex
\def\leaderfill{\leaders\hbox to 1em{\hss.\hss}\hfill}

{\tt
\line{ --blank-lines-after-block-comments \leaderfill -bbb\ }
\line{ --blank-lines-after-commas \leaderfill         -bc\ \ }  
\line{ --blank-lines-after-declarations \leaderfill   -bad\ } 
\line{ --blank-lines-after-procedures \leaderfill     -bap\ }  
\line{ --braces-after-if-line \leaderfill            -bl\ \ } 
\line{ --brace-indent \leaderfill                -bli@var{n}}
\line{ --braces-on-if-line \leaderfill               -br\ \ }      
\line{ --case-indentation \leaderfill            -cli@var{n}}
\line{ --comment-delimiters-on-blank-lines \leaderfill -cdb\ }
\line{ --comment-indentation \leaderfill       -c@var{n}\ \ } 
\line{ --continuation-indentation       \leaderfill -ci@var{n}\ } 
\line{ --continue-at-parentheses  \leaderfill   -lp\ \ }            
\line{ --cuddle-else \leaderfill                         -ce\ \ }
\line{ --declaration-comment-column \leaderfill  -cd@var{n}\ } 
\line{ --declaration-indentation \leaderfill     -di@var{n}\ } 
\line{ --dont-break-procedure-type \leaderfill           -npsl} 
\line{ --dont-cuddle-else \leaderfill                    -nce\ }  
\line{ --dont-format-comments \leaderfill                -nfca} 
\line{ --dont-format-first-column-comments \leaderfill   -nfc1} 
\line{ --dont-line-up-parentheses \leaderfill            -nlp\ }  
\line{ --dont-space-special-semicolon \leaderfill        -nss\ }
\line{ --dont-star-comments \leaderfill                  -nsc\ }  
\line{ --else-endif-column \leaderfill             -cp@var{n}\ }
\line{ --format-all-comments \leaderfill                 -fca\ }  
\line{ --format-first-column-comments \leaderfill        -fc1\ }  
\line{ --gnu-style \leaderfill                           -gnu\ }  
\line{ --ignore-profile \leaderfill                      -npro} 
\line{ --indent-level \leaderfill                  -i@var{n}\ \ }
\line{ --k-and-r-style \leaderfill                       -kr\ \ }
\line{ --leave-optional-blank-lines \leaderfill          -nsob}    
\line{ --line-comments-indentation \leaderfill      -d@var{n}\ \ }
\line{ --line-length \leaderfill                    -l@var{n}\ \ }
\line{ --no-blank-lines-after-block-comments \leaderfill -nbbb}  
\line{ --no-blank-lines-after-commas \leaderfill         -nbc\ }   
\line{ --no-blank-lines-after-declarations \leaderfill   -nbad}  
\line{ --no-blank-lines-after-procedures \leaderfill     -nbap}  
\line{ --no-comment-delimiters-on-blank-lines \leaderfill -ncdb}  
\line{ --no-space-after-casts \leaderfill               -ncs\ }    
\line{ --no-space-after-function-call-names \leaderfill -npcs}   
\line{ --no-verbosity \leaderfill                       -nv\ \ }
\line{ --original \leaderfill                      -orig}
\line{ --parameter-indentation \leaderfill         -ip@var{n}\ } 
\line{ --procnames-start-lines \leaderfill         -psl\ }  
\line{ --space-after-cast \leaderfill              -cs\ \ } 
\line{ --space-after-procedure-calls \leaderfill   -pcs\ }  
\line{ --space-special-semicolon \leaderfill       -ss\ \ } 
\line{ --standard-input-or-output \leaderfill      -st\ \ } 
\line{ --start-left-side-of-comments \leaderfill   -sc\ \ }
\line{ --swallow-optional-blank-lines \leaderfill  -sob\ } 
\line{ --tab-size \leaderfill          -ts@var{n}\ }  
\line{ --verbose \leaderfill       -v\ \ \ }  
}
@end tex

@ifinfo
@example
--blank-lines-after-block-comments              -bbb            
--blank-lines-after-commas                      -bc             
--blank-lines-after-declarations                -bad            
--blank-lines-after-procedures                  -bap            
--braces-after-if-line                          -bl             
--brace-indent                                  -bli
--braces-on-if-line                             -br             
--case-indentation                              -cli@var{n}     
--comment-delimiters-on-blank-lines             -cdb            
--comment-indentation                           -c@var{n}       
--continuation-indentation                      -ci@var{n}      
--continue-at-parentheses                       -lp             
--cuddle-else                                   -ce             
--declaration-comment-column                    -cd@var{n}      
--declaration-indentation                       -di@var{n}      
--dont-break-procedure-type                     -npsl           
--dont-cuddle-else                              -nce            
--dont-format-comments                          -nfca           
--dont-format-first-column-comments             -nfc1           
--dont-line-up-parentheses                      -nlp            
--dont-space-special-semicolon                  -nss
--dont-star-comments                            -nsc            
--else-endif-column                             -cp@var{n}
--format-all-comments                           -fca            
--format-first-column-comments                  -fc1            
--gnu-style                                     -gnu            
--ignore-profile                                -npro           
--indent-level                                  -i@var{n}       
--k-and-r-style                                 -kr             
--leave-optional-blank-lines                    -nsob           
--line-comments-indentation                     -d@var{n}       
--line-length                                   -l@var{n}       
--no-blank-lines-after-block-comments           -nbbb           
--no-blank-lines-after-commas                   -nbc            
--no-blank-lines-after-declarations             -nbad           
--no-blank-lines-after-procedures               -nbap           
--no-comment-delimiters-on-blank-lines          -ncdb           
--no-space-after-casts                          -ncs            
--no-space-after-function-call-names            -npcs           
--no-verbosity                                  -nv             
--original                                      -orig
--parameter-indentation                         -ip@var{n}      
--procnames-start-lines                         -psl            
--space-after-cast                              -cs             
--space-after-procedure-calls                   -pcs            
--space-special-semicolon                       -ss             
--standard-input-or-output                      -st             
--start-left-side-of-comments                   -sc             
--swallow-optional-blank-lines                  -sob            
--tab-size                                      -ts@var{n}      
--verbose                                       -v              
@end example
@end ifinfo

@node Index,  , Option Summary, Top
@unnumbered Index

@printindex ky

@contents
@bye

