.TH INDENT 1L
.\» NAME should be all caps, SECTION should be 1-8, maybe w/ subsection.\» other parms are allowed: see man(7), man(1).SH NAME
indent \- changes the appearance of a C program by inserting or deletingwhitespace.
.SH SYNOPSIS
.nf
.na
indent [-bad] [-bap] [-bbb] [-bc] [-bl] [-bliN] [-br] [-cN] [-cdN] [-cdb][-ce] [-ciN] [-cliN] [-cpN] [-cs] [-bs] [-dN] [-diN] [-fc1] [-fca][-gnu] [-iN] [-ipN] [-kr] [-lN] [-lp] [-nbad] [-nbap] [-nbbb][-nbc] [-ncdb] [-nce] [-ncs] [-nfc1] [-nfca] [-nip] [-nlp] [-npcs][-npsl] [-nsc] [-nsob] [-nss] [-nv] [-orig] [-npro] [-pcs] [-psl][-sc] [-sob] [-ss] [-st] [-T] [-tsN] [-v] [-version] [file].ad
.fi
.SH «DESCRIPTION"
from the input file indent.texinfo. This is Edition 0.02, 5 May 1992, of
.SH «COPYING"
manual provided the copyright notice and this permission notice arepreserved on all copies.
.SH «INTRODUCTION"
can also convert from one style of writing C to another.
`indent' understands a substantial amount about the syntax of C, butit also attempts to cope with incomplete and misformed syntax.
is the default.
.SH «INVOKING INDENT"
.in +5
indent [OPTIONS] [INPUT-FILES]
indent [OPTIONS] [SINGLE-INPUT-FILE] [-o OUTPUT-FILE]
.in -5
`indent'.
makes a backup copy of each file, and the original file is replaced withits indented version. *Note Backup files::, for an explanation of howbackups are made.
or when the standard input is used, you may specify an output file afterthe `-o' option.standard input is used.
read.
`slithy_toves.c' and write its indented text to `slithy_toves.out':
.in +5
indent slithy_toves.c -o slithy_toves.out
indent -st slithy_toves.c > slithy_toves.out
cat slithy_toves.c | indent -o slithy_toves.out
.in -5
name. Long options are prefixed by either `--' or `+'. `+' is beingsuperseded by `--' to maintain consistency with the POSIX standard.
sake of brevity.
.in +5
indent -br test/metabolism.c -l85
.in -5
`-l85' options, write the output back to `test/metabolism.c', and writethe original contents of `test/metabolism.c' to a backup file in thedirectory `test'.
be:
.in +5
indent --braces-on-if-line --line-length185 test/metabolism.c
indent +braces-on-if-line +line-length185 test/metabolism.c
.in -5
may put those options into a file called `.indent.pro'. `indent' willfirst look for `.indent.pro' in the current directory and use that iffound. Otherwise, `indent' will search your home directory for`.indent.pro' and use that file if it is found. This behaviour isdifferent from that of other versions of `indent', which load bothfiles if they both exist.
exception: Explicitly specified options always override backgroundoptions (*note Common styles::.). You can prevent `indent' fromreading an `.indent.pro' file by specifying the `-npro' option..SH «BACKUP FILES"
same way GNU Emacs does. This means that either «simple» or «numbered"backup filenames may be made.
original file name. The default for the this suffix is theone-character string `~' (tilde). Thus, the backup file for `python.c'would be `python.c~'.
setting the environment variable `SIMPLE_BACKUP_SUFFIX' to yourpreferred suffix.
`momewraths.c.~23~', where 23 is the version of this particular backup.
backup file will be named `src/momewrath.c.~V~', where V is one greaterthan the highest version currently existing in the directory `src'.
environment variable `VERSION_CONTROL'. If it is the string `simple',then only simple backups will be made. If its value is the string`numbered', then numbered backups will be made. If its value is`numbered-existing', then numbered backups will be made if there*already exist* numbered backups for the file being indented;otherwise, a simple backup is made. If `VERSION_CONTROL' is not set,then `indent' assumes the behaviour of `numbered-existing'.
files. This behaviour can be emulated by setting`SIMPLE_BACKUP_SUFFIX' to `.BAK'.
current directory, rather than in the directory of the source file as
.SH «COMMON STYLES"
the Kernighan & Ritchie style, and the original Berkeley style. Astyle may be selected with a single «background» option, whichspecifies a set of values for all other options. However, explicitlyspecified options always override options implied by a backgroundoption.
style. Thus, it is no longer neccessary to specify the option `-gnu'to obtain this format, although doing so will not cause an error.
.in +5
-nbad -bap -nbbb -nbc -bl -bli2 -c33 -cd33 -ncdb -nce-cli0 -cp1 -di0 -nfc1 -nfca -i2 -ip5 -lp -pcs -psl-nsc -nsob -nss -ts8
.in -5
style that the GNU Emacs C mode encourages and which is used in the Cportions of GNU Emacs. (People interested in writing programs for
covers semantic and portability issues such as memory usage, the sizeof integers, etc.)
book `The C Programming Language'. It is enabled with the `-kr'option. The Kernighan & Ritchie style corresponds to the following setof options:
.in +5
-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
.in -5
the same column at all times (nor does it use only one space to theright of the code), so for this style `indent' has arbitrarily chosencolumn 33.
specifying `-orig' (or by specifyfying `--original', using the longoption name). This style is equivalent to the following settings:
.in +5
-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
.in -5
.SH «BLANK LINES"
`indent' has a number of options to insert or delete blank lines inspecific places.
block of declarations. The `-nbad' option causes `indent' not to forcesuch blank lines.
block comment is one which starts in column one when formatting of suchcomments is disabled, or one with `-' or `*' immediately following the`/*'. The `-nbbb' option does not force such blank lines.
(that is, any optional blank lines present in the input will be removedfrom the output). If the `-nsob' is specified, any blank lines presentin the input file will be copied to the output file.
declarations. The `-nbad' option does not add any such blank lines.
.in +5
.nf
.na
char *foo;
char *bar;
/* This separates blocks of declarations. */int baz;
.in -5
.ad
.fi
`indent -bad' produces
.in +5
.nf
.na
char *foo;
char *bar;
/* This separates blocks of declarations. */int baz;
.in -5
.ad
.fi
and `indent -nbad' produces
.in +5
.nf
.na
char *foo;
char *bar;
/* This separates blocks of declarations. */int baz;
.in -5
.ad
.fi
.in +5
.nf
.na
int
foo ()
{
puts("Hi");
}
/* The procedure bar is even less interesting. */char *
bar ()
{
puts("Hello");
}
.in -5
.ad
.fi
`indent -bap' produces
.in +5
.nf
.na
int
foo ()
{
puts ("Hi");
}
/* The procedure bar is even less interesting. */char *
bar ()
{
puts ("Hello");
}
.in -5
.ad
.fi
and `indent -nbap' produces
.in +5
.nf
.na
int
foo ()
{
puts ("Hi");
}
/* The procedure bar is even less interesting. */char *
bar ()
{
puts ("Hello");
}
.in -5
.ad
.fi
.SH «COMMENTS"
can be enabled with the `-fca' option. Doing so will cause newlines inthe comment text to be ignored and the line will be filled up to thelength of a line (which can be modified with `-l'). When formatting isenabled, blank lines indicate paragraph breaks.
the first column. The `-nfc1' option disables the formatting of firstcolumn comments. When comment formatting is disabled, overall commentindentation may still be adjusted.
is set by the `-d' option, which specifies the number of spaces to theleft of the surrounding code that the comment appears. For example,`-d2' places comments two spaces to the left of code; `-d0' lines upcomments with the code. The `-cdb' option controls whether the `/*'and `*/' are placed on blank lines. With `-cdb', comments look likethis:
.in +5
.nf
.na
/*
* this is a comment
*/
.in -5
.ad
.fi
.in +5
.nf
.na
/* this is a comment */
.in -5
.ad
.fi
`-cdb' only affects block comments, not comments to the right of code.
right. The column in which comments on code start is controlled by the`-c' option. The column in which comments to the right of declarationsstart is controlled by the `-cd' option. By default, they start in thesame column as comments to the right of code, which is column 33. Thecolumn number for comments to the right of `#else' and `#endif'statements is controlled by the `-cp' option. If the code on a lineextends past the comment column, the comment starts further to theright, and the right margin may be automatically extended in extremecases.
all comments. For example:
.in +5
.nf
.na
/* This is a comment which extends from one line* onto the next line, thus causing us to consider* how it should continue. */
.in -5
.ad
.fi
instead of
.in +5
.nf
.na
/* This is a comment which extends from one lineonto the next line, thus causing us to considerhow it should continue. */
.in -5
.ad
.fi
.SH «STATEMENTS"
.in +5
.nf
.na
if (x > 0) {
x--;
}
.in -5
.ad
.fi
.in +5
.nf
.na
if (x > 0)
{
x--;
}
.in -5
.ad
.fi
option. This option specifies the number of spaces by which braces areindented. `-bli2', the default, gives the result shown above. `-bli0'results in the following:
.in +5
.nf
.na
if (x > 0)
{
x--;
}
.in -5
.ad
.fi
`-ce' option. This causes the `else' in an if-then-else construct tocuddle up to the immediately preceding `}'. For example, with `-br-ce' you get the following:
.in +5
.nf
.na
if (x > 0) {
x--;
} else {
fprintf (stderr, «...something wrong?\n");}
.in -5
.ad
.fi
.in +5
.nf
.na
if (x > 0) {
x--;
}
else {
fprintf (stderr, «...something wrong?\n");}
.in -5
.ad
.fi
should be indented to the right of the containing `switch' statement.
the `-ss' option will cause a space to be placed before the semicolon.
`for' or `while' statement is an empty statement. `-nss' disables thisfeature.
the procedure being called and the `(' (for example, `puts ("Hi");'.
operator.
`sizeof' and its argument. In some versions, this is known as the`Bill_Shannon' option.
.SH «DECLARATIONS"
specified by the `-di' option. For example, `-di16' makes things looklike:
.in +5
.nf
.na
.in -5
.ad
.fi
used to cause the indentifiers to be placed in the first availableposition, for example
.in +5
.nf
.na
int foo;
char *bar;
.in -5
.ad
.fi
which are put on separate lines from their types, for example `-di2'will lead to
.in +5
.nf
.na
int
foo;
.in -5
.ad
.fi
comma in a declaration. For example,
.in +5
.nf
.na
int a,
b,
c;
.in -5
.ad
.fi
.in +5
.nf
.na
int a, b, c;
.in -5
.ad
.fi
placed on the line before the name of the procedure. This style isrequired for the `etags' program to work correctly, as well as some ofthe `c-mode' functions of Emacs.
declared immediately after their type, you need to use the `-T' optionto tell `indent' the name of all the typenames in your program that aredefined by `typedef'. `-T' can be specified more than once, and allnames specified are used. For example, if your program contains
.in +5
.nf
.na
typedef unsigned long CODE_ADDR;
typedef enum {red, blue, green} COLOR;
.in -5
.ad
.fi
you would use the options `-T CODE_ADDR -T COLOR'..SH «INDENTATION"
indented from the left margin. When the beginning of a statement suchas `if' or `for' is encountered, the indentation level is increased bythe value specified by the `-i' option. For example, use `-i8' tospecify an eight character indentation for each level. When a statementis continued from a previous line, it is indented by a number ofadditional spaces specified by the `-ci' option. `-ci' defaults to 0.
parenthesis which is not closed on that line, then continuation lineswill be lined up to start at the character position just after the leftparenthesis. This processing also applies to `[' and applies to `{'when it occurs in initialization lists. For example, a piece ofcontinued code might look like this with `-nlp -ci3' in effect:
.in +5
.nf
.na
p1 = first_procedure (second_procedure (p2, p3),third_procedure (p4, p5));
.in -5
.ad
.fi
.in +5
.nf
.na
p1 = first_procedure (second_procedure (p2, p3),third_procedure (p4, p5));
.in -5
.ad
.fi
`indent' assumes that tabs are placed at regular intervals of bothinput and output character streams. These intervals are by default 8columns wide, but (as of version 1.2) may be changed by the `-ts'option. Tabs are treated as the equivalent number of spaces.
definitions is controlled by the `-ip' parameter. This is a numericparameter specifying how many spaces to indent type declarations. Forexample, the default `-ip5' makes definitions look like this:
.in +5
.nf
.na
char *
create_world (x, y, scale)
int x;
int y;
float scale;
{
. . .
}
.in -5
.ad
.fi
is provided, which is equivalent to `-ip0'.
.SH «MISCELLANEOUS OPTIONS"
`indent -version'. This will report the version number of `indent',without doing any of the normal processing.
verbose mode, `indent' reports when it splits one line of input intotwo more more lines of output, and gives some size statistics atcompletion.
.SH «COPYRIGHT"
copyright and copying permissions for this manual appear near thebeginning of this document.
.nf
.na
Copyright (c) 1989, 1992 Free Software FoundationCopyright (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 permittedprovided that the above copyright notice and this paragraph areduplicated in all such forms and that any documentation,advertising materials, and other materials related to suchdistribution and use acknowledge that the software was developedby the University of California, Berkeley, the University of Illinois,Urbana, and Sun Microsystems, Inc. The name of either Universityor Sun Microsystems may not be used to endorse or promote productsderived from this software without specific prior written permission.THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS ORIMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIEDWARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULARPURPOSE.
.ad
.fi
.SH OPTIONS
short option. It is followed by a cross key alphabetized by longoption.
.nf
.na
`-bad'
`--blank-lines-after-declarations'
Force blank lines after the declarations.
`-bap'
`--blank-lines-after-procedures'
Force blank lines after procedure bodies.
`-bbb'
`--blank-lines-after-block-comments'
Force blank lines after block comments.
`-bc'
`--blank-lines-after-commas'
Force newline after comma in declaration.
`-bl'
`--braces-after-if-line'
Put braces on line after `if', etc.
`-bliN'
`--brace-indentN'
Indent braces N spaces.
`-br'
`--braces-on-if-line'
Put braces on line with `if', etc.
`-cN'
`--comment-indentationN'
Put comments to the right of code in column N.
`-cdN'
`--declaration-comment-columnN'
Put comments to the right of the declarations in column N.
`-cdb'
`--comment-delimiters-on-blank-lines'
Put comment delimiters on blank lines.
`-ce'
`--cuddle-else'
Cuddle else and preceeding `}'.
`-ciN'
`--continuation-indentationN'
Continuation indent of N spaces.
`-cliN'
`--case-indentationN'
Case label indent of N spaces.
`-cpN'
`--else-endif-columnN'
Put comments to the right of `#else' and `#endif' statements incolumn N.
`-cs'
`--space-after-cast'
Put a space after a cast operator.
`-bs'
`--blank-before-sizeof'
Put a space between `sizeof' and its argument.
`-dN'
`--line-comments-indentationN'
Set indentation of comments not to the right of code to N spaces.
`-diN'
`--declaration-indentationN'
Put variables in column N.
`-fc1'
`--format-first-column-comments'
Format comments in the first column.
`-fca'
`--format-all-comments'
Do not disable all formatting of comments.
`-gnu'
`--gnu-style'
Use GNU coding style. This is the default.
`-iN'
`--indent-levelN'
Set indentation level to N spaces.
`-ipN'
`--parameter-indentationN'
Indent parameter types in old-style function definitions by Nspaces.
`-kr'
`--k-and-r-style'
Use Kernighan & Ritchie coding style.
`-lN'
`--line-lengthN'
Set maximum line length to N.
`-lp'
`--continue-at-parentheses'
Line up continued lines at parentheses.
`-nbad'
`--no-blank-lines-after-declarations'
Do not force blank lines after declarations.
`-nbap'
`--no-blank-lines-after-procedures'
Do not force blank lines after procedure bodies.
`-nbbb'
`--no-blank-lines-after-block-comments'
Do not force blank-lines after block comments.
`-nbc'
`--no-blank-lines-after-commas'
Do not force newlines after commas in declarations.
`-ncdb'
`--no-comment-delimiters-on-blank-lines'
Do not put comment delimiters on blank lines.
`-nce'
`--dont-cuddle-else'
Do not cuddle `}' and `else'.
`-ncs'
`--no-space-after-casts'
Do not put a space after cast operators.
`-nfc1'
`--dont-format-first-column-comments'
Do not format comments in the first column as normal.
`-nfca'
`--dont-format-comments'
Do not format any comments.
`-nip'
`--no-parameter-indentation'
Zero width indentation for parameters.
`-nlp'
`--dont-line-up-parentheses'
Do not line up parentheses.
`-npcs'
`--no-space-after-function-call-names'
Do not put space after the function in function calls.
`-npsl'
`--dont-break-procedure-type'
Put the type of a procedure on the same line as its name.
`-nsc'
`--dont-star-comments'
Do not put the `*' character at the left of comments.
`-nsob'
`--leave-optional-blank-lines'
Do not swallow optional blank lines.
`-nss'
`--dont-space-special-semicolon'
Do not force a space before the semicolon after certain statements.Disables `-ss'.
`-nv'
`--no-verbosity'
`-orig'
`--original'
Use the original Berkeley coding style.
`-npro'
`--ignore-profile'
Do not read `.indent.pro' files.
`-pcs'
`--space-after-procedure-calls'
Insert a space between the name of the procedure being called andthe `('.
`-psl'
`--procnames-start-lines'
Put the type of a procedure on the line before its name.
`-sc'
`--start-left-side-of-comments'
Put the `*' character at the left of comments.
`-sob'
`--swallow-optional-blank-lines'
Swallow optional blank lines.
`-ss'
`--space-special-semicolon'
On one-line `for' and `while' statments, force a blank before thesemicolon.
`-st'
`--standard-output'
Write to standard output.
`-T'
Tell `indent' the name of typenames.
`-tsN'
`--tab-sizeN'
Set tab size to N spaces.
`-v'
`--verbose'
Enable verbose mode.
`-version'
Output the version number of `indent'.
.ad
.fi
.SH «OPTIONS CROSS-REFERENCE"
find the corresponding short option.
.in +5
.nf
.na
.in -5
.ad
.fi
.SH «RETURN VALUE"
.SH FILES
.br
.nf
.\» set tabstop to longest possible filename, plus a wee bit.ta \w'/usr/lib/perl/getopts.pl `u
\fI$HOME/.indent.pro\fR holds default options for indent..SH AUTHOR
.SH HISTORY