Manual Pages for UNIX Darwin command on man refer

REFER(1) REFER(1)

NAME

refer - preprocess bibliographic references for groff

SYNOPSIS

rreeffeerr [ -bbeennvvCCPPRRSS ] [ -aan ] [ -ccfields ] [ -ffn ] [ -iifields ]

[ -kkfield ] [ -llm,n ] [ -ppfilename ] [ -ssfields ] [ -ttn ]

[ -BBfield.macro ] [ filename... ]

It is possible to have whitespace between a command line option and its parameter.

DESCRIPTION

This file documents the GNU version of rreeffeerr, which is part of the

groff document formatting system. rreeffeerr copies the contents of file-

name... to the standard output, except that lines between ..[[ and ..]]

are interpreted as citations, and lines between ..RR11 and ..RR22 are inter-

preted as commands about how citations are to be processed.

Each citation specifies a reference. The citation can specify a refer-

ence that is contained in a bibliographic database by giving a set of

keywords that only that reference contains. Alternatively it can spec-

ify a reference by supplying a database record in the citation. A com-

bination of these alternatives is also possible. For each citation, rreeffeerr 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 ggrrooffff

commands that can be used by a macro package to produce a formatted

reference for each citation. The output of rreeffeerr must therefore be

processed using a suitable macro package. The -mmss and -mmee macros are

both suitable. The commands to format a citation's reference can be

output immediately after the citation, or the references may be accumu-

lated, 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 ..RR11 and ..RR22 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

..ddee RR11 ..iigg RR22 .... to the beginning of the document. This will cause ttrrooffff to ignore everything between ..RR11 and ..RR22. The effect of some commands can also

be achieved by options. These options are supported mainly for compat-

ibility with Unix refer. It is usually more convenient to use com-

mands.

rreeffeerr generates ..llff lines so that filenames and line numbers in mes-

sages produced by commands that read rreeffeerr output will be correct; it also interprets lines beginning with ..llff so that filenames and line numbers in the messages and ..llff lines that it produces will be accurate even if the input has been preprocessed by a command such as ssooeelliimm(1). OOPPTTIIOONNSS Most options are equivalent to commands (for a description of these commands see the CCoommmmaannddss subsection):

-bb nnoo-llaabbeell-iinn-tteexxtt;; nnoo-llaabbeell-iinn-rreeffeerreennccee

-ee aaccccuummuullaattee

-nn nnoo-ddeeffaauulltt-ddaattaabbaassee

-CC ccoommppaattiibbllee

-PP mmoovvee-ppuunnccttuuaattiioonn

-SS llaabbeell ""((AA..nn||QQ)) '',, '' ((DD..yy||DD))"";; bbrraacckkeett-llaabbeell "" (("" )) "";; ""

-aan rreevveerrssee AAn

-ccfields

ccaappiittaalliizzee fields

-ffn llaabbeell %%n

-iifields

sseeaarrcchh-iiggnnoorree fields

-kk llaabbeell LL~~%%aa

-kkfield

llaabbeell field~~%%aa

-ll llaabbeell AA..nnDD..yy%%aa

-llm llaabbeell AA..nn++mDD..yy%%aa

-ll,,n llaabbeell AA..nnDD..yy-n%%aa

-llm,,n llaabbeell AA..nn++mDD..yy-n%%aa

-ppfilename

ddaattaabbaassee filename

-ssspec ssoorrtt spec

-ttn sseeaarrcchh-ttrruunnccaattee n

These options are equivalent to the following commands with the addi-

tion that the filenames specified on the command line are processed as if they were arguments to the bbiibblliiooggrraapphhyy command instead of in the normal way:

-BB aannnnoottaattee XX AAPP;; nnoo-llaabbeell-iinn-rreeffeerreennccee

-BBfield..macro

aannnnoottaattee field macro;; nnoo-llaabbeell-iinn-rreeffeerreennccee

The following options have no equivalent commands:

-vv Print the version number.

