c2man(1)

NAME

c2man - generate manual pages from C source code

SYNOPSIS

c2man [ option ...  ] [ file ...  ]

DESCRIPTION

Arrayresults in a single output file with multiple links so that it
can be accessed by the name of the input file, or of any identifier documented. For example, if ctype.h contains:
/* ctype.h - character classification functions */

Array/* character is a letter */
inline int isalpha(int c);

/* character is a control character */
inline int iscntrl(int c);

/* character is a digit */
inline int isdigit(int c);

/* character is a graphic */
inline int isgraph(int c);

/* character is a lower case letter */
inline int islower(int c);

/* character is printable */
inline int isprint(int c);

/* character is punctuation */
inline int ispunct(int c);

/* character is a a form of whitespace */
inline int isspace(int c);

/* character is an upper case letter */
inline int isupper(int c);

Arraydescribing the identifier. A section heading is preceded in the
comment by an empty line (after removal of leading asterisks),
and is the only word on it's line, or is a word followed by a
colon (:), or is a line ending with a colon, so section names
with spaces are allowed, like "Return value:".
Section heading names are capitalized, and the names

DESCRIPTION

name them explicitly if you like. FUNCTION, PROCEDURE and

ROUTINE

For example:

/*

* Have a quick puff.
*
* Warning: Smoking causes lung cancer
*/

void go_for_a_smoke();

Generates a manual page with a WARNING section.

OPTIONS

Array-s Output manual pages for all static identifiers.

Arrayfile to which others are linked. For non-grouped manual pages,
if documentation for more than one identifier is generated, information about the last identifier will overwrite information
about all the previous ones.
-ifile

-i"file"

Arraytions. Nroff (n) is the default, LaTeX (l) , Texinfo (t) , HTML (h) , or AutoDoc (a). Texinfo specific options are s, t, n, and

C

Arraytion name from appearing in the table of contents. If the option
t is given, the name of the manpage is used for the title of the

NAME

Arrayreferenced with #include.
-V Print version information and cpp parameters.

FILES

/usr/share/doc/c2man/eg/*.[ch]

A few example input files, showing different com

menting styles.

SEE ALSO

man(1), apropos(1), catman(8), cproto(1), cc(1), cpp(1)

DIAGNOSTICS

Arraybut c2man rejects it, it may be because a comment is in a position c2man does not accept, or you are using a compiler extension
not strictly conforming to standard C. c2man defines the preprocessor symbol __C2MAN__ with its major version number to allow you to work around such problems by surrounding them with #ifndef __C2MAN__.
An error at the very end of a function may indicate that

the comments at the beginning are badly placed.

HISTORY

Arraywhich it was originally derived.

BUGS

Arraytastes.
March 2, 1995

C2MAN(1)