4.4BSD/usr/src/old/refer/OTHERS/roffbib.1

Compare this file to the similar file:
Show the results in this format:
.\" Copyright (c) 1983, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)roffbib.1	6.6 (Berkeley) 8/8/91
.\"
.Dd August 8, 1991
.Dt ROFFBIB 1
.Os BSD 4.2
.Sh NAME
.Nm roffbib
.Nd run off bibliographic database
.Sh SYNOPSIS
.Nm roffbib
.Op Fl e
.Op Fl h
.Op Fl n
.Op Fl o
.Op Fl r
.Op Fl s
.Op Fl T Ns Ar term
.Op Fl x
.Op Fl m Ns Ar mac
.Op Fl V
.Op Fl Q
.Ar
.Sh DESCRIPTION
.Nm Roffbib
is a shell script which prints out all records in a bibliographic database,
in bibliography format rather than as footnotes or endnotes.
Generally it is used in conjunction with
.Xr sortbib  :
.Pp
.Dl sortbib  database \&| roffbib
.Pp
.Nm Roffbib
accepts most of the options understood by
.Xr nroff  1  ,
such as the
.Fl T
flag to specify terminal type.
.Pp
If abstracts or comments are entered in the database following the
.Cm %X
field key,
.Nm roffbib
will format them into paragraphs for an annotated bibliography.
Several
.Cm %X
fields may be given if several
annotation paragraphs are desired.
.Pp
Options exclusive to
.Nm roffbib :
.Bl -tag -width Fl x
.It Fl x
Suppresses the printing of
.Cm %X
abstracts.
.It Fl V
Send output to the Versatec (use vtroff).
.It Fl Q
Queue the output to the default troff device.
.El
.Pp
If neither the
.Fl Q
or
.Fl V
flags are given,
.Nm
sends the output to the standard output.
The default macros for
.Nm
are in 
.Pa /usr/share/tmac/tmac.bib .
These can be over ridden by
specifying a user-defined set with the
.Fl m
option.
.Pp
Four command-line registers control formatting style
of the bibliography, much like the number registers of
.Xr ms  7  .
The command-line argument
.Fl r Ns Ar N1 
will number
the references starting at one  1 .
The flag
.Fl r Ns Ar V2 
will double space the bibliography,
while
.Fl r Ns Ar V1 
will double space references
but single space annotation paragraphs.
The line length can be changed from the default 6.5 inches
to 6 inches with the
.Fl r Ns Ar L6i 
argument,
and the page offset can be set from the default of 0
to one inch by specifying
.Fl r Ns Ar O1i 
(capital O, not zero).
Note: with the
.Fl V
and
.Fl Q
flags
the default page offset is already one inch.
.Pp
.Nm Roffbib
is limited, but it is a good script to copy and adopt
for one's own needs, as it does demonstrate usage of
.Xr refer 1 .
.Sh FILES
.Bl -tag -width /usr/share/tmac/tmac.bib -compact
.It Pa /usr/bin/roffbib
.Nm Roffbib
script.
.It Pa /usr/share/tmac/tmac.bib
File of macros used by
.Xr nroff 1
and
.Xr troff 1 .
.El
.Sh SEE ALSO
.Xr refer 1 ,
.Xr addbib 1 ,
.Xr sortbib 1 ,
.Xr indxbib 1 ,
.Xr lookbib 1
.Sh HISTORY
The
.Nm roffbib
command appeared in
.Bx 4.2 .
.Sh BUGS
Users have to rewrite macros
to create customized formats.