CITE(1) CITE(1)
NAME
cite - process citations in a document
SYNOPSIS
cite [ -s ] [ -u ] [ document ]
DESCRIPTION
Cite is a troff preprocessor used to process forward and
backward references in a document. Lines processed by cite
can be either of the form
.CD "key" "definition"
or
.CU "key"text
where key is an arbitrary name for the citation, and defini-
tion is what to print when the .CU macro is later called.
The text following the key in the .CU macro can be any text
desired, and it will immediately follow the definition.
In the case of forward references, the program will have no
internal definition. Therefore, the program will output the
line without the internal definition, assuming that later
the definition will be provided. In these cases, because it
is impossible to output the definition, ZZ will be placed on
the output followed by the additional text. When this defi-
nition is entered, the program outputs a line to standard
error that gives the information on the label; if these def-
initions are included in the text file and troff is run
again on the file, the forward references will have the nec-
essary data.
If -s is an argument to the program, it will do more exten-
sive error checking and sort and print the definitions at
the end of the program. If -u is an argument to the pro-
gram, it will place on stderr a list of all citations that
are either undefined or unused.
EXAMPLE
Input:
Chapter
.CU "TYPES, OPERATORS AND EXPRESSIONS"
deals with the basic data types, operators and expres-
sions.
.CD "TYPES, OPERATORS AND EXPRESSIONS" "2"
Output:
First pass:
CITE(1) CITE(1)
Chapter ZZ deals with the basic data types, opera-
tors and expressions.
Second pass:
Chapter 2 deals with the basic data types, opera-
tors and expressions.
SEE ALSO
troff(1)