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