usr/src/man/man1/addbib.1

   1 '\" te
   2 .\" Copyright (c) 2001, 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 ADDBIB 1 "Sep 14, 1992"
   7 .SH NAME
   8 addbib \- create or extend a bibliographic database
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBaddbib\fR [\fB-a\fR] [\fB-p\fR \fIpromptfile\fR] \fIdatabase\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 When \fBaddbib\fR starts up, answering \fBy\fR to the initial
  19 \fBInstructions?\fR prompt yields directions. Typing \fBn\fR (or RETURN) skips
  20 the directions. \fBaddbib\fR then prompts for various bibliographic fields,
  21 reads responses from the terminal, and sends output records to \fIdatabase.\fR
  22 A null response (just RETURN) means to leave out that field. A `\fB\(mi\fR\&'
  23 (minus sign) means to go back to the previous field. A trailing backslash
  24 allows a field to be continued on the next line. The repeating \fBContinue?\fR
  25 prompt allows the user either to resume by typing \fBy\fR (or RETURN), to quit
  26 the current session by typing \fBn\fR or \fBq\fR, or to edit \fIdatabase\fR
  27 with any system editor  (see \fBvi\fR(1), \fBex\fR(1), \fBed\fR(1)).
  28 .SH OPTIONS
  29 .sp
  30 .LP
  31 The following options are supported:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fB-a\fR\fR
  36 .ad
  37 .RS 17n
  38 Suppresses prompting for an abstract. Asking for an abstract is the default.
  39 Abstracts are ended with a Control\(miD.
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-p\fR \fIpromptfile\fR\fR
  46 .ad
  47 .RS 17n
  48 Uses a new prompting skeleton, defined in \fIpromptfile\fR. This file should
  49 contain prompt strings, a TAB, and the key-letters to be written to the
  50 \fIdatabase\fR.
  51 .RE
  52
  53 .SH USAGE
  54 .SS "Bibliography Key Letters"
  55 .sp
  56 .LP
  57 The most common key-letters and their meanings are given below. \fBaddbib\fR
  58 insulates you from these key-letters, since it gives you prompts in English,
  59 but if you edit the bibliography file later on, you will need to know this
  60 information.
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB%A\fR\fR
  65 .ad
  66 .RS 8n
  67 Author's name
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB%B\fR\fR
  74 .ad
  75 .RS 8n
  76 Book containing article referenced
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fB%C\fR\fR
  83 .ad
  84 .RS 8n
  85 City (place of publication)
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fB%D\fR\fR
  92 .ad
  93 .RS 8n
  94 Date of publication
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB%E\fR\fR
 101 .ad
 102 .RS 8n
 103 Editor of book containing article referenced
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fB%F\fR\fR
 110 .ad
 111 .RS 8n
 112 Footnote number or label (supplied by   \fBrefer\fR)
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fB%G\fR\fR
 119 .ad
 120 .RS 8n
 121 Government order number
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fB%H\fR\fR
 128 .ad
 129 .RS 8n
 130 Header commentary, printed before reference
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fB%I\fR\fR
 137 .ad
 138 .RS 8n
 139 Issuer (publisher)
 140 .RE
 141
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fB%J\fR\fR
 146 .ad
 147 .RS 8n
 148 Journal containing article
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fB%K\fR\fR
 155 .ad
 156 .RS 8n
 157 Keywords to use in locating reference
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fB\fB%L\fR\fR
 164 .ad
 165 .RS 8n
 166 Label field used by \fB-k\fR option of  \fBrefer\fR
 167 .RE
 168
 169 .sp
 170 .ne 2
 171 .na
 172 \fB\fB%M\fR\fR
 173 .ad
 174 .RS 8n
 175 Bell Labs Memorandum (undefined)
 176 .RE
 177
 178 .sp
 179 .ne 2
 180 .na
 181 \fB\fB%N\fR\fR
 182 .ad
 183 .RS 8n
 184 Number within volume
 185 .RE
 186
 187 .sp
 188 .ne 2
 189 .na
 190 \fB\fB%O\fR\fR
 191 .ad
 192 .RS 8n
 193 Other commentary, printed at end of reference
 194 .RE
 195
 196 .sp
 197 .ne 2
 198 .na
 199 \fB\fB%P\fR\fR
 200 .ad
 201 .RS 8n
 202 Page number(s)
 203 .RE
 204
 205 .sp
 206 .ne 2
 207 .na
 208 \fB\fB%Q\fR\fR
 209 .ad
 210 .RS 8n
 211 Corporate or Foreign Author (unreversed)
 212 .RE
 213
 214 .sp
 215 .ne 2
 216 .na
 217 \fB\fB%R\fR\fR
 218 .ad
 219 .RS 8n
 220 Report, paper, or thesis (unpublished)
 221 .RE
 222
 223 .sp
 224 .ne 2
 225 .na
 226 \fB\fB%S\fR\fR
 227 .ad
 228 .RS 8n
 229 Series title
 230 .RE
 231
 232 .sp
 233 .ne 2
 234 .na
 235 \fB\fB%T\fR\fR
 236 .ad
 237 .RS 8n
 238 Title of article or book
 239 .RE
 240
 241 .sp
 242 .ne 2
 243 .na
 244 \fB\fB%V\fR\fR
 245 .ad
 246 .RS 8n
 247 Volume number
 248 .RE
 249
 250 .sp
 251 .ne 2
 252 .na
 253 \fB\fB%X\fR\fR
 254 .ad
 255 .RS 8n
 256 Abstract \(em used by \fBroffbib\fR, not by \fBrefer\fR
 257 .RE
 258
 259 .sp
 260 .ne 2
 261 .na
 262 \fB\fB%Y,Z\fR\fR
 263 .ad
 264 .RS 8n
 265 Ignored by \fBrefer\fR
 266 .RE
 267
 268 .SH EXAMPLES
 269 .LP
 270 \fBExample 1 \fREditing the bibliography file
 271 .sp
 272 .LP
 273 Except for \fBA\fR, each field should be given just once. Only relevant fields
 274 should be supplied.
 275
 276 .sp
 277 .in +2
 278 .nf
 279 \fB%A   Mark Twain
 280 %T      Life on the Mississippi
 281 %I      Penguin Books
 282 %C      New York
 283 %D      1978\fR
 284 .fi
 285 .in -2
 286 .sp
 287
 288 .SH SEE ALSO
 289 .sp
 290 .LP
 291 \fBed\fR(1), \fBex\fR(1), \fBindxbib\fR(1), \fBlookbib\fR(1), \fBrefer\fR(1),
 292 \fBroffbib\fR(1), \fBsortbib\fR(1), \fBvi\fR(1), \fBattributes\fR(5)