|
|
1.1 ! root 1: .TH REFER 1 "18 July 1983" ! 2: .UC 4 ! 3: .SH NAME ! 4: refer \- find and insert literature references in documents ! 5: .SH SYNOPSIS ! 6: .B refer ! 7: [ ! 8: .B \-a ! 9: ] [ ! 10: .B \-b ! 11: ] [ ! 12: .B \-c ! 13: ] [ ! 14: .B \-e ! 15: ] [ ! 16: .BI \-f n ! 17: ] [ ! 18: .BI \-k x ! 19: ] [ ! 20: .BI \-l m,n ! 21: ] [ ! 22: .B \-n ! 23: ] [ ! 24: .B \-p ! 25: bib ! 26: ] [ ! 27: .BI \-s keys ! 28: ] [ ! 29: .BI \-B l.m ! 30: ] [ ! 31: .B \-P ! 32: ] [ ! 33: .B \-S ! 34: ] [ file ... ] ! 35: .SH DESCRIPTION ! 36: .I Refer ! 37: is a preprocessor for ! 38: .I nroff ! 39: or ! 40: .IR troff (1) ! 41: that finds and formats references for footnotes or endnotes. ! 42: It is also the base for a series of programs designed to ! 43: index, search, sort, and print stand-alone bibliographies, ! 44: or other data entered in the appropriate form. ! 45: .PP ! 46: Given an incomplete citation with sufficiently precise keywords, ! 47: .I refer ! 48: will search a bibliographic database for references ! 49: containing these keywords anywhere in the title, author, journal, etc. ! 50: The input file (or standard input) ! 51: is copied to standard output, ! 52: except for lines between .[ and .] delimiters, ! 53: which are assumed to contain keywords, ! 54: and are replaced by information from the bibliographic database. ! 55: The user may also search different databases, ! 56: override particular fields, or add new fields. ! 57: The reference data, from whatever source, are assigned to a set of ! 58: .I troff ! 59: strings. ! 60: Macro packages such as ! 61: .IR ms (7) ! 62: print the finished reference text from these strings. ! 63: By default references are flagged by footnote numbers. ! 64: .PP ! 65: The following options are available: ! 66: .TP 6 ! 67: .BI \-a r ! 68: Reverse the first ! 69: .I n ! 70: author names (Jones, J. A. instead of J. A. Jones). ! 71: If ! 72: .I n ! 73: is omitted all author names are reversed. ! 74: .ns ! 75: .TP ! 76: .B \-b ! 77: Bare mode: do not put any flags in text (neither numbers nor labels). ! 78: .ns ! 79: .TP ! 80: .BI \-c keys ! 81: Capitalize (with C\s-2APS\s0 S\s-2MALL\s+2 C\s-2APS\s0) ! 82: the fields whose key-letters are in ! 83: .IR keys . ! 84: .ns ! 85: .TP ! 86: .B \-e ! 87: Instead of leaving the references where encountered, ! 88: accumulate them until a sequence of the form ! 89: .nf ! 90: .[ ! 91: $LIST$ ! 92: .] ! 93: .fi ! 94: is encountered, and then write out all references collected so far. ! 95: Collapse references to same source. ! 96: .ns ! 97: .TP ! 98: .BI \-f n ! 99: Set the footnote number to ! 100: .I n ! 101: instead of the default of 1 (one). ! 102: With labels rather than numbers, ! 103: this flag is a no-op. ! 104: .ns ! 105: .TP ! 106: .BI \-k x ! 107: Instead of numbering references, use labels as specified in a ! 108: reference data line beginning ! 109: .I %x; ! 110: by default ! 111: .I x ! 112: is ! 113: .B L. ! 114: .ns ! 115: .TP ! 116: .BI \-l m , n ! 117: Instead of numbering references, use labels made from ! 118: the senior author's last name and the year of publication. ! 119: Only the first ! 120: .I m ! 121: letters of the last name ! 122: and the last ! 123: .I n ! 124: digits of the date are used. ! 125: If either ! 126: .I m ! 127: or ! 128: .I n ! 129: is omitted the entire name or date respectively is used. ! 130: .ns ! 131: .TP ! 132: .B \-n ! 133: Do not search the default file /usr/dict/papers/Ind. ! 134: If there is a REFER environment variable, ! 135: the specified file will be searched instead of the default file; ! 136: in this case the ! 137: .B \-n ! 138: flag has no effect. ! 139: .ns ! 140: .TP ! 141: .BI \-p \0bib ! 142: Take the next argument ! 143: .I bib ! 144: as a file of references to be searched. ! 145: The default file is searched last. ! 146: .ns ! 147: .TP ! 148: .BI \-s keys ! 149: Sort references by fields whose key-letters are in the ! 150: .I keys ! 151: string; ! 152: permute reference numbers in text accordingly. ! 153: Implies ! 154: .BR \-e . ! 155: The key-letters in ! 156: .I keys ! 157: may be followed by a number to indicate how many such fields ! 158: are used, with ! 159: .B + ! 160: taken as a very large number. ! 161: The default is ! 162: .B AD ! 163: which sorts on the senior author and then date; to sort, for example, ! 164: on all authors and then title use ! 165: .BR -sA+T . ! 166: .ns ! 167: .TP ! 168: .BI \-B l.m ! 169: Bibliography mode. ! 170: Take a file composed of records separated by blank lines, ! 171: and turn them into ! 172: .I troff ! 173: input. ! 174: Label ! 175: .I l ! 176: will be turned into the macro ! 177: .I .m ! 178: with ! 179: .I l ! 180: defaulting to ! 181: .B %X ! 182: and ! 183: .I .m ! 184: defaulting to ! 185: .B .AP ! 186: (annotation paragraph). ! 187: .ns ! 188: .TP ! 189: .B \-P ! 190: Place punctuation marks .,:;?! after the reference signal, ! 191: rather than before. ! 192: (Periods and commas used to be done with strings.) ! 193: .ns ! 194: .TP ! 195: .B \-S ! 196: Produce references in the Natural or Social Science format. ! 197: .PP ! 198: To use your own references, ! 199: put them in the format described below. ! 200: They can be searched more rapidly by running ! 201: .IR indxbib (1) ! 202: on them before using ! 203: .I refer; ! 204: failure to index results in a linear search. ! 205: When ! 206: .I refer ! 207: is used with the ! 208: .I eqn, ! 209: .I neqn ! 210: or ! 211: .I tbl ! 212: preprocessors ! 213: .I refer ! 214: should be first, to minimize the volume ! 215: of data passed through pipes. ! 216: .PP ! 217: The ! 218: .I refer ! 219: preprocessor and associated programs ! 220: expect input from a file of references ! 221: composed of records separated by blank lines. ! 222: A record is a set of lines (fields), ! 223: each containing one kind of information. ! 224: Fields start on a line beginning with a ``%'', ! 225: followed by a key-letter, then a blank, ! 226: and finally the contents of the field, ! 227: and continue until the next line starting with ``%''. ! 228: The output ordering and formatting of fields ! 229: is controlled by the macros specified for ! 230: .I nroff/troff ! 231: (for footnotes and endnotes) or ! 232: .I roffbib ! 233: (for stand-alone bibliographies). ! 234: For a list of the most common key-letters ! 235: and their corresponding fields, see ! 236: .IR addbib (1). ! 237: An example of a ! 238: .I refer ! 239: entry is given below. ! 240: .SH EXAMPLE ! 241: .PP ! 242: .nf ! 243: %A M. E. Lesk ! 244: %T Some Applications of Inverted Indexes on the \s-1UNIX\s0 System ! 245: %B \s-1UNIX\s0 Programmer's Manual ! 246: %V 2b ! 247: %I Bell Laboratories ! 248: %C Murray Hill, NJ ! 249: %D 1978 ! 250: .fi ! 251: .SH FILES ! 252: .ta \w'/usr/dict/papers\0\0'u ! 253: /usr/dict/papers directory of default publication lists ! 254: .br ! 255: /usr/lib/refer directory of companion programs ! 256: .SH SEE ALSO ! 257: addbib(1), sortbib(1), roffbib(1), indxbib(1), lookbib(1) ! 258: .SH AUTHOR ! 259: Mike Lesk ! 260: .SH BUGS ! 261: Blank spaces at the end of lines in bibliography fields ! 262: will cause the records to sort and reverse incorrectly. ! 263: Sorting large numbers of references causes a core dump.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.