refer: set [E and [H registers
[neatrefer.git] / README
blobb13f1c5ee28496e6f2a5bc861f83ff22b429bb05
1 NEATREFER
2 =========
4 Neatrefer troff preprocessor is a small refer clone for managing
5 bibliographic references.  It assumes that each record in the database
6 has an 'L' key, which specifies the label of the record.  When
7 referencing, only this key is looked up among the records in the
8 database.  Therefore, Neatrefer is not compatible with the original
9 refer.
11 Citing in Neatrefer can be done by including the label of the record
12 between .[ and .] request lines.  In addition, other citation macros
13 can be defined using -o option.  For example with -ocite option,
14 the record with label utp87 can be cited as follows:
16   .cite utp87
17   \*[cite utp87]
19 When using numbered citation style Neatrefer replaces them with the
20 following lines:
22   .cite 1
23   \*[cite 1]
25 And when using author-year citation style (-a option), Neatrefer
26 replaces them with with the following lines (after the citation macro,
27 publication date, the number of authors, and last names of the authors
28 appear):
30   .cite 1987 2 Dougherty O'Reilly
31   \*[cite 1987 2 Dougherty O'Reilly]
33 With -m option, Neatrefer allows multiple references in a single
34 citation, as a comma separated list of labels; refer tries to use
35 reference intervals for them if possible (-a and -m cannot be used
36 together).