4.3BSD-Reno/share/man/cat1/refer.0
REFER(1) UNIX Reference Manual REFER(1)
NNAAMMEE
rreeffeerr - find and insert literature references in documents
SSYYNNOOPPSSIISS
rreeffeerr [--aa] [--bb] [--cc] [--ee] [--ff_n] [--kk_x] [--ll_m,_n] [--nn] [--pp _b_i_b] [--ss_k_e_y_s]
[--BB_l._m] [--PP] [--SS] [[_f_i_l_e ...]]
DDEESSCCRRIIPPTTIIOONN
RReeffeerr is a preprocessor for nroff(1) or troff(1) that finds and formats
references for footnotes or endnotes. It is also the base for a series
of programs designed to index, search, sort, and print stand-alone bi-
bliographies, or other data entered in the appropriate form.
Given an incomplete citation with sufficiently precise keywords, rreeffeerr
will search a bibliographic database for references containing these key-
words anywhere in the title, author, journal, etc. The input file (or
standard input) is copied to standard output, except for lines between .[
and .] delimiters, which are assumed to contain keywords, and are re-
placed by information from the bibliographic database. The user may also
search different databases, override particular fields, or add new
fields. The reference data, from whatever source, are assigned to a set
of troff(1) strings. Macro packages such as ms(7) print the finished
reference text from these strings. By default references are flagged by
footnote numbers.
The following options are available:
--aa_n Reverse the first _n author names (Jones, J. A. instead of J. A.
Jones). If _n is omitted all author names are reversed.
--bb Bare mode: do not put any flags in text (neither numbers nor
labels).
--cc_k_e_y_s Capitalize (with CAPS SMALL CAPS) the fields whose key-letters
are in _k_e_y_s.
--ee Instead of leaving the references where encountered, accumulate
them until a sequence of the form
.[
$LIST$
.]
is encountered, and then write out all references collected so
far. Collapse references to same source.
--ff_n Set the footnote number to _n instead of the default of 1 (one).
With labels rather than numbers, this flag is a no-op.
--kk_x Instead of numbering references, use labels as specified in a
reference data line beginning %_x; by default _x is LL.
--ll_m, _n Instead of numbering references, use labels made from the
senior author's last name and the year of publication. Only
the first _m letters of the last name and the last _n digits of
the date are used. If either _m or _n is omitted the entire name
or date respectively is used.
--nn Do not search the default file /_v_a_r/_d_b/_I_n_d. If there is a
REFER environment variable, the specified file will be searched
instead of the default file; in this case the --nn flag has no
effect.
--pp _b_i_b Take the next argument _b_i_b as a file of references to be
searched. The default file is searched last.
--ss_k_e_y_s Sort references by fields whose key-letters are in the _k_e_y_s
string; permute reference numbers in text accordingly. Implies
--ee. The key-letters in _k_e_y_s may be followed by a number to in-
dicate how many such fields are used, with ++ taken as a very
large number. The default is AADD which sorts on the senior au-
thor and then date; to sort, for example, on all authors and
then title, use --ssAA++TT.
--BB_l._m Bibliography mode. Take a file composed of records separated
by blank lines, and turn them into troff(1) input. Label _l
will be turned into the macro ._m with _l defaulting to %%XX and ..mm
defaulting to ..AAPP (annotation paragraph).
--PP Place punctuation marks .,:;?! after the reference signal,
rather than before. (Periods and commas used to be done with
strings.)
--SS Produce references in the Natural or Social Science format.
To use your own references, put them in the format described below. They
can be searched more rapidly by running indxbib(1) on them before using
rreeffeerr; failure to index results in a linear search. When rreeffeerr is used
with the eqn(1), neqn(1) or tbl(1) preprocessors rreeffeerr should be first,
to minimize the volume of data passed through pipes.
The rreeffeerr preprocessor and associated programs expect input from a file
of references composed of records separated by blank lines. A record is
a set of lines (fields), each containing one kind of information. Fields
start on a line beginning with a ``%'', followed by a key-letter, then a
blank, and finally the contents of the field, and continue until the next
line starting with ``%''. The output ordering and formatting of fields
is controlled by the macros specified for nroff(1) or troff(1) (for foot-
notes and endnotes) or roffbib(1) (for stand-alone bibliographies). For
a list of the most common key-letters and their corresponding fields, see
addbib(1). An example of a rreeffeerr entry is given below.
EENNVVIIRROONNMMEENNTT
The following environment variable is used by rreeffeerr if it exists.
REFER Specify an alternate default search file for publication lists.
EEXXAAMMPPLLEESS
%A M. E. Lesk
%T Some Applications of Inverted Indexes on the UNIX System
%B UNIX Programmer's Manual
%V 2b
%I Bell Laboratories
%C Murray Hill, NJ
%D 1978
FFIILLEESS
/_u_s_r/_s_h_a_r_e/_d_i_c_t/_p_a_p_e_r_s directory of default publication lists.
/_v_a_r/_d_b/_I_n_d default search file (for _h_u_n_t phase).
/_u_s_r/_s_h_a_r_e/_d_i_c_t/_e_i_g_n contains common words.
/_u_s_r/_l_i_b_e_x_e_c directory where companion programs reside.
SSEEEE AALLSSOO
addbib(1), sortbib(1), roffbib(1), indxbib(1), lookbib(1)
HHIISSTTOORRYY
RReeffeerr appeared in Version 7 AT&T Unix.
AAUUTTHHOORR
Mike Lesk
BBUUGGSS
Blank spaces at the end of lines in bibliography fields will cause the
records to sort and reverse incorrectly. Sorting large numbers of refer-
ences causes a core dump.