Return to cite.1 CVS log

Up to [Research Unix] / researchv10dc / man / mana

Annotation of researchv10dc/man/mana/cite.1, revision 1.1.1.1

1.1       root        1: .TH CITE 1
                      2: .CT 1 writing_troff
                      3: .SH NAME
                      4: cite \- process citations in a document
                      5: .SH SYNOPSIS
                      6: .B cite
                      7: [
                      8: .B -s
                      9: ]
                     10: [
                     11: .B -u
                     12: ]
                     13: [
                     14: .I files
                     15: ]
                     16: .SH DESCRIPTION
                     17: .I Cite
                     18: is a
                     19: .IR troff (1)
                     20: preprocessor for forward and backward references.
                     21: It copies the
                     22: .I files
                     23: or the standard input to standard output,
                     24: observing lines of the forms
                     25: .IP
                     26: \f5\&.CD "\fIkey\f5" "\fIdefinition\f5"
                     27: .br
                     28: \&.CU "\fIkey\f5"\fItext
                     29: .EE
                     30: .LP
                     31: Each
                     32: .B .CD
                     33: line is remembered.
                     34: A later
                     35: .B .CU
                     36: with the same
                     37: .I key
                     38: will be replaced by the
                     39: .I definition
                     40: for that key; the
                     41: .I text
                     42: will be copied verbatim.
                     43: If no definition is yet available for a
                     44: .B .CU
                     45: reference, the key will be replaced by
                     46: .BR ZZ .
                     47: .PP
                     48: At the location of each
                     49: .B .CD
                     50: command,
                     51: .I cite
                     52: causes 
                     53: .I troff
                     54: to send the line (with macro substitutions)
                     55: to the standard error file.
                     56: The resulting  definitions may be included at the beginning of another
                     57: .I cite-troff
                     58: run, effectively eliminating forward references.
                     59: Unfortunately, the definition file 
                     60: may contain obsolete definitions (included
                     61: from a previous run) plus other
                     62: .I troff
                     63: messages.
                     64: These should be deleted using option
                     65: .BR -s .
                     66: .PP
                     67: The options are
                     68: .TP
                     69: .B -s
                     70: Place only the latest definitions
                     71: on the standard output; shunt
                     72: .RI non -cite
                     73: data to standard error.
                     74: .TP
                     75: .B -u
                     76: Place on standard error a list of undefined or unused citations.
                     77: .SH EXAMPLES
                     78: .EX
                     79: cite file.defs file | troff -ms 2>temp.defs >/dev/null 
                     80: cite -s temp.defs >file.defs
                     81: cite file.defs file | troff -ms 2>temp.defs | lp
                     82: .EE
                     83: .br
                     84: .ns
                     85: .IP
                     86: Run
                     87: .I cite-troff
                     88: to collect updated definitions in
                     89: .BR temp.defs .
                     90: .br
                     91: Eliminate old definitions, putting updates back in
                     92: .BR file.defs .
                     93: .br
                     94: Run
                     95: .IR cite-troff
                     96: again, using latest definitions.
                     97: .SH SEE ALSO
                     98: .IR troff (1)

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.