xref: /original-bsd/old/refer/OTHERS/roffbib.1 (revision 655593d0)
1.\" Copyright (c) 1983, 1990 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" %sccs.include.redist.man%
5.\"
6.\"     @(#)roffbib.1	6.4 (Berkeley) 03/14/91
7.\"
8.Vx
9.Vx
10.Dd
11.Dt ROFFBIB 1
12.Os BSD 4.2
13.Sh NAME
14.Nm roffbib
15.Nd run off bibliographic database
16.Sh SYNOPSIS
17.Nm roffbib
18.Op Fl e
19.Op Fl h
20.Op Fl n
21.Op Fl o
22.Op Fl r
23.Op Fl s
24.Oo
25.Op Fl T Ar term
26.Oo
27.Op Fl x
28.Op Fl m Ar mac
29.Op Fl V
30.Op Fl Q
31.Ar
32.Sh DESCRIPTION
33.Nm Roffbib
34is a shell script which prints out all records in a bibliographic database,
35in bibliography format rather than as footnotes or endnotes.
36Generally it is used in conjunction with
37.Xr sortbib  :
38.Pp
39.Dl sortbib  database \&| roffbib
40.Pp
41.Nm Roffbib
42accepts most of the options understood by
43.Xr nroff  1  ,
44such as the
45.Fl T
46flag to specify terminal type.
47.Pp
48If abstracts or comments are entered in the database following the %X field key,
49.Nm roffbib
50will format them into paragraphs for an annotated bibliography.
51Several %X fields may be given if several
52annotation paragraphs are desired.
53.Pp
54Options exclusive to
55.Nm roffbib :
56.Tp Fl x
57Suppresses the printing of %X abstracts.
58.Tp Fl V
59Send output to the Versatec (use vtroff).
60.Tp Fl Q
61Queue the output to the default troff device.
62.Tp
63.Pp
64If neither the
65.Fl Q
66or
67.Fl V
68flags are given,
69.Nm
70sends the output to the standard output.
71The default macros for
72.Nm
73are in
74.Pa /usr/share/tmac/tmac.bib .
75These can be over ridden by
76specifying a user-defined set with the
77.Fl m
78option.
79.Pp
80Four command-line registers control formatting style
81of the bibliography, much like the number registers of
82.Xr ms  7  .
83The command-line argument
84.Cx Fl r
85.Ar N1
86.Cx
87will number
88the references starting at one  1 .
89The flag
90.Cx Fl r
91.Ar V2
92.Cx
93will double space the biblio\%graphy,
94while
95.Cx Fl r
96.Ar V1
97.Cx
98will double space references
99but single space annotation paragraphs.
100The line length can be changed from the default 6.5 inches
101to 6 inches with the
102.Cx Fl r
103.Ar L6i
104.Cx
105argument,
106and the page offset can be set from the default of 0
107to one inch by specifying
108.Cx Fl r
109.Ar O1i
110.Cx
111(capital O, not zero).
112Note: with the
113.Fl V
114and
115.Fl Q
116flags
117the default page offset is already one inch.
118.Pp
119.Nm Roffbib
120is limited, but it is a good script to copy and adopt
121for one's own needs, as it does demonstrate usage of
122.Xr refer 1 .
123.Sh FILES
124.Dw /usr/share/tmac/tmac.bib
125.Di L
126.Dp Pa /usr/bin/roffbib
127.Nm
128script.
129.Dp Pa /usr/share/tmac/tmac.bib
130file of macros used by
131.Xr nroff 1
132and
133.Xr troff 1
134.Dp
135.Sh SEE ALSO
136.Xr refer 1 ,
137.Xr addbib 1 ,
138.Xr sortbib 1 ,
139.Xr indxbib 1 ,
140.Xr lookbib 1
141.Sh HISTORY
142.Nm Roffbib
143appeared in 4.2 BSD.
144.Sh BUGS
145Users have to rewrite macros
146to create customized formats.
147