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