1man(1) General Commands Manual man(1)
2
6 cite - replace bibliographic references by hyperlinks
7
9 cite [ -b base ] [ -p pattern ] [ -a auxfile ] [ -m marker ] bibfile [
10 HTMLfile ]
11
13 The cite commands copies the HTMLfile to standard output, looking for
14 strings of the form [[label]]. The label may not include white space
15 and the double pair of square brackets must enclose the label without
16 any spaces in between. If cite finds the label in the bibfile, the
17 string is replaced by the pattern. The pattern can include certain
18 variables. If the label is not found in bibfile, it is left unchanged.
19 The default pattern replaces the string with a hyperlink, but if the -p
21 option is used, the replacement can be any pattern. The input doesn't
22 even have to be HTML.
23 If the label is enclosed in {{...}} instead of [[...]], it is copied to
25 the output unchanged and not replaced by the pattern, but the label is
26 still searched in the bibfile.
27
29 The following options are supported:
30 -p pattern
32 Specifies the pattern by which the string [[label]] is
33 replaced. The pattern may include the variables %b (which
34 will be replaced by the value of the -b option), %m (which
35 will be replaced by the value of the -m option) and %L (which
36 will be replaced by the label). The default pattern is
37 <a href="%b#%L" rel="biblioentry">[%L]<!--{{%m%L}}--></a>
39 -b base Sets the value for the %b variable in the pattern. Typically
42 this is set to a relative or absolute URL. By default this
43 value is an empty string.
44 -a auxfile
46 All labels that have been found and replaced are also written
47 to a file. This is so that mkbib(1) can find them and create
48 a bibliography. The default auxfile is constructed from the
49 name of the HTMLfile by removing the last extension (if any)
50 and replacing it by ".aux". If no HTMLfile is given, the
51 default name is "aux.aux".
52 -m marker By default, the program looks for "[[name]]", but it can be
54 made to look for "[[#name]]" where # is some string, usually
55 a symbol such as '!' or '='. This allows references to be
56 classified, e.g., "[[!name]]" for normative references and
57 "[[name]]" for non-normative references.
58
60 The following operands are supported:
61 bibfile The name of a bibliographic database must be given. It must
63 be a file in refer(1) format and every entry must have at
64 least a %L field, which is used as label. (Entries without
65 such a field will be ignored.)
66 HTMLfile The name of the input file is optional. If absent, cite will
68 read from stdin. The file in fact does not have to be an HTML
69 file, but the default pattern (see the -p option) assumes
70 HTML.
71
73 The following exit values are returned:
74 0 Successful completion.
76 > 0 An error occurred. Usually this is because a file could not
78 be opened. Very rarely it may also be an out of memory
79 error.
80
82 mkbib(1) xml2asc(1), UTF-8 (RFC 2279), normalize(1), num(1), toc(1),
83 htmlprune(1). unent(1) asc2xml(1)
84
86 refer(1) does not require the %L (label) field to be present in every
87 entry. Hoewever, cite does not implement refer's keyword search and
88 requires a key instead.
89 19 Mar 2000 man(1)