Commit | Line | Data |
---|---|---|
d2ffc63c | 1 | .\" "@(#)bib.1 4.3 %G%"; |
30a9a226 PN |
2 | .TH BIB 1 "28 July 1983" |
3 | .UC 4 | |
d4285d8c | 4 | .SH NAME |
30a9a226 | 5 | bib \- bibliographic formatter |
d4285d8c | 6 | .br |
30a9a226 | 7 | listrefs \- list bibliographic reference items |
d4285d8c SL |
8 | .SH SYNOPSIS |
9 | \fBbib\fP [options] ... | |
10 | .br | |
11 | \fBlistrefs\fP [options] ... | |
12 | .SH DESCRIPTION | |
13 | \fIBib\fP is a preprocessor for \fInroff\fP or \fItroff\fP(1) that | |
14 | formats citations and bibliographies. The input files (standard input | |
15 | default) are copied to the standard output, except for text between [. and .] | |
16 | pairs, which are assumed to be keywords for searching a bibliographic database. | |
17 | If a matching reference is found a citation is generated replacing the text. | |
18 | References are collected, optionally sorted, and written out at a location | |
19 | specified by the user. | |
30a9a226 | 20 | Citation and reference formats are controlled by the \-t option. |
d4285d8c SL |
21 | .PP |
22 | Reference databases are created using the \fIinvert\fP utility. | |
23 | .PP | |
24 | The following options are available. | |
30a9a226 | 25 | Note that standard format styles (see the \-t option) set options automatically. |
d2ffc63c | 26 | Thus if a standard format style is used the user need not indicate any |
d4285d8c | 27 | further options for most documents. |
30a9a226 | 28 | .IP \-aa 8m |
d4285d8c | 29 | reduce author\*(CQs first names to abbreviations. |
30a9a226 | 30 | .IP \-ar\fInum\fP |
d2ffc63c GL |
31 | reverse the first \fInum\fP author's names. |
32 | If a number is not given all authors names are reversed. | |
30a9a226 | 33 | .IP \-ax |
d4285d8c SL |
34 | print authors last names in Caps-Small Caps style. For example Budd becomes |
35 | B\s-2UDD\s+2. This style is used by certain ACM publications. | |
30a9a226 | 36 | .IP \-c\fIstr\fP |
d4285d8c SL |
37 | build citations according to the template \fIstr\fP. See the reference |
38 | format designer\*(CQs guide for more information on templates. | |
d2ffc63c GL |
39 | .IP \-ea |
40 | reduce editors first names to abbreviations. | |
41 | .IP \-ex | |
42 | print editors last names in Caps-Small Caps style (see \-ax option). | |
43 | .IP \-er\fInum\fP | |
44 | reverse the first \fInum\fP editors names. If a number is not given all | |
45 | editors names are reversed. | |
30a9a226 | 46 | .IP \-f |
d4285d8c SL |
47 | instead of collecting references, dump each |
48 | reference immediately following the line on which the citation is placed | |
49 | (used for footnoted references). | |
30a9a226 | 50 | .IP "\-i \fIfile\fP" |
d4285d8c | 51 | .ns |
30a9a226 | 52 | .IP \-i\fIfile\fP |
d4285d8c SL |
53 | process the indicated file, such as a file of definitions. |
54 | (see technical report for a description of file format). | |
30a9a226 | 55 | .IP \-h |
d4285d8c SL |
56 | replace citations to three or more adjacent reference items with |
57 | a hyphenated string (eg 2,3,4,5 becomes 2-5). | |
d2ffc63c | 58 | This option implies the \-o option. |
30a9a226 | 59 | .IP \-n\fIstr\fP |
d4285d8c | 60 | turn off indicated options. \fIstr\fP must be composed of the letters afhosx. |
30a9a226 | 61 | .IP \-o |
d4285d8c SL |
62 | contiguous citations are ordered according the the reference list before |
63 | being printed (default). | |
30a9a226 | 64 | .IP "\-p \fIfile\fP" |
d4285d8c | 65 | .ns |
30a9a226 | 66 | .IP \-p\fIfile\fP |
d4285d8c | 67 | instead of searching the file INDEX, |
d2ffc63c GL |
68 | search the indicated reference files before searching the system file. |
69 | \fIfiles\fP is a comma separated list of inverted indices, created using | |
70 | the \fIinvert\fP utility. | |
30a9a226 | 71 | .IP \-s\fIstr\fP |
d4285d8c | 72 | sort references according to the template \fIstr\fP. |
30a9a226 | 73 | .IP "\-t \fItype\fP" |
d4285d8c | 74 | .ns |
30a9a226 | 75 | .IP \-t\fItype\fP |
d4285d8c SL |
76 | use the standard macros and switch settings for the indicated style |
77 | to generate citations and references. | |
d2ffc63c | 78 | There are a number of standard styles provided. In addition users |
d4285d8c | 79 | can generate their own style macros. See the format designers guide for |
d2ffc63c | 80 | details. |
d4285d8c | 81 | .PP |
d2ffc63c GL |
82 | \fIListrefs\fP formats an entire reference database file. |
83 | Options to \fIlistrefs\fP | |
84 | are the same as for \fIbib\fP. | |
d4285d8c | 85 | .PP |
30a9a226 PN |
86 | \fIBib\fP was designed initially for use with the \-ms macros, and |
87 | uses a couple of the \-ms macros (.ip and .lp) in its macro definitions. | |
88 | To use it with the \-me macros, prefix the file being sent to nroff/troff | |
d4285d8c SL |
89 | with the following macro definitions: |
90 | .nf | |
91 | .in +1.0i | |
92 | \&.de IP | |
93 | \&.ip \\$1 \\$2 | |
94 | \&.. | |
95 | \&.de LP | |
96 | \&.lp | |
97 | \&.. | |
98 | .fi | |
99 | .in -1.0i | |
100 | .PP | |
101 | A file "bibmac.me" containing these macro | |
102 | definitions may be found in /usr/lib/bmac. | |
103 | .SH FILES | |
104 | .ta 2i | |
105 | INDEX inverted index for reference database | |
106 | .br | |
107 | /usr/dict/papers/INDEX default system index | |
108 | .br | |
109 | /usr/lib/bmac/bmac.* formatting macro packages | |
110 | .br | |
111 | /usr/tmp/bibr* scratch file for collecting references | |
112 | .br | |
113 | /usr/tmp/bibp* output of pass one of bib | |
114 | .SH SEE ALSO | |
115 | \fIA UNIX Bibliographic Database Facility\fP, Timothy A. Budd and Gary M. Levin, | |
116 | University of Arizona Technical Report 82-1, 1982. | |
117 | (includes format designers guide). | |
118 | .br | |
119 | invert(1), troff(1) |