version 1.4, 1997/06/23 22:03:36 |
version 1.5, 1998/09/26 19:54:53 |
|
|
.Op Fl troff |
.Op Fl troff |
.Op Fl v | Fl \&nv |
.Op Fl v | Fl \&nv |
.Sh DESCRIPTION |
.Sh DESCRIPTION |
.Nm Indent |
.Nm indent |
is a |
is a |
.Ar C |
.Ar C |
program formatter. It reformats the |
program formatter. It reformats the |
|
|
.Ss Comments |
.Ss Comments |
.Sq Em Box |
.Sq Em Box |
.Em comments . |
.Em comments . |
.Nm Indent |
.Nm indent |
assumes that any comment with a dash, star, or newline immediately after |
assumes that any comment with a dash, star, or newline immediately after |
the start of comment (that is, `/*\-', `/**' or `/*' followed |
the start of comment (that is, `/*\-', `/**' or `/*' followed |
immediately by a newline character) is a comment surrounded |
immediately by a newline character) is a comment surrounded |
|
|
.Pp |
.Pp |
.Em Straight text . |
.Em Straight text . |
All other comments are treated as straight text. |
All other comments are treated as straight text. |
.Nm Indent |
.Nm indent |
fits as many words (separated by blanks, tabs, or newlines) on a |
fits as many words (separated by blanks, tabs, or newlines) on a |
line as possible. Blank lines break paragraphs. |
line as possible. Blank lines break paragraphs. |
.Pp |
.Pp |
|
|
compensate for the syntactic peculiarities introduced. |
compensate for the syntactic peculiarities introduced. |
.Pp |
.Pp |
.Ss C syntax |
.Ss C syntax |
.Nm Indent |
.Nm indent |
understands a substantial amount about the syntax of C, but it |
understands a substantial amount about the syntax of C, but it |
has a `forgiving' parser. It attempts to cope with the usual sorts of |
has a `forgiving' parser. It attempts to cope with the usual sorts of |
incomplete and misformed syntax. In particular, the use of macros like: |
incomplete and misformed syntax. In particular, the use of macros like: |
|
|
.Pp |
.Pp |
is handled properly. |
is handled properly. |
.Sh ENVIRONMENT |
.Sh ENVIRONMENT |
.Nm Indent |
.Nm indent |
uses the |
uses the |
.Ev HOME |
.Ev HOME |
environment variable. |
environment variable. |
|
|
command appeared in |
command appeared in |
.Bx 4.2 . |
.Bx 4.2 . |
.Sh BUGS |
.Sh BUGS |
.Nm Indent |
.Nm indent |
has even more switches than |
has even more switches than |
.Xr ls 1 . |
.Xr ls 1 . |
.Pp |
.Pp |