README: mention other branches
[neatroff_make.git] / man / neatrefer.1
blob2144cd3f64099f71609865f8a57e4593e75244ae
1 .\" first draft by Larry Kollar
2 .TH neatrefer 1
3 .SH NAME
4 neatrefer \- the neatroff reference pre-processor
5 .SH SYNOPSIS
6 .I neatrefer
7 .RB [ \-p \~\c
8 .IR bib ]
9 .RB [ \-e ]
10 .RB [ \-m ]
11 .RI [< input ]
12 .RI [> output ]
13 .SH DESCRIPTION
14 .I Neatrefer
15 is a preprocessor for
16 .IR neatroff .
17 It processes reference markup between
18 .B \&.[
19 and
20 .B \&.]
21 commands, replacing the commands
22 with reference information from a database of references.
23 The output is formatted as footnotes or endnotes.
24 .SS "Extensions and Limitations"
25 .I Neatrefer
26 assumes that each database entry
27 has an
28 .B L
29 key, which specifies the label of a record.
30 .LP
31 .I Neatrefer
32 supports multiple references in a single
33 .BR \&.[ / \&.]
34 command when using the
35 .B -m
36 option.
37 Separate multiple labels by whitespace.
38 .SH OPTIONS
39 The following options are available:
40 .IP "\-p \fIbib\fP" 8
41 The file name of the reference database.
42 .IP "\-e"
43 Accumulate references.
44 .IP "\-m"
45 Allow multiple references in a single
46 .BR \&.[ / \&.]
47 command.
48 Separate labels with whitespace.
49 .SH "SEE ALSO"
50 .IR neatroff (1)
51 .IP http://man.cat-v.org/unix_8th/1/refer 4
52 The original
53 .I refer
54 manpage.