refer.man

早期freebsd实现

.\" -*- nroff -*-
.de TQ
.br
.ns
.TP \\$1
..
.\" Like TP, but if specified indent is more than half
.\" the current line-length - indent, use the default indent.
.de Tp
.ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
.el .TP "\\$1"
..
.\" The BSD man macros can't handle " in arguments to font change macros,
.\" so use \(ts instead of ".
.tr \(ts"
.TH @G@REFER @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
.SH NAME
@g@refer \- preprocess bibliographic references for groff
.SH SYNOPSIS
.nr a \n(.j
.ad l
.nr i \n(.i
.in +\w'\fB@g@refer 'u
.ti \niu
.B @g@refer
.de OP
.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
.el .RB "[\ " "\\$1" "\ ]"
..
.OP \-benvCPRS
.OP \-a n
.OP \-c fields
.OP \-f n
.OP \-i fields
.OP \-k field
.OP \-l m,n
.OP \-p filename
.OP \-s fields
.OP \-t n
.OP \-B field.macro
.RI [\  filename \|.\|.\|.\ ]
.br
.ad \na
.SH DESCRIPTION
This file documents the GNU version of
.BR refer ,
which is part of the groff document formatting system.
.B refer
copies the contents of
.IR filename \|.\|.\|.
to the standard output,
except that lines between
.B .[
and
.B .]
are interpreted as citations,
and lines between
.B .R1
and
.B .R2
are interpreted as commands about how citations are to be processed.
.LP
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.
.LP
For each citation,
.B 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
.B groff
commands that can be used by a macro package to produce a formatted
reference for each citation.
The output of
.B refer
must therefore be processed using a suitable macro package.
The
.B \-ms
and
.B \-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.
.LP
The interpretation of lines between
.B .R1
and
.B .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
.RS
.LP
.nf
.ft B
\&.de R1
\&.ig R2
\&..
.ft
.fi
.RE
to the beginning of the document.
This will cause
.B troff
to ignore everything between
.B .R1
and
.BR .R2 .
The effect of some commands can also be achieved by options.
These options are supported mainly for compatibility with Unix refer.
It is usually more convenient to use commands.
.LP
.B refer
generates
.B .lf
lines so that filenames and line numbers in messages produced
by commands that read
.B refer
output will be correct;
it also interprets lines beginning with
.B .lf
so that filenames and line numbers in the messages and
.B .lf
lines that it produces will be accurate even if the input has been
preprocessed by a command such as
.BR @g@soelim (@MAN1EXT@).
.SH OPTIONS
.LP
Most options are equivalent to commands
(for a description of these commands see the
.B Commands
subsection):
.TP
.B \-b
.B
no-label-in-text; no-label-in-reference
.TP
.B \-e
.B accumulate
.TP
.B \-n
.B no-default-database
.TP
.B \-C
.B compatible
.TP
.B \-P
.B move-puntuation
.TP
.B \-S
.B
label "(A.n|Q) ', ' (D.y|D)"; bracket-label " (" ) "; "
.TP
.BI \-a n
.B reverse
.BI A n
.TP
.BI \-c fields
.B capitalize
.I fields
.TP
.BI \-f n
.B label
.BI % n
.TP
.BI \-i fields
.B search-ignore
.I fields
.TP
.B \-k
.B label
.B L\(ti%a
.TP
.BI \-k field
.B label
.IB field \(ti%a
.TP
.B \-l
.B label
.BI A.nD.y%a
.TP
.BI \-l m
.B label
.BI A.n+ m D.y%a
.TP
.BI \-l, n
.B label
.BI A.nD.y\- n %a
.TP
.BI \-l m , n
.B label
.BI A.n+ m D.y\- n %a
.TP
.BI \-p filename
.B database
.I filename
.TP
.BI \-s spec
.B sort
.I spec
.TP
.BI \-t n
.B search-truncate
.I n
.LP
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
.B bibliography
command instead of in the normal way:
.TP
.B \-B
.B
annotate X AP; no-label-in-reference
.TP
.BI \-B field . macro
.B annotate
.I field
.IB macro ;
.B no-label-in-reference
.LP
The following options have no equivalent commands:
.TP
.B \-v
Print the version number.
.TP
.B \-R
Don't recognize lines beginning with
.BR .R1 / .R2 .
.SH USAGE
.SS Bibliographic databases
The bibliographic database is a text file consisting of records
separated by one or more blank lines.
Within each record fields start with a
.B %
at the beginning of a line.
Each field has a one character name that immediately follows the
.BR % .
It is best to use only upper and lower case letters for the names
of fields.
The name of the field should be followed by exactly one space,
and then by the contents of the field.
Empty fields are ignored.
The conventional meaning of each field is as follows:
.TP
.B A
The name of an author.
If the name contains a title such as
.B Jr.
at the end,
it should be separated from the last name by a comma.
There can be multiple occurences of the
.B A
field.
The order is siginificant.
It is a good idea always to supply an
.B A
field or a 
.B Q
field.
.TP
.B B
For an article that is part of a book, the title of the book
.TP
.B C
The place (city) of publication.
.TP
.B D
The date of publication.
The year should be specified in full.
If the month is specified, the name rather than the number of the month
should be used, but only the first three letters are required.
It is a good idea always to supply a
.B D
field;
if the date is unknown, a value such as
.B in press
or
.B unknown
can be used.
.TP
.B E
For an article that is part of a book, the name of an editor of the book.
Where the work has editors and no authors,
the names of the editors should be given as
.B A
fields and
.B ,\ (ed)
or
.B ,\ (eds)
should be appended to the last author.
.TP
.B G
US Government ordering number.
.TP
.B I
The publisher (issuer).
.TP
.B J
For an article in a journal, the name of the journal.
.TP
.B K
Keywords to be used for searching.
.TP
.B L
Label.
.TP
.B N
Journal issue number.
.TP
.B O
Other information.
This is usually printed at the end of the reference.
.TP
.B P
Page number.
A range of pages can be specified as
.IB m \- n\fR.
.TP
.B Q
The name of the author, if the author is not a person.
This will only be used if there are no
.B A
fields.
There can only be one
.B Q
field.
.TP
.B R
Technical report number.
.TP
.B S
Series name.
.TP
.B T
Title.
For an article in a book or journal,
this should be the title of the article.
.TP
.B V
Volume number of the journal or book.
.TP
.B X
Annotation.
.LP
For all fields except
.B A
and
.BR E ,
if there is more than one occurence of a particular field in a record,
only the last such field will be used.
.LP
If accent strings are used, they should follow the charater to be accented.
This means that the
.B AM
macro must be used with the
.B \-ms
macros.
Accent strings should not be quoted:
use one
.B \e
rather than two.
.SS Citations
The format of a citation is
.RS
.BI .[ opening-text
.br
.I
flags keywords
.br
.I fields
.br
.BI .] closing-text
.RE
.LP
The
.IR opening-text ,
.IR closing-text
and
.I flags
components are optional.
Only one of the
.I keywords
and
.I fields
components need be specified.
.LP
The
.I keywords
component says to search the bibliographic databases for a reference
that contains all the words in
.IR keywords .
It is an error if more than one reference if found.
.LP
The
.I fields
components specifies additional fields to replace or supplement
those specified in the reference.
When references are being accumulated and the
.I 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.
.LP
The
.I opening-text
and
.I closing-text
component specifies strings to be used to bracket the label instead
of the strings specified in the
.B bracket-label
command.
If either of these components is non-empty,
the strings specified in the
.B bracket-label
command will not be used;
this behaviour can be altered using the
.B [
and
.B ]
flags.
Note that leading and trailing spaces are significant for these components.
.LP
The
.I 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:
.TP
.B #
This says to use the label specified by the
.B short-label
command,
instead of that specified by the
.B label
command.
If no short label has been specified, the normal label will be used.
Typically the short label is used with author-date labels
and consists of only the date and possibly a disambiguating letter;
the
.B #
is supposed to be suggestive of a numeric type of label.
.TP
.B [
Precede
.I opening-text
with the first string specified in the
.B bracket-label
command.
.TP
.B ]
Follow
.I closing-text
with the second string specified in the
.B bracket-label
command.
.LP
One advantages of using the
.B [
and
.B ]
flags rather than including the brackets in
.I opening-text
and
.I closing-text
is that
you can change the style of bracket used in the document just by changing the
.B bracket-label
command.
Another advantage is that sorting and merging of citations
will not necessarily be inhibited if the flags are used.
.LP
If a label is to be inserted into the text,
it will be attached to the line preceding the
.B .[
line.
If there is no such line, then an extra line will be inserted before the
.B .[
line and a warning will be given.
.LP
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
.B <>
label expression, and of the
.B sort-adjacent-labels
and
.B abbreviate-label-ranges
command.
A label will not be merged if its citation has a non-empty
.I opening-text
or
.IR closing-text .
However, the labels for a citation using the
.B ]
flag and without any
.I closing-text
immediately followed by a citation using the
.B [
flag and without any
.I opening-text
may be sorted and merged
even though the first citation's
.I opening-text
or the second citation's
.I closing-text
is non-empty.
(If you wish to prevent this just make the first citation's
.I closing-text
.BR \e& .)
.SS Commands
Commands are contained between lines starting with
.B .R1
and
.BR .R2 .
Recognition of these lines can be prevented by the
.B \-R
option.
When a
.B .R1
line is recognized any accumulated references are flushed out.
Neither
.B .R1
nor
.B .R2
lines,
nor anything between them
is output.
.LP
Commands are separated by newlines or 
.BR ; s.
.B #
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
.B \(ts
extends to the next
.B \(ts
that is not followed by another
.BR \(ts .
If there is no such
.B \(ts
the word extends to the end of the line.
Pairs of
.B \(ts
in a word beginning with
.B \(ts
collapse to a single
.BR \(ts .
Neither
.B #
nor
.B ;
are recognized inside
.BR \(ts s.
A line can be continued by ending it with
.BR \e ;
this works everywhere except after a
.BR # .
.LP
.ds n \fR*
Each command
.I name
that is marked with \*n has an associated negative command
.BI no- name
that undoes the effect of
.IR name .
For example, the
.B no-sort
command specifies that references should not be sorted.
The negative commands take no arguments.
.LP
In the following description each argument must be a single word;
.I field
is used for a single upper or lower case letter naming a field;
.I fields
is used for a sequence of such letters;
.I m
and
.I n
are used for a non-negative numbers;
.I string
is used for an arbitrary string;
.I filename
is used for the name of a file.
.Tp \w'\fBabbreviate-label-ranges'u+2n
.BI abbreviate\*n\  fields\ string1\ string2\ string3\ string4
Abbreviate the first names of
.IR fields .
An initial letter will be separated from another initial letter by
.IR string1 ,
from the last name by
.IR string2 ,
and from anything else
(such as a
.B von
or
.BR de )
by
.IR string3 .
These default to a period followed by a space.
In a hyphenated first name,
the initial of the first part of the name will be separated from the hyphen by
.IR string4 ;
this defaults to a period.
No attempt is made to handle any ambiguities that might
result from abbreviation.
Names are abbreviated before sorting and before
label construction.
.TP
.BI abbreviate-label-ranges\*n\  string
Three or more adjacent labels that refer to consecutive references
will be abbreviated to a label consisting
of the first label, followed by
.I string
followed by the last label.
This is mainly useful with numeric labels.
If
.I string
is omitted it defaults to
.BR \- .
.TP