REFER 1
NAME
refer − (utroff) insert iso-690 compliant references in document
SYNOPSIS
@BINDIR@/refer [−abcdeinPS] [−fn] [−kx] [−lm,n] [−p bib] [−skeys] [−Bl.m] [file ...]
DESCRIPTION
Refer is an enhancement of the Heirloom refer preprocessor for nroff and troff 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 bibliographies, or other data entered in the appropriate form.
This version adds to Heirloom refer the ability to sort following the iso-690(7) bibliography standart (-i option), a better capitalize option (-d), support editor names like authors names, and insertion of the universal "&" instead of the english "and" to join names.
Given an incomplete citation with sufficiently precise keywords, refer will search a bibliographic database for references containing these keywords 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 replaced 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 strings. Macro packages such as ms print the finished reference text from these strings. By default references are flagged by footnote numbers.
The following options are available:
- −a n: Reverse the first n author or editor names (Jones, J. A. instead of J. A. Jones). If n is omitted all author and editor names are reversed.
- −b: Bare mode: do not put any flags in text (neither numbers nor labels).
- −c keys: Capitalize (with Caps Small Caps) the whole field whose key-letters are in the firstname part of fields whose key-letters are in keys. The firstname part is the last word of the fields or the previous one if it ends with a comma (",").
- −d keys: Insert strings around the lastname, firstname and junior part of fields whose key- letters are in keys, for later formatting. The firstname part is the last word of the field or the previous one if it ends with a comma (","). Strings are \*(+F and \*(-F around firstname, \*(+L and \*(-L around lastname, \*(+J and \*(-J around junior.
- −e: 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.
- −f 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.
- −i: Sort following the iso-690 standart order of fields: If J is defined, the order of fields is "QATESVBJ"; Else, if B is defined, the order of fields is "QATESVB"; Else, the order of fields is "QAESVT". The u-ref macro need this option to work properly.
- −k x: Instead of numbering references, use labels as specified in a reference data line beginning %x; by default x is L.
- −l 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.
- −n: Do not search the default file /$REFLIB$/papers/Ind. If there is a REFER environment variable, the specified file will be searched instead of the default file; in this case the −n flag has no effect.
- −p bib: Take the next argument bib as a file of references to be searched. The default file is searched last.
- −s keys: Sort references by fields whose key-letters are in the keys string; permute reference numbers in text accordingly. Implies −e. The key-letters in keys may be followed by a number to indicate how many such fields are used, with + taken as a very large number. The default is AD which sorts on the senior author and then date; to sort, for example, on all authors and then title, use -sA+T.
- −B l.m: Bibliography mode. Take a file composed of records separated by blank lines, and turn them into troff input. Label l will be turned into the macro .m with l defaulting to %X and .m defaulting to .AP (annotation paragraph).
- −P: Place punctuation marks .,:;?! after the reference signal, rather than before. (Periods and commas used to be done with strings.)
- −S: 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(1B) on them before using refer; failure to index results in a linear search. When refer is used with the eqn, neqn or tbl preprocessors refer should be first, to minimize the volume of data passed through pipes.
The refer 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/troff (for footnotes and endnotes) or roffbib (for stand-alone bibliographies). For a list of the most common key-letters and their corresponding fields, see addbib(1B). An example of a refer entry is given below.
EXAMPLE
%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
FILES
@REFDIR@/papers directory of default publication lists @REFDIR@ directory of companion programs
SEE ALSO
referformat(7), sortbib(1), mkey(1), inv(1), hunt(1), and Some application of Inverted Indexes in the UNIX System by M. E. Lesk.
NOTES
Blank spaces at the end of lines in bibliography fields will cause the records to sort and reverse incorrectly. Sorting large numbers of references causes a core dump.
LICENSE
Refer is distributed under the cddl license. This manual page is distributed under the bsd4 license
AUTHORS
Written by Mike Lesk, modified by Pierre-Jean Fichet.