xref: /csrg-svn/old/refer/OTHERS/roffbib.1 (revision 50814)
148293Sbostic.\" Copyright (c) 1983, 1990 The Regents of the University of California.
244957Scael.\" All rights reserved.
319747Smckusick.\"
448293Sbostic.\" %sccs.include.redist.roff%
519747Smckusick.\"
6*50814Scael.\"	@(#)roffbib.1	6.6 (Berkeley) 08/08/91
744957Scael.\"
844957Scael.Dd
944957Scael.Dt ROFFBIB 1
1044957Scael.Os BSD 4.2
1144957Scael.Sh NAME
1244957Scael.Nm roffbib
1344957Scael.Nd run off bibliographic database
1444957Scael.Sh SYNOPSIS
1544957Scael.Nm roffbib
1644957Scael.Op Fl e
1744957Scael.Op Fl h
1844957Scael.Op Fl n
1944957Scael.Op Fl o
2044957Scael.Op Fl r
2144957Scael.Op Fl s
22*50814Scael.Op Fl T Ns Ar term
2344957Scael.Op Fl x
24*50814Scael.Op Fl m Ns Ar mac
2544957Scael.Op Fl V
2644957Scael.Op Fl Q
2744957Scael.Ar
2844957Scael.Sh DESCRIPTION
2944957Scael.Nm Roffbib
3044957Scaelis a shell script which prints out all records in a bibliographic database,
3119747Smckusickin bibliography format rather than as footnotes or endnotes.
3219747SmckusickGenerally it is used in conjunction with
3344957Scael.Xr sortbib  :
3444957Scael.Pp
3544957Scael.Dl sortbib  database \&| roffbib
3644957Scael.Pp
3744957Scael.Nm Roffbib
3819747Smckusickaccepts most of the options understood by
3944957Scael.Xr nroff  1  ,
4044957Scaelsuch as the
4144957Scael.Fl T
4219747Smckusickflag to specify terminal type.
4344957Scael.Pp
44*50814ScaelIf abstracts or comments are entered in the database following the
45*50814Scael.Cm %X
46*50814Scaelfield key,
4744957Scael.Nm roffbib
4819747Smckusickwill format them into paragraphs for an annotated bibliography.
49*50814ScaelSeveral
50*50814Scael.Cm %X
51*50814Scaelfields may be given if several
5219747Smckusickannotation paragraphs are desired.
5344957Scael.Pp
5444957ScaelOptions exclusive to
5544957Scael.Nm roffbib :
56*50814Scael.Bl -tag -width Fl x
57*50814Scael.It Fl x
58*50814ScaelSuppresses the printing of
59*50814Scael.Cm %X
60*50814Scaelabstracts.
61*50814Scael.It Fl V
6244957ScaelSend output to the Versatec (use vtroff).
63*50814Scael.It Fl Q
6444957ScaelQueue the output to the default troff device.
65*50814Scael.El
6644957Scael.Pp
6744957ScaelIf neither the
6844957Scael.Fl Q
6944957Scaelor
7044957Scael.Fl V
7144957Scaelflags are given,
7244957Scael.Nm
7344957Scaelsends the output to the standard output.
7444957ScaelThe default macros for
7544957Scael.Nm
7644957Scaelare in
7744957Scael.Pa /usr/share/tmac/tmac.bib .
7844957ScaelThese can be over ridden by
7944957Scaelspecifying a user-defined set with the
8044957Scael.Fl m
8119747Smckusickoption.
8244957Scael.Pp
8319747SmckusickFour command-line registers control formatting style
8419747Smckusickof the bibliography, much like the number registers of
8544957Scael.Xr ms  7  .
8619747SmckusickThe command-line argument
87*50814Scael.Fl r Ns Ar N1
8819747Smckusickwill number
8944957Scaelthe references starting at one  1 .
9019747SmckusickThe flag
91*50814Scael.Fl r Ns Ar V2
92*50814Scaelwill double space the bibliography,
9319747Smckusickwhile
94*50814Scael.Fl r Ns Ar V1
9519747Smckusickwill double space references
9619747Smckusickbut single space annotation paragraphs.
9719747SmckusickThe line length can be changed from the default 6.5 inches
9819747Smckusickto 6 inches with the
99*50814Scael.Fl r Ns Ar L6i
10019747Smckusickargument,
10119747Smckusickand the page offset can be set from the default of 0
10219747Smckusickto one inch by specifying
103*50814Scael.Fl r Ns Ar O1i
10419747Smckusick(capital O, not zero).
10519747SmckusickNote: with the
10644957Scael.Fl V
10719747Smckusickand
10844957Scael.Fl Q
10919747Smckusickflags
11019747Smckusickthe default page offset is already one inch.
11144957Scael.Pp
11244957Scael.Nm Roffbib
11344957Scaelis limited, but it is a good script to copy and adopt
11444957Scaelfor one's own needs, as it does demonstrate usage of
11544957Scael.Xr refer 1 .
11644957Scael.Sh FILES
117*50814Scael.Bl -tag -width /usr/share/tmac/tmac.bib -compact
118*50814Scael.It Pa /usr/bin/roffbib
119*50814Scael.Nm Roffbib
12044957Scaelscript.
121*50814Scael.It Pa /usr/share/tmac/tmac.bib
122*50814ScaelFile of macros used by
12344957Scael.Xr nroff 1
12444957Scaeland
125*50814Scael.Xr troff 1 .
126*50814Scael.El
12744957Scael.Sh SEE ALSO
12844957Scael.Xr refer 1 ,
12944957Scael.Xr addbib 1 ,
13044957Scael.Xr sortbib 1 ,
13144957Scael.Xr indxbib 1 ,
13244957Scael.Xr lookbib 1
13344957Scael.Sh HISTORY
134*50814ScaelThe
135*50814Scael.Nm roffbib
136*50814Scaelcommand appeared in
137*50814Scael.Bx 4.2 .
13844957Scael.Sh BUGS
13919747SmckusickUsers have to rewrite macros
14019747Smckusickto create customized formats.
141