diff options
Diffstat (limited to 'contrib/groff/src/preproc/refer/refer.man')
| -rw-r--r-- | contrib/groff/src/preproc/refer/refer.man | 310 |
1 files changed, 246 insertions, 64 deletions
diff --git a/contrib/groff/src/preproc/refer/refer.man b/contrib/groff/src/preproc/refer/refer.man index d39d85d8598f..0881657d4044 100644 --- a/contrib/groff/src/preproc/refer/refer.man +++ b/contrib/groff/src/preproc/refer/refer.man @@ -1,5 +1,6 @@ .ig -Copyright (C) 1989-2000, 2001, 2002, 2003 Free Software Foundation, Inc. +Copyright (C) 1989-2000, 2001, 2002, 2003, 2004, 2005 + Free Software Foundation, Inc. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice @@ -16,23 +17,37 @@ versions, except that this permission notice may be included in translations approved by the Free Software Foundation instead of in the original English. .. +. +. .de TQ -.br -.ns -.TP \\$1 +. 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" +. 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 @@ -40,10 +55,12 @@ the original English. .in +\w'\fB@g@refer 'u .ti \niu .B @g@refer +. .de OP -.ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]" -.el .RB "[\ " "\\$1" "\ ]" +. ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]" +. el .RB "[\ " "\\$1" "\ ]" .. +. .OP \-benvCPRS .OP \-a n .OP \-c fields @@ -51,16 +68,20 @@ the original English. .OP \-i fields .OP \-k field .OP \-l m,n -.OP \-p filename +.OP \-p \%filename .OP \-s fields .OP \-t n .OP \-B field.macro -.RI [\ filename \|.\|.\|.\ ] +.RI [\ \%filename \|.\|.\|.\ ] .br .ad \na -.PP +. +.LP It is possible to have whitespace between a command line option and its parameter. +. +. +. .SH DESCRIPTION This file documents the GNU version of .BR refer , @@ -72,13 +93,14 @@ to the standard output, except that lines between .B .[ and -.B .] +.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 @@ -87,6 +109,7 @@ 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 @@ -111,14 +134,17 @@ 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. +as commands is a new feature of GNU +.BR refer . Documents making use of this feature can still be processed by Unix refer just by adding the lines +. .RS .LP .nf @@ -129,6 +155,7 @@ Unix refer just by adding the lines .ft .fi .RE +. to the beginning of the document. This will cause .B troff @@ -139,6 +166,7 @@ and 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 @@ -154,110 +182,145 @@ so that filenames and line numbers in the messages and 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): +. +.nr a \n(.j +.ad l .TP .B \-b -.B -no-label-in-text; no-label-in-reference +.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-punctuation +. .TP .B \-S .B -label "(A.n|Q) ', ' (D.y|D)"; bracket-label " (" ) "; " +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 +.ad \na +. .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 +.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. @@ -272,11 +335,12 @@ 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. +.B Jr.\& at the end, it should be separated from the last name by a comma. There can be multiple occurrences of the @@ -285,15 +349,18 @@ field. The order is significant. It is a good idea always to supply an .B A -field or 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. @@ -308,6 +375,7 @@ if the date is unknown, a value such as 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. @@ -319,33 +387,42 @@ fields and 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. @@ -355,23 +432,29 @@ 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 @@ -379,6 +462,7 @@ and .BR E , if there is more than one occurrence 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 character to be accented. This means that the @@ -390,18 +474,21 @@ 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 +.I "flags keywords" .br .I fields .br .BI .] closing-text .RE +. .LP The .IR opening-text , @@ -414,6 +501,7 @@ Only one of the and .I fields components need be specified. +. .LP The .I keywords @@ -421,6 +509,7 @@ 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 @@ -432,6 +521,7 @@ 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 @@ -451,6 +541,7 @@ and .B ] flags. Note that leading and trailing spaces are significant for these components. +. .LP The .I flags @@ -460,6 +551,7 @@ 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 @@ -474,6 +566,7 @@ 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 @@ -481,6 +574,7 @@ Precede with the first string specified in the .B bracket-label command. +. .TP .B ] Follow @@ -488,6 +582,7 @@ Follow with the second string specified in the .B bracket-label command. +. .LP One advantages of using the .B [ @@ -503,6 +598,7 @@ you can change the style of bracket used in the document just by changing the 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 @@ -511,6 +607,7 @@ 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. @@ -546,6 +643,8 @@ 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 @@ -564,8 +663,9 @@ nor lines, nor anything between them is output. +. .LP -Commands are separated by newlines or +Commands are separated by newlines or .BR ; s. .B # introduces a comment that extends to the end of the line @@ -597,6 +697,7 @@ A line can be continued by ending it with .BR \e ; this works everywhere except after a .BR # . +. .LP .ds n \fR* Each command @@ -609,6 +710,7 @@ 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 @@ -623,6 +725,7 @@ are used for a non-negative numbers; 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 @@ -647,6 +750,7 @@ 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 @@ -659,12 +763,14 @@ If .I string is omitted it defaults to .BR \- . +. .TP .B accumulate\*n Accumulate references instead of writing out each reference as it is encountered. Accumulated references will be written out whenever a reference of the form +. .RS .IP .B .[ @@ -672,6 +778,7 @@ of the form .B $LIST$ .br .B .] +. .LP is encountered, after all input files hve been processed, @@ -679,14 +786,17 @@ and whenever .B .R1 line is recognized. .RE +. .TP .BI annotate\*n\ field\ string .I field is an annotation; print it at the end of the reference as a paragraph preceded by the line +. .RS .IP .BI . string +. .LP If .I macro @@ -698,9 +808,10 @@ is also omitted it will default to .BR X . Only one field can be an annotation. .RE +. .TP -.BI articles\ string \fR\|.\|.\|. -.IR string \|.\|.\|. +.BI articles\ string \fR\|.\|.\|. +.IR string \|.\|.\|.\& are definite or indefinite articles, and should be ignored at the beginning of .B T fields when sorting. @@ -709,11 +820,16 @@ Initially, .B a and .B an -are recognized as articles. +are recognized as articles. +. .TP .BI bibliography\ filename \fR\|.\|.\|. Write out all the references contained in the bibliographic databases .IR filename \|.\|.\|. +This command should come last in a +.BR .R1 / .R2 +block. +. .TP .BI bracket-label\ string1\ string2\ string3 In the text, bracket each label @@ -728,16 +844,19 @@ immediately followed by will be turned into .IR string3 . The default behaviour is +. .RS .IP .B bracket-label \e*([. \e*(.] ", " .RE +. .TP .BI capitalize\ fields Convert .I fields to caps and small caps. +. .TP .B compatible\*n Recognize @@ -745,6 +864,7 @@ Recognize and .B .R2 even when followed by a character other than space or newline. +. .TP .BI database\ filename \fR\|.\|.\|. Search the bibliographic databases @@ -757,6 +877,7 @@ created by .BR @g@indxbib (@MAN1EXT@) exists, then it will be searched instead; each index can cover multiple databases. +. .TP .BI date-as-label\*n\ string .I string @@ -775,26 +896,30 @@ In most cases you should also use the .B no-label-in-reference command. For example, +. .RS .IP -.B -date-as-label D.+yD.y%a*D.-y +.B "date-as-label D.+yD.y%a*D.-y" +. .LP would attach a disambiguating letter to the year part of the .B D field in the reference. .RE +. .TP .B default-database\*n The default database should be searched. This is the default behaviour, so the negative version of this command is more useful. -refer determines whether the default database should be searched +.B refer +determines whether the default database should be searched on the first occasion that it needs to do a search. Thus a .B no-default-database command must be given before then, in order to be effective. +. .TP .BI discard\*n\ fields When the reference is read, @@ -807,11 +932,11 @@ Initially, .I fields are .BR XYZ . +. .TP .BI et-al\*n\ string\ m\ n Control use of -.B -et al +.B "et al" in the evaluation of .B @ expressions in label expressions. @@ -833,16 +958,19 @@ and is not less than .IR n . The default behaviour is +. .RS .IP .B et-al " et al" 2 3 .RE +. .TP .BI include\ filename Include .I filename and interpret the contents as commands. +. .TP .BI join-authors\ string1\ string2\ string3 This says how authors should be joined together. @@ -863,13 +991,16 @@ if is also omitted it will also default to .IR string1 . For example, +. .RS .IP .B join-authors " and " ", " ", and " +. .LP will restore the default method for joining authors. .RE +. .TP .B label-in-reference\*n When outputting the reference, @@ -878,6 +1009,7 @@ define the string to be the reference's label. This is the default behaviour; so the negative version of this command is more useful. +. .TP .B label-in-text\*n For each reference output a label in the text. @@ -886,10 +1018,12 @@ The label will be separated from the surrounding text as described in the command. This is the default behaviour; so the negative version of this command is more useful. +. .TP .BI label\ string .I string is a label expression describing how to label each reference. +. .TP .BI separate-label-second-parts\ string When merging two-part labels, separate the second part of the second @@ -898,11 +1032,13 @@ label from the first label with See the description of the .B <> label expression. +. .TP .B move-punctuation\*n 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. +. .TP .BI reverse\*n\ string Reverse the fields whose names @@ -911,6 +1047,7 @@ are in 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. +. .TP .BI search-ignore\*n\ fields While searching for keys in databases for which no index exists, @@ -919,6 +1056,7 @@ ignore the contents of Initially, fields .B XYZ are ignored. +. .TP .BI search-truncate\*n\ n Only require the first @@ -930,7 +1068,8 @@ words in the database are truncated to the maximum of and the length of the key. Initially .I n -is 6. +is\ 6. +. .TP .BI short-label\*n\ string .I string @@ -946,6 +1085,7 @@ The .B short-label command will typically be used to specify a label containing just a date and possibly a disambiguating letter. +. .TP .BI sort\*n\ string Sort references according to @@ -956,14 +1096,14 @@ should be a list of field names, each followed by a number, indicating how many fields with the name should be used for sorting. .B + can be used to indicate that all the fields with the name should be used. -Also -.B . +Also +.B .\& can be used to indicate the references should be sorted using the (tentative) label. (The -.B -Label expressions +.B "Label expressions" subsection describes the concept of a tentative label.) +. .TP .B sort-adjacent-labels\*n Sort labels that are adjacent in the text according to their @@ -975,13 +1115,15 @@ or if the label expression contains a .B <> expression. This will have no effect unless references are being accumulated. +. +. .SS Label expressions +. .LP -Label expressions can be evaluated both normally and tentatively. -The result of normal evaluation is used for output. +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 -.I -tentative label, +.IR "tentative label" , is used to gather the information that normal evaluation needs to disambiguate the label. Label expressions specified by the @@ -995,9 +1137,10 @@ of expression other than .BR * , and .B % -expressions. +expressions. The description below applies to normal evaluation, -except where otherwise specified. +except where otherwise specified. +. .TP .I field .TQ @@ -1005,15 +1148,17 @@ except where otherwise specified. The .IR n -th part of -.IR field . +.IR field . If .I n -is omitted, it defaults to 1. +is omitted, it defaults to\ 1. +. .TP .BI ' string ' The characters in .I string -literally. +literally. +. .TP .B @ All the authors joined as specified by the @@ -1056,6 +1201,7 @@ 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. +. .TP .BI % n .TQ @@ -1068,10 +1214,11 @@ will have the same representation. .B %I The serial number of the reference formatted according to the character following the -.BR % . -The serial number of a reference is 1 plus the number of earlier references +.BR % . +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. +. .TP .IB expr * If there is another reference with the same tentative label as @@ -1079,6 +1226,7 @@ this reference, then .IR expr , otherwise an empty string. It tentatively evaluates to an empty string. +. .TP .IB expr + n .TQ @@ -1094,22 +1242,27 @@ Troff special characters (such as .BR \e('a ) count as a single letter. Accent strings are retained but do not count towards the total. +. .TP .IB expr .l .I expr -converted to lowercase. +converted to lowercase. +. .TP .IB expr .u .I expr -converted to uppercase. +converted to uppercase. +. .TP .IB expr .c .I expr -converted to caps and small caps. +converted to caps and small caps. +. .TP .IB expr .r .I expr reversed so that the last name is first. +. .TP .IB expr .a .I expr @@ -1121,10 +1274,12 @@ Thus .B .a is useful only when you want a field to be abbreviated in a label but not in a reference. +. .TP .IB expr .y The year part of -.IR expr . +.IR expr . +. .TP .IB expr .+y The part of @@ -1132,6 +1287,7 @@ The part of before the year, or the whole of .I expr if it does not contain a year. +. .TP .IB expr .\-y The part of @@ -1139,10 +1295,12 @@ The part of after the year, or an empty string if .I expr does not contain a year. +. .TP .IB expr .n The last name part of -.IR expr . +.IR expr . +. .TP .IB expr1 \(ti expr2 .I expr1 @@ -1151,13 +1309,15 @@ except that if the last character of is .B \- then it will be replaced by -.IR expr2 . +.IR expr2 . +. .TP .I expr1\ expr2 The concatenation of .I expr1 and -.IR expr2 . +.IR expr2 . +. .TP .IB expr1 | expr2 If @@ -1165,7 +1325,8 @@ If is non-empty then .I expr1 otherwise -.IR expr2 . +.IR expr2 . +. .TP .IB expr1 & expr2 If @@ -1174,6 +1335,7 @@ is non-empty then .I expr2 otherwise an empty string. +. .TP .IB expr1 ? expr2 : expr3 If @@ -1182,7 +1344,8 @@ is non-empty then .I expr2 otherwise -.IR expr3 . +.IR expr3 . +. .TP .BI < expr > The label is in two parts, which are separated by @@ -1198,11 +1361,13 @@ Note that it is permissible for the first part to be empty; this maybe desirable for expressions used in the .B short-label command. +. .TP .BI ( expr ) The same as .IR expr . Used for grouping. +. .LP The above expressions are listed in order of precedence (highest first); @@ -1210,6 +1375,8 @@ The above expressions are listed in order of precedence and .B | have the same precedence. +. +. .SS Macro interface Each reference starts with a call to the macro .BR ]- . @@ -1227,7 +1394,7 @@ corresponds to field .IR X . The number register .B [P -is set to 1 if the +is set to\ 1 if the .B P field contains a range of pages. The @@ -1235,7 +1402,7 @@ The .B [A and .B [O -number registers are set to 1 according as the +number registers are set to\ 1 according as the .BR T , .B A and @@ -1244,7 +1411,7 @@ fields end with one of the characters .BR .?! . The .B [E -number register will be set to 1 if the +number register will be set to\ 1 if the .B [E string contains more than one name. The reference is followed by a call to the @@ -1254,19 +1421,19 @@ The first argument to this macro gives a number representing the type of the reference. If a reference contains a .B J -field, it will be classified as type 1, +field, it will be classified as type\ 1, otherwise if it contains a .B B -field, it will type 3, +field, it will type\ 3, otherwise if it contains a .B G or .B R -field it will be type 4, +field it will be type\ 4, otherwise if contains a .B I -field it will be type 2, -otherwise it will be type 0. +field it will be type\ 2, +otherwise it will be type\ 0. The second argument is a symbolic name for the type: .BR other , .BR journal-article , @@ -1282,22 +1449,37 @@ command are preceded by a call to the macro and followed by a call to the .B ]> macro. +. +. +. .SH FILES +. .Tp \w'\fB@DEFAULT_INDEX@'u+2n .B @DEFAULT_INDEX@ Default database. +. .TP .IB file @INDEX_SUFFIX@ Index files. +. +. +. .SH ENVIRONMENT +. .Tp \w'\fBREFER'u+2n .B REFER If set, overrides the default database. +. +. +. .SH "SEE ALSO" .BR @g@indxbib (@MAN1EXT@), .BR @g@lookbib (@MAN1EXT@), .BR lkbib (@MAN1EXT@) .br +. +. +. .SH BUGS In label expressions, .B <> |