usr/src/man/man1/refer.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 REFER 1 "Sep 14, 1992"
   7 .SH NAME
   8 refer \- expand and insert references from a bibliographic database
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBrefer\fR [\fB-ben\fR] [\fB-a\fR\fIr\fR] [\fB-c\fR\fIstring\fR] [\fB-k\fR\fIx\fR] [\fB-l\fR\fIm,n\fR] [\fB-p\fR \fIfilename\fR]
  13      [\fB-s\fR\fIkeys\fR] \fIfilename\fR...
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBrefer\fR is a preprocessor for \fBnroff\fR(1), or \fBtroff\fR(1), that finds
  20 and formats references. The input files (standard input by default) are copied
  21 to the standard output, except for lines between `\fB\&.\|[\fR' and
  22 `\fB\&.\|]\fR' command lines, Such lines are assumed to contain keywords as for
  23 \fBlookbib\fR(1), and are replaced by information from a bibliographic data
  24 base.  The user can avoid the search, override fields from it, or add new
  25 fields. The reference data, from whatever source, is assigned to a set of
  26 \fBtroff\fR strings.  Macro packages such as \fBms\fR(5) print the finished
  27 reference text from these strings.  A flag is placed in the text at the point
  28 of reference. By default, the references are indicated by numbers.
  29 .sp
  30 .LP
  31 When \fBrefer\fR is used with \fBeqn\fR(1), \fBneqn\fR, or \fBtbl\fR(1),
  32 \fBrefer\fR should be used first in the sequence, to minimize the volume of
  33 data passed through pipes.
  34 .SH OPTIONS
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fB-b\fR\fR
  39 .ad
  40 .RS 15n
  41 Bare mode \(em do not put any flags in text (neither numbers or labels).
  42 .RE
  43
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fB-e\fR\fR
  48 .ad
  49 .RS 15n
  50 Accumulate references instead of leaving the references where encountered,
  51 until a sequence of the form:
  52 .sp
  53 .in +2
  54 .nf
  55 \fB\&.[
  56 $LIST$
  57 \&.]\fR
  58 .fi
  59 .in -2
  60 .sp
  61
  62 is encountered, and then write out all references collected so far. Collapse
  63 references to the same source.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fB-n\fR\fR
  70 .ad
  71 .RS 15n
  72 Do not search the default file.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-a\fR\fIr\fR\fR
  79 .ad
  80 .RS 15n
  81 Reverse the first \fIr\fR author names (Jones, J. A. instead of J. A. Jones).
  82 If \fIr\fR is omitted, all author names are reversed.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB-c\fR\fIstring\fR\fR
  89 .ad
  90 .RS 15n
  91 Capitalize (with SMALL CAPS) the fields whose key-letters are in \fIstring\fR.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-k\fR\fIx\fR\fR
  98 .ad
  99 .RS 15n
 100 Instead of numbering references, use labels as specified in a reference data
 101 line beginning with the characters \fI%x\fR; By default, \fIx\fR is \fBL\fR.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-l\fR\fIm,n\fR\fR
 108 .ad
 109 .RS 15n
 110 Instead of numbering references, use labels from the senior author's last name
 111 and the year of publication.  Only the first \fIm\fR letters of the last name
 112 and the last \fIn\fR digits of the date are used.  If either of \fIm\fR or
 113 \fIn\fR is omitted, the entire name or date, respectively, is used.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fB-p\fR\fI filename\fR\fR
 120 .ad
 121 .RS 15n
 122 Take the next argument as a file of references to be searched.  The default
 123 file is searched last.
 124 .RE
 125
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB-s\fR\fIkeys\fR\fR
 130 .ad
 131 .RS 15n
 132 Sort references by fields whose key-letters are in the \fIkeys\fR string, and
 133 permute reference numbers in the text accordingly. Using this option implies
 134 the \fB-e\fR option. The key-letters in \fIkeys\fR may be followed by a number
 135 indicating how many such fields are used, with a \fB+\fR sign taken as a very
 136 large number.  The default is \fB\fR\fBAD\fR\fB,\fR which sorts on the senior
 137 author and date. To sort on all authors and then the date, for instance, use
 138 the options `\fB-sA+T\fR'.
 139 .RE
 140
 141 .SH FILES
 142 .sp
 143 .ne 2
 144 .na
 145 \fB\fB/usr/lib/refer\fR\fR
 146 .ad
 147 .RS 25n
 148 directory of programs
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fB/usr/lib/refer/papers\fR\fR
 155 .ad
 156 .RS 25n
 157 directory of default publication lists and indexes
 158 .RE
 159
 160 .SH SEE ALSO
 161 .sp
 162 .LP
 163 \fBaddbib\fR(1), \fBeqn\fR(1), \fBindxbib\fR(1), \fBlookbib\fR(1),
 164 \fBnroff\fR(1), \fBroffbib\fR(1), \fBsortbib\fR(1), \fBtbl\fR(1),
 165 \fBtroff\fR(1), \fBattributes\fR(5)