usr/src/man/man1/roffbib.1

   1 '\" te
   2 .\" Copyright (c) 1992, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ROFFBIB 1 "Sep 14, 1992"
   7 .SH NAME
   8 roffbib \- format and print a bibliographic database
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBroffbib\fR [\fB-e\fR] [\fB-h\fR] [\fB-m\fR \fIfilename\fR] [\fB-n\fR\fIp\fR] [\fB-o\fR\fIlist\fR] [\fB-Q\fR] [\fB-r\fR\fIaN\fR]
  13      [\fB-s\fR\fIN\fR] [\fB-T\fR\fIterm\fR] [\fB-V\fR] [\fB-x\fR] [\fIfilename\fR] ...
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBroffbib\fR prints out all records in a bibliographic database, in
  20 bibliography format rather than as footnotes or endnotes. Generally it is used
  21 in conjunction with \fBsortbib\fR(1):
  22 .sp
  23 .LP
  24 \fBexample%\fR \fBsortbib\fR \fBdatabase\fR \fB|\fR \fBroffbib\fR
  25 .SH OPTIONS
  26 .sp
  27 .LP
  28 \fBroffbib\fR accepts all options understood by \fBnroff\fR(1) except \fB-i\fR
  29 and \fB-q\fR.
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fB-e\fR\fR
  34 .ad
  35 .RS 15n
  36 Produce equally-spaced words in adjusted lines using full terminal resolution.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fB-h\fR\fR
  43 .ad
  44 .RS 15n
  45 Use output tabs during horizontal spacing to speed output and reduce output
  46 character count. \fBTAB\fR settings are assumed to be every 8 nominal character
  47 widths.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fB-m\fR\fI filename\fR\fR
  54 .ad
  55 .RS 15n
  56 Prepend the macro file \fB/usr/share/lib/tmac/tmac.name\fR to the input files.
  57 There should be a space between the \fB-m\fR and the macro filename. This set
  58 of macros will replace the ones defined in \fB/usr/share/lib/tmac/tmac.bib\fR.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB-n\fR\fIp\fR\fR
  65 .ad
  66 .RS 15n
  67 Number first generated page \fIp\fR.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-o\fR\fIlist\fR\fR
  74 .ad
  75 .RS 15n
  76 Print only page numbers that appear in the comma-separated \fIlist\fR of
  77 numbers and ranges. A range \fIN\fR\fB\(mi\fR\fIM\fR means pages \fIN\fR
  78 through \fIM\fR; an initial \fB-\fR\fIN\fR means from the beginning to page
  79 \fIN\fR; a final \fIN\fR\fB\(mi\fR means from page \fIN\fR to end.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fB-Q\fR\fR
  86 .ad
  87 .RS 15n
  88 Queue output for the phototypesetter.  Page offset is set to 1 inch.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fB-r\fR\fIaN\fR\fR
  95 .ad
  96 .RS 15n
  97 Set register \fIa\fR (one-character) to \fIN\fR. The command-line argument
  98 \fB-rN1\fR will number the references starting at 1.
  99 .sp
 100 Four command-line registers control formatting style of the bibliography, much
 101 like the number registers of \fBms\fR(5). The flag \fB-rV2\fR will double space
 102 the bibliography, while \fB-rV1\fR will double space references but single
 103 space annotation paragraphs. The line length can be changed from the default
 104 6.5 inches to 6 inches with the \fB-rL6i\fR argument, and the page offset can
 105 be set from the default of 0 to one inch by specifying \fB-rO1i\fR (capital O,
 106 not zero).
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fB-s\fR\fIN\fR\fR
 113 .ad
 114 .RS 15n
 115 Halt prior to every \fIN\fR pages for paper loading or changing (default
 116 \fIN\fR\|=1). To resume, enter \fBNEWLINE\fR or \fBRETURN.\fR
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fB-T\fR\fIterm\fR\fR
 123 .ad
 124 .RS 15n
 125 Specify \fIterm\fR as the terminal type.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fB-V\fR\fR
 132 .ad
 133 .RS 15n
 134 Send output to the Versatec.  Page offset is set to 1 inch.
 135 .RE
 136
 137 .sp
 138 .ne 2
 139 .na
 140 \fB\fB-x\fR\fR
 141 .ad
 142 .RS 15n
 143 If abstracts or comments are entered following the \fB%X\fR field key,
 144 \fBroffbib\fR will format them into paragraphs for an annotated bibliography.
 145 Several \fB%X\fR fields may be given if several annotation paragraphs are
 146 desired.
 147 .RE
 148
 149 .SH FILES
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fB/usr/share/lib/tmac/tmac.bib\fR\fR
 154 .ad
 155 .sp .6
 156 .RS 4n
 157 file of macros used by \fBnroff/troff\fR
 158 .RE
 159
 160 .SH SEE ALSO
 161 .sp
 162 .LP
 163 \fBaddbib\fR(1), \fBindxbib\fR(1), \fBlookbib\fR(1), \fBnroff\fR(1)
 164 \fBrefer\fR(1), \fBsortbib\fR(1), \fBtroff\fR(1), \fBattributes\fR(5)
 165 .SH BUGS
 166 .sp
 167 .LP
 168 Users have to rewrite macros to create customized formats.