-RR Don't recognize lines beginning with ..RR11/..RR22.

UUSSAAGGEE BBiibblliiooggrraapphhiicc ddaattaabbaasseess

The bibliographic database is a text file consisting of records sepa-

rated by one or more blank lines. Within each record fields start with

a %% at the beginning of a line. Each field has a one character name

that immediately follows the %%. 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: AA The name of an author. If the name contains a title such as JJrr.. at the end, it should be separated from the last name by a comma. There can be multiple occurrences of the AA field. The order is significant. It is a good idea always to supply an AA field or a QQ field. BB For an article that is part of a book, the title of the book. CC The place (city) of publication. DD 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 DD field; if the date is unknown, a value such as iinn pprreessss or uunnkknnoowwnn can be used. EE 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 AA fields and ,, ((eedd)) or ,, ((eeddss)) should be appended to the last author. GG US Government ordering number. II The publisher (issuer). JJ For an article in a journal, the name of the journal. KK Keywords to be used for searching. LL Label. NN Journal issue number. OO Other information. This is usually printed at the end of the

reference.

PP Page number. A range of pages can be specified as m-n.

QQ The name of the author, if the author is not a person. This will only be used if there are no AA fields. There can only be one QQ field. RR Technical report number. SS Series name. TT Title. For an article in a book or journal, this should be the title of the article. VV Volume number of the journal or book. XX Annotation. For all fields except AA and EE, 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 AAMM macro must be used with the -mmss

macros. Accent strings should not be quoted: use one \\ rather than two. CCiittaattiioonnss The format of a citation is

..[[opening-text

flags keywords fields

..]]closing-text

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 supple-

ment those specified in the reference. When references are being accu-

mulated and the keywords component is non-empty, then additional fields

should be specified only on the first occasion that a particular refer-

ence 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

bbrraacckkeett-llaabbeell command. If either of these components is non-empty, the

strings specified in the bbrraacckkeett-llaabbeell 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:

## This says to use the label specified by the sshhoorrtt-llaabbeell command,

instead of that specified by the llaabbeell command. If no short

label has been specified, the normal label will be used. Typi-

cally the short label is used with author-date labels and con-

sists of only the date and possibly a disambiguating letter; the

## is supposed to be suggestive of a numeric type of label.

[[ Precede opening-text with the first string specified in the

bbrraacckkeett-llaabbeell command.

]] Follow closing-text with the second string specified in the

bbrraacckkeett-llaabbeell command.

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 bbrraacckkeett-

llaabbeell command. Another advantage is that sorting and merging of cita-

tions 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 refer-

ences. Just use a sequence of citations, one for each reference.

Don't put anything between the citations. The labels for all the cita-

tions 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 ssoorrtt-aaddjjaacceenntt-llaabbeellss and aabbbbrreevviiaattee-llaabbeell-

rraannggeess 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 \\&&.)

CCoommmmaannddss

Commands are contained between lines starting with ..RR11 and ..RR22. Recog-

nition of these lines can be prevented by the -RR option. When a ..RR11

line is recognized any accumulated references are flushed out. Neither

..RR11 nor ..RR22 lines, nor anything between them is output.

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 "" extends to the next "" that is not fol-

lowed by another "". If there is no such "" the word extends to the end

of the line. Pairs of "" in a word beginning with "" collapse to a sin-

gle "". Neither ## nor ;; are recognized inside ""s. A line can be con-

tinued by ending it with \\; this works everywhere except after a ##.

Each command name that is marked with * has an associated negative com-

mand nnoo-name that undoes the effect of name. For example, the nnoo-ssoorrtt

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-neg-

ative numbers; string is used for an arbitrary string; filename is used for the name of a file. aabbbbrreevviiaattee* fields string1 string2 string3 string4

Abbreviate the first names of fields. An ini-

tial letter will be separated from another initial letter by string1, from the last name by string2, and from anything else (such as a vvoonn or ddee) by 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 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.

