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