refer | Début | Suivant | Sommaire | Préc.page.lue | Accueil |
NAME | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
SYNOPSIS | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
It is possible to have whitespace between a command line option and its parameter.
DESCRIPTION | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Each citation specifies a reference. The citation can specify a reference that is contained in a bibliographic database by giving a set of keywords that only that reference contains. Alternatively it can specify a reference by supplying a database record in the citation. A combination of these alternatives is also possible.
For each citation, refer can produce a mark in the text. This mark consists of some label which can be separated from the text and from other labels in various ways. For each reference it also outputs groff commands that can be used by a macro package to produce a formatted reference for each citation. The output of refer must therefore be processed using a suitable macro package. The -ms and -me macros are both suitable. The commands to format a citation's reference can be output immediately after the citation, or the references may be accumulated, and the commands output at some later point. If the references are accumulated, then multiple citations of the same reference will produce a single formatted reference.
The interpretation of lines between .R1 and .R2 as commands is a new feature of GNU refer. Documents making use of this feature can still be processed by Unix refer just by adding the lines
.de R1 .ig R2 ..
refer generates .lf lines so that filenames and line numbers in messages produced by commands that read refer output will be correct; it also interprets lines beginning with .lf so that filenames and line numbers in the messages and .lf lines that it produces will be accurate even if the input has been preprocessed by a command such as soelim(1).
OPTIONS | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Most options are equivalent to commands (for a description of these commands see the Commands subsection):
These options are equivalent to the following commands with the addition that the filenames specified on the command line are processed as if they were arguments to the bibliography command instead of in the normal way:
The following options have no equivalent commands:
USAGE | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Bibliographic databases | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
For all fields except A and E, if there is more than one occurrence of a particular field in a record, only the last such field will be used.
If accent strings are used, they should follow the character to be accented. This means that the AM macro must be used with the -ms macros. Accent strings should not be quoted: use one \ rather than two.
Citations | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
The opening-text, closing-text and flags components are optional. Only one of the keywords and fields components need be specified.
The keywords component says to search the bibliographic databases for a reference that contains all the words in keywords. It is an error if more than one reference if found.
The fields components specifies additional fields to replace or supplement those specified in the reference. When references are being accumulated and the keywords component is non-empty, then additional fields should be specified only on the first occasion that a particular reference is cited, and will apply to all citations of that reference.
The opening-text and closing-text component specifies strings to be used to bracket the label instead of the strings specified in the bracket-label command. If either of these components is non-empty, the strings specified in the bracket-label command will not be used; this behaviour can be altered using the [ and ] flags. Note that leading and trailing spaces are significant for these components.
The flags component is a list of non-alphanumeric characters each of which modifies the treatment of this particular citation. Unix refer will treat these flags as part of the keywords and so will ignore them since they are non-alphanumeric. The following flags are currently recognized:
One advantages of using the [ and ] flags rather than including the brackets in opening-text and closing-text is that you can change the style of bracket used in the document just by changing the bracket-label command. Another advantage is that sorting and merging of citations will not necessarily be inhibited if the flags are used.
If a label is to be inserted into the text, it will be attached to the line preceding the .[ line. If there is no such line, then an extra line will be inserted before the .[ line and a warning will be given.
There is no special notation for making a citation to multiple references. Just use a sequence of citations, one for each reference. Don't put anything between the citations. The labels for all the citations will be attached to the line preceding the first citation. The labels may also be sorted or merged. See the description of the <> label expression, and of the sort-adjacent-labels and abbreviate-label-ranges command. A label will not be merged if its citation has a non-empty opening-text or closing-text. However, the labels for a citation using the ] flag and without any closing-text immediately followed by a citation using the [ flag and without any opening-text may be sorted and merged even though the first citation's opening-text or the second citation's closing-text is non-empty. (If you wish to prevent this just make the first citation's closing-text \&.)
Commands | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Commands are separated by newlines or ;s. # introduces a comment that extends to the end of the line (but does not conceal the newline). Each command is broken up into words. Words are separated by spaces or tabs. A word that begins with s extends to the next s that is not followed by another s. If there is no such s the word extends to the end of the line. Pairs of s in a word beginning with s collapse to a single s. Neither # nor ; are recognized inside ss. A line can be continued by ending it with \; this works everywhere except after a #.
Each command name that is marked with * has an associated negative command no-name that undoes the effect of name. For example, the no-sort command specifies that references should not be sorted. The negative commands take no arguments.
In the following description each argument must be a single word; field is used for a single upper or lower case letter naming a field; fields is used for a sequence of such letters; m and n are used for a non-negative numbers; string is used for an arbitrary string; filename is used for the name of a file. u+2n
is encountered, after all input files hve been processed, and whenever .R1 line is recognized.
If macro is omitted it will default to AP; if field is also omitted it will default to X. Only one field can be an annotation.
would attach a disambiguating letter to the year part of the D field in the reference.
will restore the default method for joining authors.
Label expressions | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Label expressions can be evaluated both normally and tentatively. The result of normal evaluation is used for output. The result of tentative evaluation, called the tentative label, is used to gather the information that normal evaluation needs to disambiguate the label. Label expressions specified by the date-as-label and short-label commands are not evaluated tentatively. Normal and tentative evaluation are the same for all types of expression other than @, *, and % expressions. The description below applies to normal evaluation, except where otherwise specified.
The above expressions are listed in order of precedence (highest first); & and | have the same precedence.
Macro interface | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
FILES | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
SEE ALSO | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
BUGS | Début | Précédent | Suivant | Sommaire | Préc.page.lue | Accueil |
Sommaire | Début | Suivant | Sommaire | Préc.page.lue | Accueil |
Table des mots clés | Début | Suivant | Sommaire | Préc.page.lue | Accueil |
# | Citations |
-an | OPTIONS |
-b | OPTIONS |
-Bfield.macro | OPTIONS |
-C | OPTIONS |
-cfields | OPTIONS |
-e | OPTIONS |
-fn | OPTIONS |
-ifields | OPTIONS |
-k | OPTIONS |
-kfield | OPTIONS |
-l | OPTIONS |
-l,n | OPTIONS |
-lm | OPTIONS |
-lm,n | OPTIONS |
-n | OPTIONS |
-P | OPTIONS |
-pfilename | OPTIONS |
-R | OPTIONS |
-S | OPTIONS |
-sspec | OPTIONS |
-tn | OPTIONS |
-v | OPTIONS |
[ | Citations |
] | Citations |
A | Bibliographic databases |
B | Bibliographic databases |
C | Bibliographic databases |
D | Bibliographic databases |
E | Bibliographic databases |
G | Bibliographic databases |
I | Bibliographic databases |
J | Bibliographic databases |
K | Bibliographic databases |
L | Bibliographic databases |
N | Bibliographic databases |
O | Bibliographic databases |
P | Bibliographic databases |
Q | Bibliographic databases |
R | Bibliographic databases |
S | Bibliographic databases |
T | Bibliographic databases |
V | Bibliographic databases |
X | Bibliographic databases |