|
|
1.1 root 1: .TH REFER 1 alice
2: .CT 1 writing_troff
3: .SH NAME
4: refer, lookbib, pubindex \- maintain and use bibliographic references
5: .SH SYNOPSIS
6: .B refer
7: [
8: .I option ...
9: ]
10: .PP
11: .B lookbib
12: [
13: .I file ...
14: ]
15: .PP
16: .B pubindex
17: .I file ...
18: .SH DESCRIPTION
19: .I Refer
20: is a preprocessor for
21: .I nroff
22: or
23: .IR troff (1)
24: that finds and formats references.
25: The input files (standard input default) are copied to the standard output,
26: except for lines between
27: .L .[
28: and
29: .L .]
30: which are assumed to contain keywords
31: and are replaced by information from the bibliographic data base.
32: The user may avoid the search, override fields from it, or
33: add new fields.
34: The reference data, from whatever source, are assigned to a set of
35: .I troff
36: strings.
37: Macro packages such as
38: .IR ms (6)
39: print the finished reference text from these strings.
40: A flag is placed in the text at the point of reference;
41: by default the references are indicated by numbers.
42: .PP
43: The following options are available:
44: .TP
45: .BI -a r
46: Reverse the first
47: .I r
48: author names (Jones, J. A. instead of J. A. Jones).
49: If
50: .I r
51: is omitted all author names are reversed.
52: .TP
53: .B -b
54: Bare mode: do not put any flags in text (neither numbers nor labels).
55: .TP
56: .BI -c string
57: Capitalize (with C\s-2APS\s0 S\s-2MALL\s+2 C\s-2APS\s0)
58: the fields whose key-letters are in
59: .IR string .
60: .TP
61: .B -e
62: Instead of leaving the references where encountered,
63: accumulate them
64: until a sequence of the form
65: .IP
66: .EX
67: \&.[
68: $LIST$
69: \&.]
70: .EE
71: .IP
72: is encountered, and then write out all references
73: collected so far.
74: Collapse references to the same source.
75: .TP
76: .BI -k x
77: Instead of numbering references, use labels as specified in
78: a
79: reference data line
80: beginning
81: .BI % x;
82: by default
83: .I x
84: is
85: .B L.
86: .TP
87: .BI -l m , n
88: Instead of numbering references, use labels made from
89: the senior author's last name and the year of publication.
90: Only the first
91: .I m
92: letters of the last name
93: and the last
94: .I n
95: digits of the date are used.
96: If either
97: .I m
98: or
99: .I n
100: is omitted the entire name or date respectively is used.
101: .TP
102: .B -p
103: Take the next argument as a file of
104: references to be searched.
105: The default file is searched last.
106: .TP
107: .B -n
108: Do not search the default file.
109: .TP
110: .BI -s keys
111: Sort references by fields whose key-letters are in
112: the
113: .I keys
114: string;
115: permute
116: reference numbers in text accordingly.
117: Implies
118: .BR -e .
119: The key-letters in
120: .I keys
121: may be followed by a number to indicate how many such fields
122: are used, with
123: .B +
124: taken as a very large number.
125: The default is
126: .B AD
127: which sorts on the senior author and then date; to sort, for example,
128: on all authors and then title use
129: .BR -sA+T .
130: .PP
131: A bibliographic reference in a
132: .B -p
133: file is a set of lines
134: that contain bibliographic information fields.
135: Empty lines separate references.
136: Each field starts on a line beginning with
137: .LR % ,
138: followed
139: by a key-letter, followed by a blank, and followed by the
140: contents of the field, which continues until the next line
141: starting with
142: .LR % .
143: The most common key-letters and the corresponding fields are:
144: .TP
145: .L A
146: Author name
147: .PD0
148: .TP
149: .L B
150: Title of book containing article referenced
151: .TP
152: .L C
153: City
154: .TP
155: .L D
156: Date
157: .TP
158: .L d
159: Alternate date
160: .TP
161: .L E
162: Editor of book containing article referenced
163: .TP
164: .L G
165: Government (CFSTI) order number
166: .TP
167: .L I
168: Issuer (publisher)
169: .TP
170: .L J
171: Journal
172: .TP
173: .L K
174: Other keywords to use in locating reference
175: .TP
176: .L M
177: Technical memorandum number
178: .TP
179: .L N
180: Issue number within volume
181: .TP
182: .L O
183: Other commentary to be printed at end of reference
184: .TP
185: .L P
186: Page numbers
187: .TP
188: .L R
189: Report number
190: .TP
191: .L r
192: Alternate report number
193: .TP
194: .L T
195: Title of article, book, etc.
196: .TP
197: .L V
198: Volume number
199: .TP
200: .L X
201: Commentary unused by
202: .I pubindex
203: .PD
204: .PP
205: Except for
206: .LR A ,
207: each field should only be given once.
208: Only relevant fields should be supplied.
209: When
210: .I refer
211: is used with
212: .I eqn,
213: .I neqn
214: or
215: .IR tbl (1),
216: .I refer
217: should be first, to minimize the volume
218: of data passed through
219: pipes.
220: .PP
221: .I Lookbib
222: accepts keywords from the standard input
223: and searches a bibliographic data base for references
224: that contain those keywords any where in the title, author,
225: journal name, etc.
226: Matching references are printed on the standard output.
227: Blank lines are taken as delimiters between queries.
228: .PP
229: .I Pubindex
230: makes a hashed inverted index to
231: the named bibliographic
232: .I files
233: for use by
234: .I refer.
235: .SH EXAMPLES
236: .EX
237: %T 5-by-5 Palindromic Word Squares
238: %A M. D. McIlroy
239: %J Word Ways
240: %V 9
241: %P 199-202
242: %D 1976
243: .EE
244: .SH FILES
245: .TF /usr/dict/papers
246: .TP
247: .F /usr/dict/papers
248: directory of default publication lists and indexes
249: .TP
250: .F /usr/lib/refer
251: directory of programs
252: .TP
253: .IB x .ia ", x" .ib ", x" .ic
254: where
255: .I x
256: is the first argument to
257: .I pubindex
258: .SH SEE ALSO
259: M. E. Lesk,
260: `Some Applications of Inverted Indexes on UNIX' in
261: AT&T Bell Laboratories,
262: .I UNIX Programmer's Manual, Volume 2,
263: Holt-Rinehart (1984)
264: .br
265: .IR troff (1),
266: .IR doctype (1),
267: .IR prefer (1)
268: .SH BUGS
269: .I Refer
270: is unmaintained; better use
271: .IR prefer (1).
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.