![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to prefer.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Research Unix] / researchv10dc / man / adm / man1|
Return to prefer.1 CVS log | Up to [Research Unix] / researchv10dc / man / adm / man1 |
1.1 root 1: .tr @|
2: .TH PREFER 1
3: .CT 1 writing_troff
4: .SH NAME
5: prefer, pinvert, penter, plook, pconvert \- maintain and use bibliographic references
6: .SH SYNOPSIS
7: .B prefer
8: [
9: .I option ...
10: ]
11: .PP
12: .B penter
13: [
14: .I outfile
15: ]
16: .PP
17: .B pinvert
18: [
19: .I option ...
20: ]
21: [
22: .I file ...
23: ]
24: .PP
25: .B plook
26: [
27: .B -p
28: .I dbfile
29: ]
30: [
31: .I keyword ...
32: ]
33: .PP
34: .B pconvert
35: [
36: .B -d
37: ]
38: .I file
39: .SH DESCRIPTION
40: .I Prefer
41: is a
42: .IR troff (1)
43: preprocessor for bibliographic references.
44: It copies a document from the standard input
45: to the standard output, using a bibliographic database to
46: change symbolic references
47: into full references ready for typesetting by
48: .IR troff (1).
49: Although symbolic references are in the style of
50: .IR monk (1),
51: .I prefer
52: does not depend on
53: .I monk.
54: The options are:
55: .TF dbfile
56: .TP
57: .B -n
58: Format for
59: .IR nroff .
60: .TP
61: .BI -o sortkey
62: Under the
63: .B @reference_list
64: command, sort according to
65: .IR sortkey ,
66: any combinations of the letters
67: .LR a
68: (author)
69: .LR d
70: (date), and
71: .LR t
72: (title),
73: rather than
74: in database sequence.
75: If
76: .I sortkey is
77: .LR sort ,
78: sort according to the current style.
79: .TP
80: .BI -p dbfile
81: Use
82: .I dbfile
83: as the bibliographic database (default
84: .FR prefer.out ).
85: .TP
86: .B -r
87: Format as a released paper
88: (technical memorandum default).
89: .TP
90: .BI -s style
91: Set the formatting
92: .I style ,
93: one of
94: .LR att
95: (default),
96: .LR acm ,
97: .LR apa ,
98: .LR ieee ,
99: .LR lsa ,
100: .LR pami ,
101: .LR spectrum .
102: .PD
103: .PP
104: .I Prefer
105: recognizes the following commands,
106: which may appear anywhere in a document.
107: Parentheses
108: .B ()
109: in the commands
110: may be replaced by any of
111: .B "{} [] <>".
112: .TP
113: .BI @reference_style( " style arg ..." )
114: Switch to a new formatting style.
115: All previous references are forgotten
116: and a new list of references is begun.
117: If
118: .I style
119: is
120: .B same
121: the current style remains (but all previous references are forgotten).
122: Optional
123: .IR args
124: are:
125: .RS
126: .TF sequence
127: .TP
128: .BR tm
129: Format as a technical memorandum.
130: .TP
131: .B rp
132: Format as a released paper.
133: .TP
134: .B nroff
135: Format for
136: .I nroff.
137: .TP
138: .B troff
139: Format for
140: .I troff.
141: .TP
142: .B sort
143: Print a
144: .B @reference_list
145: in an order appropriate for the current style.
146: .TP
147: .B sequence
148: Print a
149: .B @reference_list
150: in database sequence.
151: .TP
152: .I sortkey
153: Print a
154: .B @reference_list
155: according to the
156: .IR sortkey ,
157: any combination of the letters
158: .LR a ,
159: .LR d ,
160: .LR t
161: as above.
162: .PD
163: .RE
164: .TP
165: .BI @reference( keywords
166: .I %ref_fields
167: .IB %flags )
168: .br
169: Insert a citation mark
170: in the current style
171: (e.g. [7], \s-2\v'-0.4m'3\v'0.4m'\s+2, (Knuth, 1975)).
172: One or more
173: .I keywords
174: cause selection from the bibliographic database.
175: Each
176: .B %
177: argument must begin a new line.
178: .I %ref_field
179: lines override information from the database;
180: with no
181: .I keywords
182: a complete reference
183: may be given.
184: For the form of reference fields, see the output of
185: .I penter.
186: The following
187: .I %flags
188: may modify the citation.
189: .RS
190: .TF posttextstring
191: .TP
192: .B %no_author
193: Exclude author information.
194: .TP
195: .B %no_date
196: Exclude date from the citation mark.
197: .TP
198: .B %no_cite
199: Omit the entire citation, but include the entry in the final reference list.
200: .TP
201: .BI %pre_text " string
202: Insert
203: .I string
204: before the citation mark.
205: .TP
206: .BI %post_text " string
207: Insert
208: .I string
209: after the citation mark
210: .PD
211: .RE
212: .TP
213: .BI @reference_include( " dbfile ..." )
214: Include the contents of the database(s)
215: .I dbfile(s)
216: in the list of references,
217: treating them as
218: .B %no_cite
219: entries.
220: .TP
221: .B @reference_placement
222: Produce a list of all references specified in
223: .B @reference
224: or
225: .B @reference_include
226: commands since
227: the beginning of the document or the last
228: .B @reference_style
229: or
230: .BR @reference_placement .
231: .TP
232: .BI @reference_list( " dbfile ..." )
233: Format the contents of the database(s)
234: .IR dbfile .
235: .TP
236: .BI @\^reference_database( " dbfile " )
237: Switch to database
238: .I dbfile
239: .PP
240: .I Penter
241: helps build
242: .I prefer
243: bibliographic databses.
244: It prompts for a reference type,
245: and then for admissible attributes, such as author, date, etc.
246: A default value proposed in brackets
247: .B []
248: may be accepted by typing a newline,
249: skipped by typing spaces before the newline,
250: or overridden by typing a new value.
251: The character
252: .L &
253: appended to an attribute causes
254: .I penter
255: to prompt for the attribute again
256: (to enter multiple authors, for example).
257: .PP
258: The answer
259: .L ?
260: to the initial prompt gets a list of all reference types.
261: The answer
262: .L help
263: gets a subprompt for a reference type
264: whose pertinent attributes will then be listed.
265: The answer
266: .L ?
267: to the subprompt gets attributes for every type.
268: .PP
269: The attribute
270: .B also
271: permits one entry to refer to another
272: by naming keywords for
273: the other reference.
274: An entire `also' citation may be included within a
275: .B @reference
276: thus:
277: .br
278: .ns
279: .IP
280: .EX
281: %also_begin \fItext\fP
282: \fI%ref_fields\fP
283: %also_end
284: .EE
285: .PP
286: The attribute
287: .B keywords
288: prompts for distinguishing keys for the current entry, in addition to
289: those already occurring within author, title, etc.
290: .PP
291: The `reference type'
292: .B quit
293: causes
294: .I penter
295: to exit, first writing the collected database information into
296: .I outfile
297: .RF ( prefer.out
298: by default).
299: .PP
300: The `attribute'
301: .B ~e
302: permits editing of the current reference with the editor
303: specified by environment variable
304: .BR EDITOR ,
305: .IR ed (1)
306: by default;
307: .B ~v
308: gets the editor
309: .BR VISUAL ,
310: .IR vi (1)
311: by default.
312: .PP
313: .I Pinvert
314: creates an inverted index to one or more bibliographic database
315: .I files.
316: The index is placed in
317: .IB file .i ,
318: where
319: .I file
320: is the first input file.
321: An associated
322: .IB file .h
323: contains the names of the input files.
324: The options are:
325: .TF commmon
326: .TP
327: .BI -c common
328: Do not index words listed in file
329: .I common
330: (default
331: .FR /usr/lib/eign ).
332: .TP
333: .BI -i ignore
334: Do not index information about attributes listed in file
335: .I ignore.
336: (The default
337: .F /usr/lib/prefer/ignore
338: lists
339: .BR %volume ,
340: .BR %number ,
341: .BR %part ,
342: .BR %pages ,
343: .B %X
344: (location status),
345: .B %Y
346: (read status),
347: .B %Z
348: (comment).)
349: .TP
350: .BI -k i
351: Maximum number of keys kept per record (default 100).
352: .TP
353: .BI -l i
354: Maximum length of keywords (default 6, none is less than 3).
355: .TP
356: .BI -p file
357: The basename of the index is
358: .I file.
359: Prefer will write the index to
360: .IB file .i .
361: .TP
362: .B -v
363: Verbose.
364: Print statistics.
365: .PD
366: .PP
367: .I Plook
368: uses the inverted index to
369: retrieve bibliographic records by
370: .I keywords
371: from the command line
372: or the standard input.
373: Records that contain all the keywords in the request
374: are sent to
375: the standard output.
376: Option
377: .B -p
378: is the same as for
379: .I pinvert.
380: .PP
381: .I Pconvert
382: converts a
383: .IR refer (1)
384: database to
385: .I prefer
386: style.
387: Under option
388: .B -d
389: it converts
390: .IR refer -style
391: commands in a document to
392: .I prefer
393: style.
394: .ig
395: .SH EXAMPLES
396: .EX
397: @\^reference_style<apa>
398: A keyword citation@reference<awk tm 1985> in the middle of a line.
399: .br
400: A complete citation
401: .br
402: @reference(
403: .br
404: %post_text , Chapter 6
405: .br
406: %type book
407: .br
408: %author Aho, Alfred V.
409: .br
410: %author Sethi, Ravi
411: .br
412: %author Ullman, Jeffrey D.
413: .br
414: %title Compilers, Principles, Techniques, and Tools
415: .br
416: %publisher Addison-Wesley
417: .br
418: %address Reading, Massachusetts
419: .br
420: %date 1986 ).
421: .br
422: \&.ce
423: Bibliography
424: @\^reference_placement
425: ..
426: .SH FILES
427: .TF /usr/lib/prefer/mypubenter
428: .TP
429: .F prefer.out
430: default database
431: .TP
432: .F prefer.out.i
433: default index file
434: .TP
435: .F prefer.out.h
436: default header file containing names of databases
437: .TP
438: .F /usr/lib/eign
439: default list of common words
440: .TP
441: .F /usr/lib/prefer/ignore
442: default list of
443: .I %ref_fields
444: to ignore for indexing
445: .TP
446: .F /usr/lib/prefer/styles/*
447: .I awk
448: scripts of formatting instructions for each style
449: .TP
450: .F /tmp/prefer*
451: scratch file
452: .TP
453: .F /usr/lib/prefer/ptemplate
454: reference type definitions, self-describing
455: .TP
456: .F /usr/lib/prefer/mypubenter
457: program executed by penter
458: .SH SEE ALSO
459: M. A. Derr,
460: `Formatting References with Prefer',
461: this manual, Volume 2
462: .br
463: .IR refer (1),
464: .IR monk (1),
465: .IR troff (1)
466: .SH BUGS
467: .I Prefer
468: commands don't work immediately after certain
469: formatting macros, e.g. .SM, .I, .B.
470: .br
471: .I Plook
472: complains if the first key matches more references than it can store.
473: Try rearranging your request so a less common word comes first.
474: .br
475: .I Pinvert
476: does not record options
477: .B -c
478: and
479: .BR -l .
480: If you use them with
481: .I pinvert,
482: you will have to supply them for
483: .I prefer
484: and
485: .I plook
486: as well.
487: .tr @@
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.