Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
indent(1)
Edit
PageHistory
Diff
Info
LikePages
INDENT !!!INDENT NAME SYNOPSIS DESCRIPTION OPTIONS INVOKING INDENT BACKUP FILES COMMON STYLES BLANK LINES --blank-lines-after-declarations --blank-lines-after-procedures COMMENTS STATEMENTS DECLARATIONS INDENTATION BREAKING LONG LINES DISABLING FORMATTING MISCELLANEOUS OPTIONS BUGS COPYRIGHT Options Cross Key RETURN VALUE FILES AUTHORS HISTORY COPYING ---- !!NAME indent - changes the appearance of a C program by inserting or deleting whitespace. !!SYNOPSIS __indent__ [[options] [[input-files] __indent__ [[options] [[single-input-file] [[-o output-file] __indent__ --version !!DESCRIPTION This man page is generated from the file ''indent.texinfo''. This is Edition of ''indent__ Manual __ The __indent__ program can be used to make code easier to read. It can also convert from one style of writing C to another. __indent__ understands a substantial amount about the syntax of C, but it also attempts to cope with incomplete and misformed syntax. In version 1.2 and more recent versions, the GNU style of indenting is the default. !!OPTIONS __-bad__, __--blank-lines-after-declarations__ Force blank lines after the declarations. See __BLANK LINES__. __-bap__, __--blank-lines-after-procedures__ Force blank lines after procedure bodies. See __BLANK LINES__. __-bbb__, __--blank-lines-before-block-comments__ Force blank lines before block comments. See __BLANK LINES__. __-bbo__, __--break-before-boolean-operator__ Prefer to break long lines before boolean operators. See __BREAKING LONG LINES__. __-bc__, __--blank-lines-after-commas__ Force newline after comma in declaration. See __DECLARATIONS__. __-bl__, __--braces-after-if-line__ Put braces on line after __if__, etc. See __STATEMENTS__. __-bli__''n'', __--brace-indent__''n'' Indent braces ''n'' spaces. See __STATEMENTS__. __-bls__, __--braces-after-struct-decl-line__ Put braces on the line after __struct__ declaration lines. See __DECLARATIONS__. __-br__, __--braces-on-if-line__ Put braces on line with __if__, etc. See __STATEMENTS__. __-brs__, __--braces-on-struct-decl-line__ Put braces on __struct__ declaration line. See __DECLARATIONS__. __-bs__, __--Bill-Shannon__, __--blank-before-sizeof__ Put a space between __sizeof__ and its argument. See __STATEMENTS__. __-c__''n'', __--comment-indentation__''n'' Put comments to the right of code in column ''n''. See __COMMENTS__. __-cbi__''n'', __--case-brace-indentation__''n'' Indent braces after a case label N spaces. See __STATEMENTS__. __-cd__''n'', __--declaration-comment-column__''n'' Put comments to the right of the declarations in column ''n''. See __COMMENTS__. __-cdb__, __--comment-delimiters-on-blank-lines__ Put comment delimiters on blank lines. See __COMMENTS__. __-cdw__, __--cuddle-do-while__ Cuddle while of __do {} while;__ and preceeding }. See __COMMENTS__. __-ce__, __--cuddle-else__ Cuddle else and preceeding }. See __COMMENTS__. __-ci__''n'', __--continuation-indentation__''n'' Continuation indent of ''n'' spaces. See __STATEMENTS__. __-cli__''n'', __--case-indentation__''n'' Case label indent of ''n'' spaces. See __STATEMENTS__. __-cp__''n'', __--else-endif-column__''n'' Put comments to the right of __#else__ and __#endif__ statements in column ''n''. See __COMMENTS__. __-cs__, __--space-after-cast__ Put a space after a cast operator. See __STATEMENTS__. __-d__''n'', __--line-comments-indentation__''n'' Set indentation of comments not to the right of code to ''n'' spaces. See __COMMENTS__. __-bfda__, __--break-function-decl-args__ Align all arguments in a declaration with opening paren. See __DECLARATIONS__. __-di__''n'', __--declaration-indentation__''n'' Put variables in column ''n''. See __DECLARATIONS__. __-fc1__, __--format-first-column-comments__ Format comments in the first column. See __COMMENTS__. __-fca__, __--format-all-comments__ Do not disable all formatting of comments. See __COMMENTS__. __-gnu__, __--gnu-style__ Use GNU coding style. This is the default. See __COMMON STYLES__. __-hnl__, __--honour-newlines__ Prefer to break long lines at the position of newlines in the input. See __BREAKING LONG LINES__. __-i__''n'', __--indent-level__''n'' Set indentation level to ''n'' spaces. See __INDENTATION__. __-ip__''n'', __--parameter-indentation__''n'' Indent parameter types in old-style function definitions by ''n'' spaces. See __INDENTATION__. __-kr__, __--k-and-r-style__ Use Kernighan See __COMMON STYLES__. __-l__''n'', __--line-length__''n'' Set maximum line length for non-comment lines to ''n''. See __BREAKING LONG LINES__. __-lc__''n'', __--comment-line-length__''n'' Set maximum line length for comment formatting to ''n''. See __COMMENTS__. __-lp__, __--continue-at-parentheses__ Line up continued lines at parentheses. See __INDENTATION__. __-lps__, __--leave-preprocessor-space__ Leave space between # and preprocessor directive. See __INDENTATION__. __-nbad__, __--no-blank-lines-after-declarations__ Do not force blank lines after declarations. See __BLANK LINES__. __-nbap__, __--no-blank-lines-after-procedures__ Do not force blank lines after procedure bodies. See __BLANK LINES__. __-nbbo__, __--break-after-boolean-operator__ Do not prefer to break long lines before boolean operators. See __BREAKING LONG LINES__. __-nbc__, __--no-blank-lines-after-commas__ Do not force newlines after commas in declarations. See __DECLARATIONS__. __-nbfda__, __--dont-break-function-decl-args__ Dont put each argument in a function declaration on a seperate line. See __DECLARATIONS__. __-ncdb__, __--no-comment-delimiters-on-blank-lines__ Do not put comment delimiters on blank lines. See __COMMENTS__. __-ncdw__, __--dont-cuddle-do-while__ Do not cuddle __}__ and the __while__ of a __do {} while;__. See __STATEMENTS__. __-nce__, __--dont-cuddle-else__ Do not cuddle __}__ and __else__. See __STATEMENTS__. __-ncs__, __--no-space-after-casts__ Do not put a space after cast operators. See __STATEMENTS__. __-nfc1__, __--dont-format-first-column-comments__ Do not format comments in the first column as normal. See __COMMENTS__. __-nfca__, __--dont-format-comments__ Do not format any comments. See __COMMENTS__. __-nhnl__, __--ignore-newlines__ Do not prefer to break long lines at the position of newlines in the input. See __BREAKING LONG LINES__. __-nip__, __--no-parameter-indentation__ Zero width indentation for parameters. See __INDENTATION__. __-nlp__, __--dont-line-up-parentheses__ Do not line up parentheses. See __STATEMENTS__. __-npcs__, __--no-space-after-function-call-names__ Do not put space after the function in function calls. See __STATEMENTS__. __-nprs__, __--no-space-after-parentheses__ Do not put a space after every ( and before every ). See __STATEMENTS__. __-npsl__, __--dont-break-procedure-type__ Put the type of a procedure on the same line as its name. See __DECLARATIONS__. __-nsaf__, __--no-space-after-for__ Do not put a space after every __for__. See __STATEMENTS__. __-nsai__, __--no-space-after-if__ Do not put a space after every __if__. See __STATEMENTS__. __-nsaw__, __--no-space-after-while__ Do not put a space after every __while__. See __STATEMENTS__. __-nsc__, __--dont-star-comments__ Do not put the * character at the left of comments. See __COMMENTS__. __-nsob__, __--leave-optional-blank-lines__ Do not swallow optional blank lines. See __BLANK LINES__. __-nss__, __--dont-space-special-semicolon__ Do not force a space before the semicolon after certain statements. Disables -ss. See __STATEMENTS__. __-nut__, __--no-tabs__ Use spaces instead of tabs. See __INDENTATION__. __-nv__, __--no-verbosity__ Disable verbose mode. See __MISCELLANEOUS OPTIONS__. __-orig__, __--original__ Use the original Berkeley coding style. See __COMMON STYLES__. __-npro__, __--ignore-profile__ Do not read .indent.pro files. See __INVOKING INDENT__. __-pcs__, __--space-after-procedure-calls__ Insert a space between the name of the procedure being called and the (. See __STATEMENTS__. __-pi__''n'', __--paren-indentation__''n'' Specify the extra indentation per open parentheses ( when a statement is broken.See __STATEMENTS__. __-pmt__, __--preserve-mtime__ Preserve access and modification times on output files.See __MISCELLANEOUS OPTIONS__. __-prs__, __--space-after-parentheses__ Put a space after every ( and before every ). See __STATEMENTS__. __-psl__, __--procnames-start-lines__ Put the type of a procedure on the line before its name. See __DECLARATIONS__. __-saf__, __--space-after-for__ Put a space after each __for__. See __STATEMENTS__. __-sai__, __--space-after-if__ Put a space after each __if__. See __STATEMENTS__. __-saw__, __--space-after-while__ Put a space after each __while__. See __STATEMENTS__. __-sbi__''n'', __--struct-brace-indentation__''n'' Indent braces of a struct, union or enum N spaces. See __STATEMENTS__. __-sc__, __--start-left-side-of-comments__ Put the * character at the left of comments. See __COMMENTS__. __-sob__, __--swallow-optional-blank-lines__ Swallow optional blank lines. See __BLANK LINES__. __-ss__, __--space-special-semicolon__ On one-line __for__ and __while__ statments, force a blank before the semicolon. See __STATEMENTS__. __-st__, __--standard-output__ Write to standard output. See __INVOKING INDENT__. __-T__ Tell __indent__ the name of typenames. See __DECLARATIONS__. __-ts__''n'', __--tab-size__''n'' Set tab size to ''n'' spaces. See __INDENTATION__. __-ut__, __--use-tabs__ Use tabs. This is the default. See __INDENTATION__. __-v__, __--verbose__ Enable verbose mode. See __MISCELLANEOUS OPTIONS__. __-version__ Output the version number of __indent__. See __MISCELLANEOUS OPTIONS__. !!INVOKING INDENT As of version 1.3, the format of the __indent__ command is: indent [[''options''] [[''input-files''] indent [[''options''] [[''single-input-file''] [[-o ''output-file''] This format is different from earlier versions and other versions of __indent__. In the first form, one or more input files are specified. __indent__ makes a backup copy of each file, and the original file is replaced with its indented version. See __BACKUP FILES__, for an explanation of how backups are made. In the second form, only one input file is specified. In this case, or when the standard input is used, you may specify an output file after the -o option. To cause __indent__ to write to standard output, use the -st option. This is only allowed when there is only one input file, or when the standard input is used. If no input files are named, the standard input is read for input. Also, if a filename named - is specified, then the standard input is read. As an example, each of the following commands will input the program slithy_toves.c and write its indented text to slithy_toves.out: indent slithy_toves.c -o slithy_toves.out indent -st slithy_toves.c Most other options to __indent__ control how programs are formatted. As of version 1.2, __indent__ also recognizes a long name for each option name. Long options are prefixed by either -- or +. [[ + is being superseded by -- to maintain consistency with the POSIX standard.] In most of this document, the traditional, short names are used for the sake of brevity. See __OPTION SUMMARY__, for a list of options, including both long and short names. Here is another example: indent -br test/metabolism.c -l85 This will indent the program test/metabolism.c using the -br and -l85 options, write the output back to test/metabolism.c, and write the original contents of test/metabolism.c to a backup file in the directory test. Equivalent invocations using long option names for this example would be: indent --braces-on-if-line --line-length185 test/metabolism.c indent +braces-on-if-line +line-length185 test/metabolism.c If you find that you often use __indent__ with the same options, you may put those options into a file named .indent.pro. __indent__ will first look for .indent.pro in the current directory and use that if found. Otherwise, __indent__ will search your home directory for .indent.pro and use that file if it is found. This behaviour is different from that of other versions of __indent__, which load both files if they both exist. The format of .indent.pro is simply a list of options, just as they would appear on the command line, separated by white space (tabs, spaces, and newlines). Options in .indent.pro may be surrounded by C or C++ comments, in which case they are ignored. Command line switches are handled ''after'' processing .indent.pro. Options specified later override arguments specified earlier, with one exception: Explicitly specified options always override background options (See __COMMON STYLES__). You can prevent __indent__ from reading an .indent.pro file by specifying the -npro option. !!BACKUP FILES As of version 1.3, GNU __indent__ makes GNU-style backup files, the same way GNU Emacs does. This means that either ''simple'' or ''numbered'' backup filenames may be made. Simple backup file names are generated by appending a suffix to the original file name. The default for this suffix is the one-character string ~ (tilde). Thus, the backup file for python.c would be python.c~. Instead of the default, you may specify any string as a suffix by setting the environment variable __SIMPLE_BACKUP_SUFFIX__ to your preferred suffix. Numbered backup versions of a file momeraths.c look like momeraths.c.~23~, where 23 is the version of this particular backup. When making a numbered backup of the file src/momeraths.c, the backup file will be named src/momeraths.c.~''V''~, where ''V'' is one greater than the highest version currently existing in the directory src. The environment variable __VERSION_WIDTH__ controls the number of digits, using left zero padding when necessary. For instance, setting this variable to __ The type of backup file made is controlled by the value of the 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. Other versions of __indent__ use the suffix .BAK in naming backup files. This behaviour can be emulated by setting __SIMPLE_BACKUP_SUFFIX__ to .BAK. Note also that other versions of __indent__ make backups in the current directory, rather than in the directory of the source file as GNU __indent__ now does. !!COMMON STYLES There are several common styles of C code, including the GNU style, the Kernighan background'' option, which specifies a set of values for all other options. However, explicitly specified options always override options implied by a background option. As of version 1.2, the default style of GNU __indent__ is the GNU style. Thus, it is no longer necessary to specify the option -gnu to obtain this format, although doing so will not cause an error. Option settings which correspond to the GNU style are: -nbad -bap -nbc -bbo -bl -bli2 -bls -ncdb -nce -cp1 -cs -di2 -ndj -nfc1 -nfca -hnl -i2 -ip5 -lp -pcs -nprs -psl -saf -sai -saw -nsc -nsob 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 The Kernighan -nbad -bap -bbo -nbc -br -brs -c33 -cd33 -ncdb -ce -ci4 -cli0 -cp33 -cs -d0 -di1 -nfc1 -nfca -hnl -i4 -ip0 -l75 -lp -npcs -nprs -npsl -saf -sai -saw -nsc -nsob -nss Kernighan indent__ has arbitrarily chosen column 33. The style of the original Berkeley __indent__ may be obtained by specifying -orig (or by specifying --original, using the long option name). This style is equivalent to the following settings: -nbad -nbap -bbo -bc -br -brs -c33 -cd33 -cdb -ce -ci4 -cli0 -cp33 -di16 -fc1 -fca -hnl -i4 -ip4 -l75 -lp -npcs -nprs -psl -saf -sai -saw -sc -nsob -nss -ts8 !!BLANK LINES Various programming styles use blank lines in different places. __indent__ has a number of options to insert or delete blank lines in specific places. The -bad option causes __indent__ to force a blank line after every block of declarations. The -nbad option causes __indent__ not to force such blank lines. The -bap option forces a blank line after every procedure body. The -nbap option forces no such blank line. The -bbb option forces a blank line before every boxed comment (See __COMMENTS__.) The -nbbb option does not force such blank lines. The -sob option causes __indent__ to swallow optional blank lines (that is, any optional blank lines present in the input will be removed from the output). If the -nsob is specified, any blank lines present in the input file will be copied to the output file. !!--blank-lines-after-declarations The -bad option forces a blank line after every block of declarations. The -nbad option does not add any such blank lines. For example, given the input char *foo; char *bar; /* This separates blocks of declarations. */ int baz; __indent -bad__ produces char *foo; char *bar; /* This separates blocks of declarations. */ int baz; and __indent -nbad__ produces char *foo; char *bar; /* This separates blocks of declarations. */ int baz; !!--blank-lines-after-procedures The -bap option forces a blank line after every procedure body. For example, given the input int foo () { puts( __indent -bap__ produces int foo () { puts ( and __indent -nbap__ produces int foo () { puts ( No blank line will be added after the procedure __foo__. !!COMMENTS __indent__ formats both C and C++ comments. C comments are begun with /*, terminated with */ and may contain newline characters. C++ comments begin with the delimiter // and end at the newline. __indent__ handles comments differently depending upon their context. __indent__ attempts to distinguish between comments which follow statements, comments which follow declarations, comments following preprocessor directives, and comments which are not preceded by code of any sort, i.e., they begin the text of the line (although not neccessarily in column 1). __indent__ further distinguishes between comments found outside of procedures and aggregates, and those found within them. In particular, comments beginning a line found within a procedure will be indented to the column at which code is currently indented. The exception to this a comment beginning in the leftmost column; such a comment is output at that column. __indent__ attempts to leave ''boxed comments'' unmodified. The general idea of such a comment is that it is enclosed in a rectangle or box of stars or dashes to visually set it apart. More precisely, boxed comments are defined as those in which the initial /* is followed immediately by the character *, =, _, or -, or those in which the beginning comment delimiter (/*) is on a line by itself, and the following line begins with a * in the same column as the star of the opening delimiter. Examples of boxed comments are: /********************** * Comment in a box!! * **********************/ /* * A different kind of scent, * for a different kind of comment. */ __indent__ attempts to leave boxed comments exactly as they are found in the source file. Thus the indentation of the comment is unchanged, and its length is not checked in any way. The only alteration made is that an embedded tab character may be converted into the appropriate number of spaces. If the -bbb option is specified, all such boxed comments will be preceded by a blank line, unless such a comment is preceded by code. Comments which are not boxed comments may be formatted, which means that the line is broken to fit within a right margin and left-filled with whitespace. Single newlines are equivalent to a space, but blank lines (two or more newlines in a row) are taken to mean a paragraph break. Formatting of comments which begin after the first column is enabled with the -fca option. To format those beginning in column one, specify -fc1. Such formatting is disabled by default. The right margin for formatting defaults to 78, but may be changed with the -lc option. If the margin specified does not allow the comment to be printed, the margin will be automatically extended for the duration of that comment. The margin is not respected if the comment is not being formatted. If the comment begins a line (i.e., there is no program text to its left), it will be indented to the column it was found in unless the comment is within a block of code. In that case, such a comment will be aligned with the indented code of that block (unless the comment began in the first column). This alignment may be affected by the -d option, which specifies an amount by which such comments are moved to the ''left'', or unindented. For example, -d2 places comments two spaces to the left of code. By default, comments are aligned with code, unless they begin in the first column, in which case they are left there by default --- to get them aligned with the code, specify -fc1. Comments to the right of code will appear by default in column 33. This may be changed with one of three options. -c will specify the column for comments following code, -cd specifies the column for comments following declarations, and -cp specifies the column for comments following preprocessor directives __#else__ and __#endif__. If the code to the left of the comment exceeds the beginning column, the comment column will be extended to the next tabstop column past the end of the code, or in the case of preprocessor directives, to one space past the end of the directive. This extension lasts only for the output of that particular comment. The -cdb option places the comment delimiters on blank lines. Thus, a single line comment like __/* Loving hug */__ can be transformed into: /* Loving hug */ Stars can be placed at the beginning of multi-line comments with the -sc option. Thus, the single-line comment above can be transformed (with -cdb -sc) into: /* * Loving hug */ !!STATEMENTS The -br or -bl option specifies how to format braces. The -br option formats statement braces like this: if (x The -bl option formats them like this: if (x If you use the -bl option, you may also want to specify the -bli option. This option specifies the number of spaces by which braces are indented. -bli2, the default, gives the result shown above. -bli0 results in the following: if (x If you are using the -br option, you probably want to also use the -ce option. This causes the __else__ in an if-then-else construct to cuddle up to the immediately preceding }. For example, with -br -ce you get the following: if (x With -br -nce that code would appear as if (x This causes the __while__ in a do-while loop to cuddle up to the immediately preceding }. For example, with -cdw you get the following: do { x--; } while (x); With -ncdw that code would appear as do { x--; } while (x); The -cli option specifies the number of spaces that case labels should be indented to the right of the containing __switch__ statement. The default gives code like: switch (i) { case 0: break; case 1: { ++i; } default: break; } Using the -cli2 that would become: switch (i) { case 0: break; case 1: { ++i; } default: break; } The indentation of the braces below a case statement can be controlled with the -cbi''n'' option. For example, using -cli2 -cbi0 results in: switch (i) { case 0: break; case 1: { ++i; } default: break; } If a semicolon is on the same line as a __for__ or __while__ statement, the -ss option will cause a space to be placed before the semicolon. This emphasizes the semicolon, making it clear that the body of the __for__ or __while__ statement is an empty statement. -nss disables this feature. The -pcs option causes a space to be placed between the name of the procedure being called and the ( (for example, __puts (__. The -npcs option would give __puts(__). If the -cs option is specified, __indent__ puts a space after a cast operator. The -bs option ensures that there is a space between the keyword __sizeof__ and its argument. In some versions, this is known as the Bill_Shannon option. The -saf option forces a space between an __for__ and the following parenthesis. This is the default. The -sai option forces a space between an __if__ and the following parenthesis. This is the default. The -saw option forces a space between an __while__ and the following parenthesis. This is the default. The -prs option causes all parentheses to be seperated with a space from the what is between them. For example, using -prs results in code like: while ( ( e_code - s_code ) !!DECLARATIONS By default __indent__ will line up identifiers, in the column specified by the -di option. For example, -di16 makes things look like: int foo; char *bar; Using a small value (such as one or two) for the -di option can be used to cause the identifiers to be placed in the first available position; for example: int foo; char *bar; The value given to the -di option will still affect variables which are put on separate lines from their types, for example -di2 will lead to: int foo; If the -bc option is specified, a newline is forced after each comma in a declaration. For example, int a, b, c; With the -nbc option this would look like int a, b, c; The -bfda option causes a newline to be forced after the comma separating the arguments of a function declaration. The arguments will appear at the current indention level matching the opening paren. This is particularly helpful for functions with long argument lists. For example, void foo (int arg1, char arg2, int *arg3, long arg4, char arg5); With the -bfda option this would look like void foo (int arg1, char arg2, int *arg3, long arg4, char arg5); The -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 __etags__ program to work correctly, as well as some of the __c-mode__ functions of Emacs. You must use the -T option to tell __indent__ the name of all the typenames in your program that are defined by __typedef__. -T can be specified more than once, and all names specified are used. For example, if your program contains typedef unsigned long CODE_ADDR; typedef enum {red, blue, green} COLOR; you would use the options -T CODE_ADDR -T COLOR. The -brs or -bls option specifies how to format braces in struct declarations. The -brs option formats braces like this: struct foo { int x; }; The -bls option formats them like this: struct foo { int x; }; !!INDENTATION 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 __if__ or __for__ is encountered, the indentation level is increased by the value specified by the -i option. For example, use -i8 to specify an eight character indentation for each level. When a statement is broken across two lines, the second line is indented by a number of additional spaces specified by the -ci option. -ci defaults to 0. However, if the -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 [[ and applies to { when it occurs in initialization lists. For example, a piece of continued code might look like this with -nlp -ci3 in effect: p1 = first_procedure (second_procedure (p2, p3), third_procedure (p4, p5)); With -lp in effect the code looks somewhat clearer: p1 = first_procedure (second_procedure (p2, p3), third_procedure (p4, p5)); When a statement is broken in between two or more paren pairs (...), each extra pair causes the indentation level extra indentation: if ((((i The option -ip''N'' can be used to set the extra offset per paren. For instance, -ip0 would format the above as: if ((((i __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 -ts option. Tabs are treated as the equivalent number of spaces. The indentation of type declarations in old-style function definitions is controlled by the -ip parameter. This is a numeric parameter specifying how many spaces to indent type declarations. For example, the default -ip5 makes definitions look like this: char * create_world (x, y, scale) int x; int y; float scale; { . . . } For compatibility with other versions of indent, the option -nip is provided, which is equivalent to -ip0. ANSI C allows white space to be placed on preprocessor command lines between the character # and the command name. By default, __indent__ removes this space, but specifying the -lps option directs __indent__ to leave this space unmodified. !!BREAKING LONG LINES With the option -l''n'', or --line-length''n'', it is possible to specify the maximum length of a line of C code, not including possible comments that follow it. When lines become longer then the specified line length, GNU __indent__ tries to break the line at a logical place. This is new as of version 2.1 however and not very intelligent or flexible yet. Currently there are two options that allows one to interfere with the algorithm that determines where to break a line. The -bbo option causes GNU __indent__ to prefer to break long lines before the boolean operators ____ and __||__. The -nbbo option causes GNU __indent__ not have that preference. For example, the default option -bbo (together with --line-length60 and --ignore-newlines) makes code look like this: if (mask Using the option -nbbo will make it look like this: if (mask The default -hnl, however, honours newlines in the input file by giving them the highest possible priority to break lines at. For example, when the input file looks like this: if (mask then using the option -hnl, or --honour-newlines, together with the previously mentioned -nbbo and --line-length60, will cause the output not to be what is given in the last example but instead will prefer to break at the positions where the code was broken in the input file: if (mask The idea behind this option is that lines which are too long, but are already broken up, will not be touched by GNU __indent__. Really messy code should be run through __indent__ at least once using the --ignore-newlines option though. !!DISABLING FORMATTING Formatting of C code may be disabled for portions of a program by embedding special ''control comments'' in the program. To turn off formatting for a section of a program, place the disabling control comment __/* *INDENT-OFF* */__ on a line by itself just before that section. Program text scanned after this control comment is output precisely as input with no modifications until the corresponding enabling comment is scanned on a line by itself. The disabling control comment is __/* *INDENT-ON* */__, and any text following the comment on the line is also output unformatted. Formatting begins again with the input line following the enabling control comment. More precisely, __indent__ does not attempt to verify the closing delimiter (__*/__) for these C comments, and any whitespace on the line is totally transparent. These control comments also function in their C++ formats, namely __// *INDENT-OFF*__ and __// *INDENT-ON*__. It should be noted that the internal state of __indent__ remains unchanged over the course of the unformatted section. Thus, for example, turning off formatting in the middle of a function and continuing it after the end of the function may lead to bizarre results. It is therefore wise to be somewhat modular in selecting code to be left unformatted. As a historical note, some earlier versions of __indent__ produced error messages beginning with __*INDENT**__. These versions of __indent__ were written to ignore any input text lines which began with such error messages. I have removed this incestuous feature from GNU __indent__. !!MISCELLANEOUS OPTIONS To find out what version of __indent__ you have, use the command __indent -version__. This will report the version number of __indent__, without doing any of the normal processing. The -v option can be used to turn on verbose mode. When in verbose mode, __indent__ reports when it splits one line of input into two more more lines of output, and gives some size statistics at completion. The -pmt option causes __indent__ to preserve the access and modification times on the output files. Using this option has the advantage that running indent on all source and header files in a project wont cause __make__ to rebuild all targets. This option is only available on Operating Systems that have the POSIX __utime(2)__ function. !!BUGS Please report any bugs to bug-indent@gnu.org. When __indent__ is run twice on a file, with the same profile, it should ''never'' change that file the second time. With the current design of __indent__, this can not be guaranteed, however, and it has not been extensively tested. __indent__ does not understand C. In some cases this leads to the inability to join lines. The result is that running a file through __indent__ is ''irreversible'', even if the used input file was the result of running __indent__ with a given profile (.indent.pro). While an attempt was made to get __indent__ working for C++, it will not do a good job on any C++ source except the very simple. __indent__ does not look at the given --line-length option when writing comments to the output file. This results often in comments being put far to the right. In order to prohibit __indent__ from joining a broken line that has a comment at the end, make sure that the comments start on the first line of the break. __indent__ does not count lines and comments (see the -v option) when __indent__ is turned off with __/* *INDENT-OFF* */__. Comments of the form __/*UPPERCASE*/__ are not treated as comment but as an identifier, causing them to be joined with the next line. This renders comments of this type useless, unless they are embedded in the code to begin with. !!COPYRIGHT The following copyright notice applies to the __indent__ program. The copyright and copying permissions for this manual appear near the beginning of indent.texinfo and indent.info, and near the end of indent.1. Copyright (c) 2001 David Ingamells. Copyright (c) 1999 Carlo Wood. Copyright (c) 1995, 1996 Joseph Arceneaux. Copyright (c) 1989, 1992, 1993, 1994, 1995, 1996 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. !!Options Cross Key Here is a list of options alphabetized by long option, to help you find the corresponding short option. --blank-lines-after-commas -bc --blank-lines-after-declarations -bad --blank-lines-after-procedures -bap --blank-lines-before-block-comments -bbb --braces-after-if-line -bl --brace-indent -bli --braces-after-struct-decl-line -bls --braces-on-if-line -br --braces-on-struct-decl-line -brs --break-after-boolean-operator -nbbo --break-before-boolean-operator -bbo --break-function-decl-args -bfda --case-indentation -cli''n ''--case-brace-indentation -cbi''n ''--comment-delimiters-on-blank-lines -cdb --comment-indentation -c''n ''--continuation-indentation -ci''n ''--continue-at-parentheses -lp --cuddle-do-while -cdw --cuddle-else -ce --declaration-comment-column -cd''n ''--declaration-indentation -di''n ''--dont-break-function-decl-args -nbfda --dont-break-procedure-type -npsl --dont-cuddle-do-while -ncdw --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''n ''--format-all-comments -fca --format-first-column-comments -fc1 --gnu-style -gnu --honour-newlines -hnl --ignore-newlines -nhnl --ignore-profile -npro --indent-level -i''n ''--k-and-r-style -kr --leave-optional-blank-lines -nsob --leave-preprocessor-space -lps --line-comments-indentation -d''n ''--line-length -l''n ''--no-blank-lines-after-commas -nbc --no-blank-lines-after-declarations -nbad --no-blank-lines-after-procedures -nbap --no-blank-lines-before-block-comments -nbbb --no-comment-delimiters-on-blank-lines -ncdb --no-space-after-casts -ncs --no-parameter-indentation -nip --no-space-after-for -nsaf --no-space-after-function-call-names -npcs --no-space-after-if -nsai --no-space-after-parentheses -nprs --no-space-after-while -nsaw --no-tabs -nut --no-verbosity -nv --original -orig --parameter-indentation -ip''n ''--paren-indentation -pi''n ''--preserve-mtime -pmt --procnames-start-lines -psl --space-after-cast -cs --space-after-for -saf --space-after-if -sai --space-after-parentheses -prs --space-after-procedure-calls -pcs --space-after-while -saw --space-special-semicolon -ss --standard-output -st --start-left-side-of-comments -sc --struct-brace-indentation -sbi''n ''--swallow-optional-blank-lines -sob --tab-size -ts''n ''--use-tabs -ut --verbose -v !!RETURN VALUE Unknown !!FILES ''$HOME/.indent.pro'' holds default options for indent. !!AUTHORS Carlo Wood Joseph Arceneaux Jim Kingdon David Ingamells !!HISTORY Derived from the UCB program !!COPYING Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc. Copyright (C) 1995, 1996 Joseph Arceneaux. Copyright (C) 1999 Carlo Wood. Copyright (C) 2001 David Ingamells. 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. ----
3 pages link to
indent(1)
:
perlfaq3(1)
Man1i
orbit-idl(1)
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
