croff

Section: Misc. Reference Manual Pages (1L)
Updated: June 30, 1987
Index Return to Main Contents

NAME

croff - prepare C source code for inclusion in a troff document

SYNOPSIS

DESCRIPTION

Croff is a troff preprocessor that prepares C source code for the inclusion in a troff document. In the default case, all C keywords and c preprosessor keywords are emboldened, whereas comments are set in italics. In additions the characters '\', '-' and '|' are munged to appear properly in the troff output. A line in file that begins with .SS starts the croff filter, whereas a line in file that begins with .SE suspends the filtering process. the .SS and .SE are passed through croff unchanged, and may be defined as troff macros if desired. Up to the first 4 arguments on the same line as .SS are interpreted by croff to be the keyword starting string, comment starting string, keywork ending string, and comment ending string respectively. When specified here, these strings override the defaults or the command line arguments.

The following options are recognized on the command line:

-F

The entire file is forced though croff, no .SS and .SE are required.

-t

The characters '\', '-' and '' are left alone.

-a keyword

Keyword is added to the list of reserved words taken to be keywords

-d keyword

Keyword is deleted to the list of reserved words taken to be keywords

-[kcifp] start end

The strings start and end are used to delimit keywords, comments, identifiers, function calls, and preprocessor declarations respectively. The default is

: croff -e "\fP" -k "\fB" -c "\fI" -p "\fB"

to set keywords in bold and comments in italics. The end string may be omitted if the default value is ok.

-e end

sets the end string to all of the options k,c,i,f,p above;

AUTHOR

Stephen A. Uhler