aabbbbrreevviiaattee-llaabbeell-rraannggeess* string

Three or more adjacent labels that refer to

consecutive references will be abbreviated to

a label consisting of the first label, fol-

lowed by string followed by the last label. This is mainly useful with numeric labels. If

string is omitted it defaults to -.

aaccccuummuullaattee* Accumulate references instead of writing out

each reference as it is encountered. Accumu-

lated references will be written out whenever

a reference of the form

..[[

$$LLIISSTT$$

..]] is encountered, after all input files hve been

processed, and whenever ..RR11 line is recog-

nized. aannnnoottaattee* field string field is an annotation; print it at the end of

the reference as a paragraph preceded by the

line ..string If macro is omitted it will default to AAPP; if field is also omitted it will default to XX. Only one field can be an annotation.

aarrttiicclleess string... string... are definite or indefinite arti-

cles, and should be ignored at the beginning of TT fields when sorting. Initially, tthhee, aa and aann are recognized as articles.

bbiibblliiooggrraapphhyy filename... Write out all the references contained in the

bibliographic databases filename...

bbrraacckkeett-llaabbeell string1 string2 string3

In the text, bracket each label with string1

and string2. An occurrence of string2 immedi-

ately followed by string1 will be turned into string3. The default behaviour is

bbrraacckkeett-llaabbeell \\**(([[.. \\**((..]] "",, ""

ccaappiittaalliizzee fields Convert fields to caps and small caps. ccoommppaattiibbllee* Recognize ..RR11 and ..RR22 even when followed by a character other than space or newline. ddaattaabbaassee filename... Search the bibliographic databases filename...

For each filename if an index filename..ii cre-

ated by iinnddxxbbiibb(1) exists, then it will be

searched instead; each index can cover multi-

ple databases.

ddaattee-aass-llaabbeell* string string is a label expression that specifies a

string with which to replace the DD field after

constructing the label. See the LLaabbeell eexxpprreess-

ssiioonnss subsection for a description of label expressions. This command is useful if you do

not want explicit labels in the reference

list, but instead want to handle any necessary disambiguation by qualifying the date in some

way. The label used in the text would typi-

cally be some combination of the author and date. In most cases you should also use the

nnoo-llaabbeell-iinn-rreeffeerreennccee command. For example,

ddaattee-aass-llaabbeell DD..++yyDD..yy%%aa**DD..-yy

would attach a disambiguating letter to the

year part of the DD field in the reference.

ddeeffaauulltt-ddaattaabbaassee* The default database should be searched. This

is the default behaviour, so the negative ver-

sion of this command is more useful. refer

determines whether the default database should be searched on the first occasion that it

needs to do a search. Thus a nnoo-ddeeffaauulltt-ddaattaa-

bbaassee command must be given before then, in order to be effective.

ddiissccaarrdd* fields When the reference is read, fields should be

discarded; no string definitions for fields will be output. Initially, fields are XXYYZZ.

eett-aall* string m n Control use of eett aall in the evaluation of @@

expressions in label expressions. If the num-

ber of authors needed to make the author sequence unambiguous is u and the total number

of authors is t then the last t-u authors will

be replaced by string provided that t-u is not

less than m and t is not less than n. The default behaviour is

eett-aall "" eett aall"" 22 33

iinncclluuddee filename Include filename and interpret the contents as commands.

jjooiinn-aauutthhoorrss string1 string2 string3

This says how authors should be joined together. When there are exactly two authors, they will be joined with string1. When there are more than two authors, all but the last two will be joined with string2, and the last two authors will be joined with string3. If string3 is omitted, it will default to string1; if string2 is also omitted it will also default to string1. For example,

jjooiinn-aauutthhoorrss "" aanndd "" "",, "" "",, aanndd ""

will restore the default method for joining authors.

llaabbeell-iinn-rreeffeerreennccee* When outputting the reference, define the

string [[FF to be the reference's label. This

is the default behaviour; so the negative ver-

sion of this command is more useful.

llaabbeell-iinn-tteexxtt* For each reference output a label in the text.

The label will be separated from the surround-

ing text as described in the bbrraacckkeett-llaabbeell

command. This is the default behaviour; so the negative version of this command is more useful. llaabbeell string string is a label expression describing how to

label each reference.

sseeppaarraattee-llaabbeell-sseeccoonndd-ppaarrttss string

When merging two-part labels, separate the

second part of the second label from the first label with string. See the description of the <<>> label expression.

mmoovvee-ppuunnccttuuaattiioonn* In the text, move any punctuation at the end

of line past the label. It is usually a good idea to give this command unless you are using superscripted numbers as labels. rreevveerrssee* string Reverse the fields whose names are in string. Each field name can be followed by a number which says how many such fields should be reversed. If no number is given for a field, all such fields will be reversed.

sseeaarrcchh-iiggnnoorree* fields While searching for keys in databases for

which no index exists, ignore the contents of fields. Initially, fields XXYYZZ are ignored.

sseeaarrcchh-ttrruunnccaattee* n Only require the first n characters of keys to

be given. In effect when searching for a given key words in the database are truncated to the maximum of n and the length of the key. Initially n is 6.

sshhoorrtt-llaabbeell* string string is a label expression that specifies an

alternative (usually shorter) style of label.

This is used when the ## flag is given in the

citation. When using author-date style

labels, the identity of the author or authors is sometimes clear from the context, and so it may be desirable to omit the author or authors

from the label. The sshhoorrtt-llaabbeell command will

typically be used to specify a label contain-

ing just a date and possibly a disambiguating letter.

ssoorrtt* string Sort references according to ssttrriinngg. Refer-

ences will automatically be accumulated. string should be a list of field names, each followed by a number, indicating how many

fields with the name should be used for sort-

ing. ++ can be used to indicate that all the fields with the name should be used. Also ..

can be used to indicate the references should

be sorted using the (tentative) label. (The LLaabbeell eexxpprreessssiioonnss subsection describes the concept of a tentative label.)

ssoorrtt-aaddjjaacceenntt-llaabbeellss* Sort labels that are adjacent in the text

according to their position in the reference

list. This command should usually be given if

the aabbbbrreevviiaattee-llaabbeell-rraannggeess command has been

given, or if the label expression contains a <<>> expression. This will have no effect

unless references are being accumulated.

LLaabbeell eexxpprreessssiioonnss Label expressions can be evaluated both normally and tentatively. The

result of normal evaluation is used for output. The result of tenta-

tive evaluation, called the tentative label, is used to gather the information that normal evaluation needs to disambiguate the label.

Label expressions specified by the ddaattee-aass-llaabbeell and sshhoorrtt-llaabbeell com-

mands are not evaluated tentatively. Normal and tentative evaluation

are the same for all types of expression other than @@, **, and %% expres-

sions. The description below applies to normal evaluation, except where otherwise specified. field field n

The n-th part of field. If n is omitted, it defaults to 1.

''string'' The characters in string literally.

@@ All the authors joined as specified by the jjooiinn-aauutthhoorrss command.

The whole of each author's name will be used. However, if the

references are sorted by author (that is the sort specification

starts with AA++), then authors' last names will be used instead, provided that this does not introduce ambiguity, and also an initial subsequence of the authors may be used instead of all

the authors, again provided that this does not introduce ambigu-

ity. The use of only the last name for the i-th author of some

reference is considered to be ambiguous if there is some other

reference, such that the first i-1 authors of the references are

the same, the i-th authors are not the same, but the i-th

authors' last names are the same. A proper initial subsequence

of the sequence of authors for some reference is considered to

be ambiguous if there is a reference with some other sequence of

authors which also has that subsequence as a proper initial sub-

sequence. When an initial subsequence of authors is used, the remaining authors are replaced by the string specified by the

eett-aall command; this command may also specify additional require-

ments that must be met before an initial subsequence can be used. @@ tentatively evaluates to a canonical representation of the authors, such that authors that compare equally for sorting purpose will have the same representation.

%%n

%%aa

%%AA

%%ii

%%II The serial number of the reference formatted according to the

character following the %%. The serial number of a reference is

1 plus the number of earlier references with same tentative

label as this reference. These expressions tentatively evaluate

to an empty string.

expr** If there is another reference with the same tentative label as

this reference, then expr, otherwise an empty string. It tenta-

tively evaluates to an empty string. expr++n

expr-n The first (++) or last (-) n upper or lower case letters or dig-

its of expr. Troff special characters (such as \\((''aa) count as a single letter. Accent strings are retained but do not count towards the total. expr..ll expr converted to lowercase. expr..uu expr converted to uppercase. expr..cc expr converted to caps and small caps. expr..rr expr reversed so that the last name is first. expr..aa expr with first names abbreviated. Note that fields specified in the aabbbbrreevviiaattee command are abbreviated before any labels are evaluated. Thus ..aa is useful only when you want a field to be

abbreviated in a label but not in a reference.

expr..yy The year part of expr. expr..++yy The part of expr before the year, or the whole of expr if it does not contain a year.

expr..-yy

The part of expr after the year, or an empty string if expr does not contain a year. expr..nn The last name part of expr. expr1~~expr2

expr1 except that if the last character of expr1 is - then it

will be replaced by expr2. expr1 expr2 The concatenation of expr1 and expr2. expr1||expr2

If expr1 is non-empty then expr1 otherwise expr2.

expr1&&expr2

If expr1 is non-empty then expr2 otherwise an empty string.

expr1??expr2::expr3

If expr1 is non-empty then expr2 otherwise expr3.

<> The label is in two parts, which are separated by expr. Two

adjacent two-part labels which have the same first part will be

merged by appending the second part of the second label onto the

first label separated by the string specified in the sseeppaarraattee-

llaabbeell-sseeccoonndd-ppaarrttss command (initially, a comma followed by a

space); the resulting label will also be a two-part label with

the same first part as before merging, and so additional labels can be merged into it. Note that it is permissible for the first part to be empty; this maybe desirable for expressions

used in the sshhoorrtt-llaabbeell command.

((expr)) The same as expr. Used for grouping. The above expressions are listed in order of precedence (highest first); && and || have the same precedence. MMaaccrroo iinntteerrffaaccee

Each reference starts with a call to the macro ]]-. The string [[FF will

be defined to be the label for this reference, unless the nnoo-llaabbeell-iinn-

rreeffeerreennccee command has been given. There then follows a series of string definitions, one for each field: string [[X corresponds to field X. The number register [[PP is set to 1 if the PP field contains a range of pages. The [[TT, [[AA and [[OO number registers are set to 1 according as

the TT, AA and OO fields end with one of the characters ..??!!. The [[EE num-

ber register will be set to 1 if the [[EE string contains more than one

name. The reference is followed by a call to the ]][[ macro. The first

argument to this macro gives a number representing the type of the ref-

erence. If a reference contains a JJ field, it will be classified as

type 1, otherwise if it contains a BB field, it will type 3, otherwise if it contains a GG or RR field it will be type 4, otherwise if contains a II field it will be type 2, otherwise it will be type 0. The second

argument is a symbolic name for the type: ootthheerr, jjoouurrnnaall-aarrttiiccllee, bbooookk,

aarrttiiccllee-iinn-bbooookk or tteecchh-rreeppoorrtt. Groups of references that have been

accumulated or are produced by the bbiibblliiooggrraapphhyy command are preceded by a call to the ]]<< macro and followed by a call to the ]]>> macro. FILES //uussrr//ddiicctt//ppaappeerrss//IInndd Default database. file..ii Index files. ENVIRONMENT RREEFFEERR If set, overrides the default database.

BUGS

In label expressions, <<>> expressions are ignored inside ..char expres-

sions. Groff Version 1.19.1 16 January 2003 REFER(1)