home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / pd / programming / c / indent / indent.info (.txt) < prev    next >
GNU Info File  |  1993-02-11  |  39KB  |  925 lines
  1. This is Info file indent.info, produced by Makeinfo-1.51 from the input
  2. file ./indent.texinfo.
  3.    Copyright (C) 1989, 1992, 1993 Free Software Foundation, Inc.
  4.    This is Edition 1.00, Febrary 1992, of `The `indent' Manual', for
  5. Indent Version 1.7
  6.    Permission is granted to make and distribute verbatim copies of this
  7. manual provided the copyright notice and this permission notice are
  8. preserved on all copies.
  9. File: indent.info,  Node: Top,  Next: Indent Program,  Prev: (dir),  Up: (dir)
  10. `indent':  Indent and Format C Program Source
  11. *********************************************
  12.    The `indent' program changes the appearance of a C program by
  13. inserting or deleting whitespace.
  14.    This is Edition 1.00, Febrary 1993, of `The `indent' Manual', for
  15. Indent Version 1.7
  16. * Menu:
  17. * Indent Program::              The `indent' Program
  18. * Option Summary::              Option Summary
  19. * Index::                       Index
  20. File: indent.info,  Node: Indent Program,  Next: Option Summary,  Prev: Top,  Up: Top
  21. The `indent' Program
  22. ********************
  23.    The `indent' program can be used to make code easier to read.  It
  24. can also convert from one style of writing C to another.
  25.    `indent' understands a substantial amount about the syntax of C, but
  26. it also attempts to cope with incomplete and misformed syntax.
  27.    In version 1.2 and more recent versions, the GNU style of indenting
  28. is the default.
  29. * Menu:
  30. * Invoking indent::             Invoking `indent'
  31. * Backup files::                Backup Files
  32. * Common styles::               Common styles
  33. * Blank lines::                 Blank lines
  34. * Comments::                    Comments
  35. * Statements::                  Statements
  36. * Declarations::                Declarations
  37. * Indentation::                 Indentation
  38. * Miscellaneous options::       Miscellaneous options
  39. * Bugs::                     Bugs
  40. * Copyright::                   Copyright
  41. File: indent.info,  Node: Invoking indent,  Next: Backup files,  Up: Indent Program
  42. Invoking `indent'
  43. =================
  44.    As of version 1.3, the format of the `indent' command is:
  45.      indent [OPTIONS] [INPUT-FILES]
  46.      
  47.      indent [OPTIONS] [SINGLE-INPUT-FILE] [-o OUTPUT-FILE]
  48.    This format is different from earlier versions and other versions of
  49. `indent'.
  50.    In the first form, one or more input files are specified.  `indent'
  51. makes a backup copy of each file, and the original file is replaced with
  52. its indented version.  *Note Backup files::, for an explanation of how
  53. backups are made.
  54.    In the second form, only one input file is specified.  In this case,
  55. or when the standard input is used, you may specify an output file after
  56. the `-o' option.
  57.    To cause `indent' to write to standard output, use the `-st' option.
  58. This is only allowed when there is only one input file, or when the
  59. standard input is used.
  60.    If no input files are named, the standard input is read for input.
  61. Also, if a filename named `-' is specified, then the standard input is
  62. read.
  63.    As an example, each of the following commands will input the program
  64. `slithy_toves.c' and write its indented text to `slithy_toves.out':
  65.      indent slithy_toves.c -o slithy_toves.out
  66.      
  67.      indent -st slithy_toves.c > slithy_toves.out
  68.      
  69.      cat slithy_toves.c | indent -o slithy_toves.out
  70.    Most other options to `indent' control how programs are formatted.
  71. As of version 1.2, `indent' also recognizes a long name for each option
  72. name.  Long options are prefixed by either `--' or `+'.(1) In most of
  73. this document, the traditional, short names are used for the sake of
  74. brevity.  *Note Option Summary::, for a list of options, including both
  75. long and short names.
  76.    Here is another example:
  77.      indent -br test/metabolism.c -l85
  78.    This will indent the program `test/metabolism.c' using the `-br' and
  79. `-l85' options, write the output back to `test/metabolism.c', and write
  80. the original contents of `test/metabolism.c' to a backup file in the
  81. directory `test'.
  82.    Equivalent invocations using long option names for this example would
  83.      indent --braces-on-if-line --line-length185 test/metabolism.c
  84.      
  85.      indent +braces-on-if-line +line-length185 test/metabolism.c
  86.    If you find that you often use `indent' with the same options, you
  87. may put those options into a file called `.indent.pro'.  `indent' will
  88. first look for `.indent.pro' in the current directory and use that if
  89. found.  Otherwise, `indent' will search your home directory for
  90. `.indent.pro' and use that file if it is found.  This behaviour is
  91. different from that of other versions of `indent', which load both
  92. files if they both exist.
  93.    Command line switches are handled *after* processing `.indent.pro'.
  94. Options specified later override arguments specified earlier, with one
  95. exception: Explicitly specified options always override background
  96. options (*note Common styles::.).  You can prevent `indent' from
  97. reading an `.indent.pro' file by specifying the `-npro' option.
  98.    ---------- Footnotes ----------
  99.    (1)   `+' is being superseded by `--' to maintain consistency with
  100. the POSIX standard.
  101. File: indent.info,  Node: Backup files,  Next: Common styles,  Prev: Invoking indent,  Up: Indent Program
  102. Backup Files
  103. ============
  104.    As of version 1.3, GNU `indent' makes GNU-style backup files, the
  105. same way GNU Emacs does.  This means that either "simple" or "numbered"
  106. backup filenames may be made.
  107.    Simple backup file names are generated by appending a suffix to the
  108. original file name.  The default for the this suffix is the
  109. one-character string `~' (tilde).  Thus, the backup file for `python.c'
  110. would be `python.c~'.
  111.    Instead of the default, you may specify any string as a suffix by
  112. setting the environment variable `SIMPLE_BACKUP_SUFFIX' to your
  113. preferred suffix.
  114.    Numbered backup versions of a file `momewraths' look like
  115. `momewraths.c.~23~', where 23 is the version of this particular backup.
  116. When making a numbered backup of the file `src/momewrath.c', the
  117. backup file will be named `src/momewrath.c.~V~', where V is one greater
  118. than the highest version currently existing in the directory `src'.
  119.    The type of backup file made is controlled by the value of the
  120. environment variable `VERSION_CONTROL'.  If it is the string `simple',
  121. then only simple backups will be made.  If its value is the string
  122. `numbered', then numbered backups will be made.  If its value is
  123. `numbered-existing', then numbered backups will be made if there
  124. *already exist* numbered backups for the file being indented;
  125. otherwise, a simple backup is made.  If `VERSION_CONTROL' is not set,
  126. then `indent' assumes the behaviour of `numbered-existing'.
  127.    Other versions of `indent' use the suffix `.BAK' in naming backup
  128. files.  This behaviour can be emulated by setting
  129. `SIMPLE_BACKUP_SUFFIX' to `.BAK'.
  130.    Note also that other versions of `indent' make backups in the
  131. current directory, rather than in the directory of the source file as
  132. GNU `indent' now does.
  133. File: indent.info,  Node: Common styles,  Next: Blank lines,  Prev: Backup files,  Up: Indent Program
  134. Common styles
  135. =============
  136.    There are several common styles of C code, including the GNU style,
  137. the Kernighan & Ritchie style, and the original Berkeley style.  A
  138. style may be selected with a single "background" option, which
  139. specifies a set of values for all other options.  However, explicitly
  140. specified options always override options implied by a background
  141. option.
  142.    As of version 1.2, the default style of GNU `indent' is the GNU
  143. style.  Thus, it is no longer neccessary to specify the option `-gnu'
  144. to obtain this format, although doing so will not cause an error.
  145. Option settings which correspond to the GNU style are:
  146.      -nbad -bap -nbbb -nbc -bl -bli2 -c33 -cd33 -ncdb -nce
  147.      -cli0 -cp1 -di2 -nfc1 -nfca -i2 -ip5 -lp -pcs -psl -cs
  148.      -nsc -nsob -nss -ts8 -d0 -ci0 -l78
  149.    The GNU coding style is that preferred by the GNU project.  It is the
  150. style that the GNU Emacs C mode encourages and which is used in the C
  151. portions of GNU Emacs.  (People interested in writing programs for
  152. Project GNU should get a copy of `The GNU Coding Standards', which also
  153. covers semantic and portability issues such as memory usage, the size
  154. of integers, etc.)
  155.    The Kernighan & Ritchie style is used throughout their well-known
  156. book `The C Programming Language'.  It is enabled with the `-kr'
  157. option.  The Kernighan & Ritchie style corresponds to the following set
  158. of options:
  159.      -nbad -bap -nbbb -nbc -br -c33 -cd33 -ncdb -ce -ci4
  160.      -cli0 -cp33 -d0 -di1 -nfc1 -nfca -i4 -ip0 -l75 -lp
  161.      -npcs -npsl -nsc -nsob -nss -ts8 -cs
  162. Kernighan & Ritchie style does not put comments to the right of code in
  163. the same column at all times (nor does it use only one space to the
  164. right of the code), so for this style `indent' has arbitrarily chosen
  165. column 33.
  166.    The style of the original Berkeley `indent' may be obtained by
  167. specifying `-orig' (or by specifyfying `--original', using the long
  168. option name).  This style is equivalent to the following settings:
  169.      -nbap -nbad -nbbb -bc -br -c33 -cd33 -cdb -ce -ci4
  170.      -cli0 -cp33 -d4 -di16 -fc1 -fca -i4 -ip4 -l75 -lp
  171.      -npcs -psl -sc -nsob -nss -ts8 -ncs
  172. File: indent.info,  Node: Blank lines,  Next: Comments,  Prev: Common styles,  Up: Indent Program
  173. Blank lines
  174. ===========
  175.    Various programming styles use blank lines in different places.
  176. `indent' has a number of options to insert or delete blank lines in
  177. specific places.
  178.    The `-bad' option causes `indent' to force a blank line after every
  179. block of declarations.  The `-nbad' option causes `indent' not to force
  180. such blank lines.
  181.    The `-bap' option forces a blank line after every procedure body.
  182. The `-nbap' option forces no such blank line.
  183.    The `-bbb' option forces a blank line before every block comment.  A
  184. block comment is one which starts in column one when formatting of such
  185. comments is disabled, or one with `-' or `*' immediately following the
  186. `/*'.  The `-nbbb' option does not force such blank lines.
  187.    The `-sob' option causes `indent' to swallow optional blank lines
  188. (that is, any optional blank lines present in the input will be removed
  189. from the output).  If the `-nsob' is specified, any blank lines present
  190. in the input file will be copied to the output file.
  191. * Menu:
  192. * -bad::                        More on the `-bad' option.
  193. * -bap::                        More on the `-bap' option.
  194. File: indent.info,  Node: -bad,  Next: -bap,  Up: Blank lines
  195. -blank-lines-after-declarations
  196. -------------------------------
  197.    The `-bad' option forces a blank line after every block of
  198. declarations.  The `-nbad' option does not add any such blank lines.
  199.    For example, given the input
  200.      char *foo;
  201.      char *bar;
  202.      /* This separates blocks of declarations.  */
  203.      int baz;
  204. `indent -bad' produces
  205.      char *foo;
  206.      char *bar;
  207.      
  208.      /* This separates blocks of declarations.  */
  209.      int baz;
  210. and `indent -nbad' produces
  211.      char *foo;
  212.      char *bar;
  213.      /* This separates blocks of declarations.  */
  214.      int baz;
  215. File: indent.info,  Node: -bap,  Prev: -bad,  Up: Blank lines
  216. -blank-lines-after-procedures
  217. -----------------------------
  218.    The `-bap' option forces a blank line after every procedure body.
  219.    For example, given the input
  220.      int
  221.      foo ()
  222.      {
  223.        puts("Hi");
  224.      }
  225.      /* The procedure bar is even less interesting.  */
  226.      char *
  227.      bar ()
  228.      {
  229.        puts("Hello");
  230.      }
  231. `indent -bap' produces
  232.      int
  233.      foo ()
  234.      {
  235.        puts ("Hi");
  236.      }
  237.      
  238.      /* The procedure bar is even less interesting.  */
  239.      char *
  240.      bar ()
  241.      {
  242.        puts ("Hello");
  243.      }
  244. and `indent -nbap' produces
  245.      int
  246.      foo ()
  247.      {
  248.        puts ("Hi");
  249.      }
  250.      /* The procedure bar is even less interesting.  */
  251.      char *
  252.      bar ()
  253.      {
  254.        puts ("Hello");
  255.      }
  256. No blank line will be added after the procedure `foo'.
  257. File: indent.info,  Node: Comments,  Next: Statements,  Prev: Blank lines,  Up: Indent Program
  258. Comments
  259. ========
  260.    Comments are no longer formatted by default as of version 1.2.  This
  261. can be enabled with the `-fca' option.  Doing so will cause newlines in
  262. the comment text to be ignored and the line will be filled up to the
  263. length of a line (which can be modified with `-l').  When formatting is
  264. enabled, blank lines indicate paragraph breaks.
  265.    The `-fc1' option enables the formatting of comments which begin in
  266. the first column.  The `-nfc1' option disables the formatting of first
  267. column comments.  When comment formatting is disabled, overall comment
  268. indentation may still be adjusted.
  269.    The indentation of comments which do not appear to the right of code
  270. is set by the `-d' option, which specifies the number of spaces to the
  271. left of the surrounding code that the comment appears.  For example,
  272. `-d2' places comments two spaces to the left of code; `-d0' lines up
  273. comments with the code.  The `-cdb' option controls whether the `/*'
  274. and `*/' are placed on blank lines.  With `-cdb', comments look like
  275. this:
  276.      /*
  277.       * this is a comment
  278.       */
  279. With `-ncdb', comments look like this:
  280.      /* this is a comment */
  281. `-cdb' only affects block comments, not comments to the right of code.
  282. The default is `-ncdb'.
  283.    Comments which appear on the same line as code are placed to the
  284. right.  The column in which comments on code start is controlled by the
  285. `-c' option.  The column in which comments to the right of declarations
  286. start is controlled by the `-cd' option.  By default, they start in the
  287. same column as comments to the right of code, which is column 33.  The
  288. column number for comments to the right of `#else' and `#endif'
  289. statements is controlled by the `-cp' option.  If the code on a line
  290. extends past the comment column, the comment starts further to the
  291. right, and the right margin may be automatically extended in extreme
  292. cases.
  293.    If the `-sc' option is specified, `*' is placed at the left edge of
  294. all comments.  For example:
  295.      /* This is a comment which extends from one line
  296.       * onto the next line, thus causing us to consider
  297.       * how it should continue.  */
  298. instead of
  299.      /* This is a comment which extends from one line
  300.         onto the next line, thus causing us to consider
  301.         how it should continue.  */
  302. File: indent.info,  Node: Statements,  Next: Declarations,  Prev: Comments,  Up: Indent Program
  303. Statements
  304. ==========
  305.    The `-br' or `-bl' option specifies how to format braces.
  306.    The `-br' option formats braces like this:
  307.      if (x > 0) {
  308.        x--;
  309.      }
  310. The `-bl' option formats them like this:
  311.      if (x > 0)
  312.        {
  313.          x--;
  314.        }
  315.    If you use the `-bl' option, you may also want to specify the `-bli'
  316. option.  This option specifies the number of spaces by which braces are
  317. indented.  `-bli2', the default, gives the result shown above.  `-bli0'
  318. results in the following:
  319.      if (x > 0)
  320.      {
  321.        x--;
  322.      }
  323.    If you are using the `-br' option, you probably want to also use the
  324. `-ce' option.  This causes the `else' in an if-then-else construct to
  325. cuddle up to the immediately preceding `}'.  For example, with `-br
  326. -ce' you get the following:
  327.      if (x > 0) {
  328.        x--;
  329.      } else {
  330.        fprintf (stderr, "...something wrong?\n");
  331.      }
  332. With `-br -nce' that code would appear as
  333.      if (x > 0) {
  334.        x--;
  335.      }
  336.      else {
  337.        fprintf (stderr, "...something wrong?\n");
  338.      }
  339.    The `-cli' option specifies the number of spaces that case labels
  340. should be indented to the right of the containing `switch' statement.
  341.    If a semicolon is on the same line as a `for' or `while' statement,
  342. the `-ss' option will cause a space to be placed before the semicolon.
  343. This emphasizes the semicolon, making it clear that the body of the
  344. `for' or `while' statement is an empty statement.  `-nss' disables this
  345. feature.
  346.    The `-pcs' option causes a space to be placed between the name of
  347. the procedure being called and the `(' (for example, `puts ("Hi");'.
  348. The `-npcs' option would give `puts("Hi");').
  349.    If the `-cs' option is specified, `indent' puts a space after a cast
  350. operator.
  351.    The `-bs' option ensures that there is a space between the keyword
  352. `sizeof' and its argument.  In some versions, this is known as the
  353. `Bill_Shannon' option.
  354. File: indent.info,  Node: Declarations,  Next: Indentation,  Prev: Statements,  Up: Indent Program
  355. Declarations
  356. ============
  357.    By default `indent' will line up identifiers, in the column
  358. specified by the `-di' option.  For example, `-di16' makes things look
  359. like:
  360.      int             foo;
  361.      char           *bar;
  362.    Using a small value (such as one or two) for the `-di' option can be
  363. used to cause the indentifiers to be placed in the first available
  364. position, for example
  365.      int foo;
  366.      char *bar;
  367.    The value given to the `-di' option will still affect variables
  368. which are put on separate lines from their types, for example `-di2'
  369. will lead to
  370.      int
  371.        foo;
  372.    If the `-bc' option is specified, a newline is forced after each
  373. comma in a declaration.  For example,
  374.      int a,
  375.        b,
  376.        c;
  377. With the `-nbc' option this would look like
  378.      int a, b, c;
  379.    The `-psl' option causes the type of a procedure being defined to be
  380. placed on the line before the name of the procedure.  This style is
  381. required for the `etags' program to work correctly, as well as some of
  382. the `c-mode' functions of Emacs.
  383.    If you are not using the `-di1' option to place variables being
  384. declared immediately after their type, you need to use the `-T' option
  385. to tell `indent' the name of all the typenames in your program that are
  386. defined by `typedef'.  `-T' can be specified more than once, and all
  387. names specified are used.  For example, if your program contains
  388.      typedef unsigned long CODE_ADDR;
  389.      typedef enum {red, blue, green} COLOR;
  390. you would use the options `-T CODE_ADDR -T COLOR'.
  391. File: indent.info,  Node: Indentation,  Next: Miscellaneous options,  Prev: Declarations,  Up: Indent Program
  392. Indentation
  393. ===========
  394.    One issue in the formatting of code is how far each line should be
  395. indented from the left margin.  When the beginning of a statement such
  396. as `if' or `for' is encountered, the indentation level is increased by
  397. the value specified by the `-i' option.  For example, use `-i8' to
  398. specify an eight character indentation for each level.  When a
  399. statement is continued from a previous line, it is indented by a number
  400. of additional spaces specified by the `-ci' option.  `-ci' defaults to
  401. 0.  However, if the `-lp' option is specified, and a line has a left
  402. parenthesis which is not closed on that line, then continuation lines
  403. will be lined up to start at the character position just after the left
  404. parenthesis.  This processing also applies to `[' and applies to `{'
  405. when it occurs in initialization lists.  For example, a piece of
  406. continued code might look like this with `-nlp -ci3' in effect:
  407.        p1 = first_procedure (second_procedure (p2, p3),
  408.           third_procedure (p4, p5));
  409. With `-lp' in effect the code looks somewhat clearer:
  410.        p1 = first_procedure (second_procedure (p2, p3),
  411.                              third_procedure (p4, p5));
  412.    `indent' assumes that tabs are placed at regular intervals of both
  413. input and output character streams.  These intervals are by default 8
  414. columns wide, but (as of version 1.2) may be changed by the `-ts'
  415. option.  Tabs are treated as the equivalent number of spaces.
  416.    The indentation of type declarations in old-style function
  417. definitions is controlled by the `-ip' parameter.  This is a numeric
  418. parameter specifying how many spaces to indent type declarations.  For
  419. example, the default `-ip5' makes definitions look like this:
  420.      char *
  421.      create_world (x, y, scale)
  422.           int x;
  423.           int y;
  424.           float scale;
  425.      {
  426.        . . .
  427.      }
  428.    For compatibility with other versions of indent, the option `-nip'
  429. is provided, which is equivalent to `-ip0'.
  430.    ASCII C allows white space to be placed on preprocessor command lines
  431. between the character `#' and the command name.  By default, `indent'
  432. removes this space, but specifying the `-lps' option directs `indent'
  433. to leave this space unmodified.
  434. File: indent.info,  Node: Miscellaneous options,  Next: Bugs,  Prev: Indentation,  Up: Indent Program
  435. Miscellaneous options
  436. =====================
  437.    To find out what version of `indent' you have, use the command
  438. `indent -version'.  This will report the version number of `indent',
  439. without doing any of the normal processing.
  440.    The `-v' option can be used to turn on verbose mode.  When in
  441. verbose mode, `indent' reports when it splits one line of input into
  442. two more more lines of output, and gives some size statistics at
  443. completion.
  444. File: indent.info,  Node: Bugs,  Next: Copyright,  Prev: Miscellaneous options,  Up: Indent Program
  445.    The "-troff" option is strongly deprecated, and is not supported.  A
  446. good thing for someone to do is to rewrite `indent' to generate TeX
  447. source as a hardcopy output option, amoung other things.
  448. File: indent.info,  Node: Copyright,  Prev: Bugs,  Up: Indent Program
  449. Copyright
  450. =========
  451.    The following copyright notice applies to the `indent' program.  The
  452. copyright and copying permissions for this manual appear near the
  453. beginning of this document.
  454.      Copyright (c) 1989, 1992 Free Software Foundation
  455.      Copyright (c) 1985 Sun Microsystems, Inc.
  456.      Copyright (c) 1980 The Regents of the University of California.
  457.      Copyright (c) 1976 Board of Trustees of the University of Illinois.
  458.      All rights reserved.
  459.      
  460.      Redistribution and use in source and binary forms are permitted
  461.      provided that the above copyright notice and this paragraph are
  462.      duplicated in all such forms and that any documentation,
  463.      advertising materials, and other materials related to such
  464.      distribution and use acknowledge that the software was developed
  465.      by the University of California, Berkeley, the University of Illinois,
  466.      Urbana, and Sun Microsystems, Inc.  The name of either University
  467.      or Sun Microsystems may not be used to endorse or promote products
  468.      derived from this software without specific prior written permission.
  469.      THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  470.      IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  471.      WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  472.      PURPOSE.
  473. File: indent.info,  Node: Option Summary,  Next: Index,  Prev: Indent Program,  Up: Top
  474. Option Summary
  475. **************
  476.    Here is a list of all the options for `indent', alphabetized by
  477. short option.  It is followed by a cross key alphabetized by long
  478. option.
  479. `-bad'
  480. `--blank-lines-after-declarations'
  481.      Force blank lines after the declarations.
  482.      *Note Blank lines::.
  483. `-bap'
  484. `--blank-lines-after-procedures'
  485.      Force blank lines after procedure bodies.
  486.      *Note Blank lines::.
  487. `-bbb'
  488. `--blank-lines-after-block-comments'
  489.      Force blank lines after block comments.
  490.      *Note Blank lines::.
  491. `-bc'
  492. `--blank-lines-after-commas'
  493.      Force newline after comma in declaration.
  494.      *Note Declarations::.
  495. `-bl'
  496. `--braces-after-if-line'
  497.      Put braces on line after `if', etc.
  498.      *Note Statements::.
  499. `-bliN'
  500. `--brace-indentN'
  501.      Indent braces N spaces.
  502.      *Note Statements::.
  503. `-br'
  504. `--braces-on-if-line'
  505.      Put braces on line with `if', etc.
  506.      *Note Statements::.
  507. `-cN'
  508. `--comment-indentationN'
  509.      Put comments to the right of code in column N.
  510.      *Note Comments::.
  511. `-cdN'
  512. `--declaration-comment-columnN'
  513.      Put comments to the right of the declarations in column N.
  514.      *Note Comments::.
  515. `-cdb'
  516. `--comment-delimiters-on-blank-lines'
  517.      Put comment delimiters on blank lines.
  518.      *Note Comments::.
  519. `-ce'
  520. `--cuddle-else'
  521.      Cuddle else and preceeding `}'.
  522.      *Note Comments::.
  523. `-ciN'
  524. `--continuation-indentationN'
  525.      Continuation indent of N spaces.
  526.      *Note Statements::.
  527. `-cliN'
  528. `--case-indentationN'
  529.      Case label indent of N spaces.
  530.      *Note Statements::.
  531. `-cpN'
  532. `--else-endif-columnN'
  533.      Put comments to the right of `#else' and `#endif' statements in
  534.      column N.
  535.      *Note Comments::.
  536. `-cs'
  537. `--space-after-cast'
  538.      Put a space after a cast operator.
  539.      *Note Statements::.
  540. `-bs'
  541. `--blank-before-sizeof'
  542.      Put a space between `sizeof' and its argument.
  543.      *Note Statements::
  544. `-dN'
  545. `--line-comments-indentationN'
  546.      Set indentation of comments not to the right of code to N spaces.
  547.      *Note Comments::.
  548. `-diN'
  549. `--declaration-indentationN'
  550.      Put variables in column N.
  551.      *Note Declarations::.
  552. `-fc1'
  553. `--format-first-column-comments'
  554.      Format comments in the first column.
  555.      *Note Comments::.
  556. `-fca'
  557. `--format-all-comments'
  558.      Do not disable all formatting of comments.
  559.      *Note Comments::
  560. `-gnu'
  561. `--gnu-style'
  562.      Use GNU coding style.  This is the default.
  563.      *Note Common styles::.
  564. `-iN'
  565. `--indent-levelN'
  566.      Set indentation level to N spaces.
  567.      *Note Indentation::.
  568. `-ipN'
  569. `--parameter-indentationN'
  570.      Indent parameter types in old-style function definitions by N
  571.      spaces.
  572.      *Note Indentation::.
  573. `-kr'
  574. `--k-and-r-style'
  575.      Use Kernighan & Ritchie coding style.
  576.      *Note Common styles::.
  577. `-lN'
  578. `--line-lengthN'
  579.      Set maximum line length to N.
  580.      *Note Comments::.
  581. `-lp'
  582. `--continue-at-parentheses'
  583.      Line up continued lines at parentheses.
  584.      *Note Indentation::.
  585. `-lps'
  586. `--leave-preprocessor-space'
  587.      Leave space between `#' and preprocessor directive.  *Note
  588.      Indentation::.
  589. `-nbad'
  590. `--no-blank-lines-after-declarations'
  591.      Do not force blank lines after declarations.
  592.      *Note Blank lines::.
  593. `-nbap'
  594. `--no-blank-lines-after-procedures'
  595.      Do not force blank lines after procedure bodies.
  596.      *Note Blank lines::.
  597. `-nbbb'
  598. `--no-blank-lines-after-block-comments'
  599.      Do not force blank-lines after block comments.
  600.      *Note Blank lines::.
  601. `-nbc'
  602. `--no-blank-lines-after-commas'
  603.      Do not force newlines after commas in declarations.
  604.      *Note Declarations::.
  605. `-ncdb'
  606. `--no-comment-delimiters-on-blank-lines'
  607.      Do not put comment delimiters on blank lines.
  608.      *Note Comments::.
  609. `-nce'
  610. `--dont-cuddle-else'
  611.      Do not cuddle `}' and `else'.
  612.      *Note Statements::.
  613. `-ncs'
  614. `--no-space-after-casts'
  615.      Do not put a space after cast operators.
  616.      *Note Statements::.
  617. `-nfc1'
  618. `--dont-format-first-column-comments'
  619.      Do not format comments in the first column as normal.
  620.      *Note Comments::.
  621. `-nfca'
  622. `--dont-format-comments'
  623.      Do not format any comments.
  624.      *Note Comments::.
  625. `-nip'
  626. `--no-parameter-indentation'
  627.      Zero width indentation for parameters.
  628.      *Note Indentation::
  629. `-nlp'
  630. `--dont-line-up-parentheses'
  631.      Do not line up parentheses.
  632.      *Note Statements::.
  633. `-npcs'
  634. `--no-space-after-function-call-names'
  635.      Do not put space after the function in function calls.
  636.      *Note Statements::.
  637. `-npsl'
  638. `--dont-break-procedure-type'
  639.      Put the type of a procedure on the same line as its name.
  640.      *Note Declarations::.
  641. `-nsc'
  642. `--dont-star-comments'
  643.      Do not put the `*' character at the left of comments.
  644.      *Note Comments::.
  645. `-nsob'
  646. `--leave-optional-blank-lines'
  647.      Do not swallow optional blank lines.
  648.      *Note Blank lines::.
  649. `-nss'
  650. `--dont-space-special-semicolon'
  651.      Do not force a space before the semicolon after certain statements.
  652.      Disables `-ss'.
  653.      *Note Statements::.
  654. `-nv'
  655. `--no-verbosity'
  656.      Disable verbose mode. *Note Miscellaneous options::.
  657. `-orig'
  658. `--original'
  659.      Use the original Berkeley coding style.
  660.      *Note Common styles::.
  661. `-npro'
  662. `--ignore-profile'
  663.      Do not read `.indent.pro' files.
  664.      *Note Invoking indent::.
  665. `-pcs'
  666. `--space-after-procedure-calls'
  667.      Insert a space between the name of the procedure being called and
  668.      the `('.
  669.      *Note Statements::.
  670. `-psl'
  671. `--procnames-start-lines'
  672.      Put the type of a procedure on the line before its name.
  673.      *Note Declarations::.
  674. `-sc'
  675. `--start-left-side-of-comments'
  676.      Put the `*' character at the left of comments.
  677.      *Note Comments::.
  678. `-sob'
  679. `--swallow-optional-blank-lines'
  680.      Swallow optional blank lines.
  681.      *Note Blank lines::.
  682. `-ss'
  683. `--space-special-semicolon'
  684.      On one-line `for' and `while' statments, force a blank before the
  685.      semicolon.
  686.      *Note Statements::.
  687. `-st'
  688. `--standard-output'
  689.      Write to standard output.
  690.      *Note Invoking indent::.
  691.      Tell `indent' the name of typenames.
  692.      *Note Declarations::.
  693. `-tsN'
  694. `--tab-sizeN'
  695.      Set tab size to N spaces.
  696.      *Note Indentation::.
  697. `--verbose'
  698.      Enable verbose mode.
  699.      *Note Miscellaneous options::.
  700. `-version'
  701.      Output the version number of `indent'.
  702.      *Note Miscellaneous options::.
  703. Options' Cross Key
  704. ------------------
  705.    Here is a list of options alphabetized by long option, to help you
  706. find the corresponding short option.
  707.      --blank-lines-after-block-comments              -bbb
  708.      --blank-lines-after-commas                      -bc
  709.      --blank-lines-after-declarations                -bad
  710.      --blank-lines-after-procedures                  -bap
  711.      --braces-after-if-line                          -bl
  712.      --brace-indent                                  -bli
  713.      --braces-on-if-line                             -br
  714.      --case-indentation                              -cliN
  715.      --comment-delimiters-on-blank-lines             -cdb
  716.      --comment-indentation                           -cN
  717.      --continuation-indentation                      -ciN
  718.      --continue-at-parentheses                       -lp
  719.      --cuddle-else                                   -ce
  720.      --declaration-comment-column                    -cdN
  721.      --declaration-indentation                       -diN
  722.      --dont-break-procedure-type                     -npsl
  723.      --dont-cuddle-else                              -nce
  724.      --dont-format-comments                          -nfca
  725.      --dont-format-first-column-comments             -nfc1
  726.      --dont-line-up-parentheses                      -nlp
  727.      --dont-space-special-semicolon                  -nss
  728.      --dont-star-comments                            -nsc
  729.      --else-endif-column                             -cpN
  730.      --format-all-comments                           -fca
  731.      --format-first-column-comments                  -fc1
  732.      --gnu-style                                     -gnu
  733.      --ignore-profile                                -npro
  734.      --indent-level                                  -iN
  735.      --k-and-r-style                                 -kr
  736.      --leave-optional-blank-lines                    -nsob
  737.      --leave-preprocessor-space                      -lps
  738.      --line-comments-indentation                     -dN
  739.      --line-length                                   -lN
  740.      --no-blank-lines-after-block-comments           -nbbb
  741.      --no-blank-lines-after-commas                   -nbc
  742.      --no-blank-lines-after-declarations             -nbad
  743.      --no-blank-lines-after-procedures               -nbap
  744.      --no-comment-delimiters-on-blank-lines          -ncdb
  745.      --no-space-after-casts                          -ncs
  746.      --no-parameter-indentation                      -nip
  747.      --no-space-after-function-call-names            -npcs
  748.      --no-verbosity                                  -nv
  749.      --original                                      -orig
  750.      --parameter-indentation                         -ipN
  751.      --procnames-start-lines                         -psl
  752.      --space-after-cast                              -cs
  753.      --space-after-procedure-calls                   -pcs
  754.      --space-special-semicolon                       -ss
  755.      --standard-output                               -st
  756.      --start-left-side-of-comments                   -sc
  757.      --swallow-optional-blank-lines                  -sob
  758.      --tab-size                                      -tsN
  759.      --verbose                                       -v
  760. File: indent.info,  Node: Index,  Prev: Option Summary,  Up: Top
  761. Index
  762. *****
  763. * Menu:
  764. * -blank-after-sizeof:                  Statements.
  765. * -blank-lines-after-block-comments:    Blank lines.
  766. * -blank-lines-after-commas:            Declarations.
  767. * -blank-lines-after-declarations:      -bad.
  768. * -blank-lines-after-procedures:        -bap.
  769. * -brace-indentN:                       Statements.
  770. * -braces-after-if-line:                Statements.
  771. * -braces-on-if-line:                   Statements.
  772. * -case-indentationN:                   Statements.
  773. * -comment-delimiters-on-blank-lines:   Comments.
  774. * -comment-indentationN:                Comments.
  775. * -continuation-indentationN:           Indentation.
  776. * -continue-at-parentheses:             Indentation.
  777. * -cuddle-else:                         Statements.
  778. * -declaration-comment-columnN:         Comments.
  779. * -declaration-indentationN:            Declarations.
  780. * -dont-break-procedure-type:           Declarations.
  781. * -dont-cuddle-else:                    Statements.
  782. * -dont-format-comments:                Comments.
  783. * -dont-format-first-column-comments:   Comments.
  784. * -dont-line-up-parentheses:            Indentation.
  785. * -dont-space-special-semicolon:        Statements.
  786. * -dont-star-comments:                  Comments.
  787. * -else-endif-columnN:                  Comments.
  788. * -format-all-comments:                 Comments.
  789. * -format-first-column-comments:        Comments.
  790. * -gnu-style:                           Common styles.
  791. * -ignore-profile:                      Invoking indent.
  792. * -indent-levelN:                       Indentation.
  793. * -k-and-r-style:                       Common styles.
  794. * -leave-optional-blank-lines:          Blank lines.
  795. * -leave-preprocessor-space:            Indentation.
  796. * -line-comments-indentationN:          Comments.
  797. * -line-lengthN:                        Comments.
  798. * -no-blank-lines-after-block-comments: Blank lines.
  799. * -no-blank-lines-after-commas:         Declarations.
  800. * -no-blank-lines-after-declarations:   -bad.
  801. * -no-blank-lines-after-procedures:     -bap.
  802. * -no-comment-delimiters-on-blank-lines: Comments.
  803. * -no-parameter-indentation:            Indentation.
  804. * -no-space-after-casts:                Statements.
  805. * -no-space-after-function-call-names:  Statements.
  806. * -no-verbosity:                        Miscellaneous options.
  807. * -original:                            Common styles.
  808. * -output-file:                         Invoking indent.
  809. * -parameter-indentationN:              Indentation.
  810. * -procnames-start-lines:               Declarations.
  811. * -remove-preprocessor-space:           Indentation.
  812. * -space-after-cast:                    Statements.
  813. * -space-after-procedure-calls:         Statements.
  814. * -space-special-semicolon:             Statements.
  815. * -standard-output:                     Invoking indent.
  816. * -star-left-side-of-comments:          Comments.
  817. * -swallow-optional-blank-lines:        Blank lines.
  818. * -tab-sizeN:                           Indentation.
  819. * -verbose:                             Miscellaneous options.
  820. * -bad:                                 -bad.
  821. * -bap:                                 -bap.
  822. * -bbb:                                 Blank lines.
  823. * -bc:                                  Declarations.
  824. * -bl:                                  Statements.
  825. * -bliN:                                Statements.
  826. * -br:                                  Statements.
  827. * -bs:                                  Statements.
  828. * -cN:                                  Comments.
  829. * -cdN:                                 Comments.
  830. * -cdb:                                 Comments.
  831. * -ce:                                  Statements.
  832. * -ciN:                                 Indentation.
  833. * -cliN:                                Statements.
  834. * -cpN:                                 Comments.
  835. * -cs:                                  Statements.
  836. * -dN:                                  Comments.
  837. * -dce:                                 Statements.
  838. * -diN:                                 Declarations.
  839. * -fc1:                                 Comments.
  840. * -fca:                                 Comments.
  841. * -gnu:                                 Common styles.
  842. * -iN:                                  Indentation.
  843. * -ipN:                                 Indentation.
  844. * -kr:                                  Common styles.
  845. * -lN:                                  Comments.
  846. * -lp:                                  Indentation.
  847. * -lps:                                 Indentation.
  848. * -nbad:                                -bad.
  849. * -nbap:                                -bap.
  850. * -nbbb:                                Blank lines.
  851. * -nbc:                                 Declarations.
  852. * -ncdb:                                Comments.
  853. * -ncs:                                 Statements.
  854. * -nfc1:                                Comments.
  855. * -nfca:                                Comments.
  856. * -nip:                                 Indentation.
  857. * -nlp:                                 Indentation.
  858. * -nlps:                                Indentation.
  859. * -npcs:                                Statements.
  860. * -npro:                                Invoking indent.
  861. * -npsl:                                Declarations.
  862. * -nsc:                                 Comments.
  863. * -nsob:                                Blank lines.
  864. * -nss:                                 Statements.
  865. * -nv:                                  Miscellaneous options.
  866. * -o:                                   Invoking indent.
  867. * -orig:                                Common styles.
  868. * -pcs:                                 Statements.
  869. * -psl:                                 Declarations.
  870. * -sc:                                  Comments.
  871. * -sob:                                 Blank lines.
  872. * -ss:                                  Statements.
  873. * -st:                                  Invoking indent.
  874. * -T:                                   Declarations.
  875. * -tsN:                                 Indentation.
  876. * -v:                                   Miscellaneous options.
  877. * -version:                             Miscellaneous options.
  878. * etags requires -psl:                  Declarations.
  879. * .indent.pro file:                     Invoking indent.
  880. * Beginning indent:                     Invoking indent.
  881. * Berkeley style:                       Common styles.
  882. * Blank lines:                          Blank lines.
  883. * Comments:                             Comments.
  884. * GNU style:                            Common styles.
  885. * Initialization file:                  Invoking indent.
  886. * Invoking indent:                      Invoking indent.
  887. * Kernighan & Ritchie style:            Common styles.
  888. * Long options, use of:                 Invoking indent.
  889. * Original Berkeley style:              Common styles.
  890. * Output File Specification:            Invoking indent.
  891. * Standard Output:                      Invoking indent.
  892. * Starting indent:                      Invoking indent.
  893. * Typenames:                            Declarations.
  894. * Using Standard Input:                 Invoking indent.
  895. Tag Table:
  896. Node: Top
  897. Node: Indent Program
  898. Node: Invoking indent
  899. Node: Backup files
  900. Node: Common styles
  901. Node: Blank lines
  902. Node: -bad
  903. 10403
  904. Node: -bap
  905. 11050
  906. Node: Comments
  907. 11911
  908. Node: Statements
  909. 14285
  910. Node: Declarations
  911. 16283
  912. Node: Indentation
  913. 17900
  914. Node: Miscellaneous options
  915. 20219
  916. Node: Bugs
  917. 20761
  918. Node: Copyright
  919. 21073
  920. Node: Option Summary
  921. 22453
  922. Node: Index
  923. 31998
  924. End Tag Table
  925.