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