BSD 4_4 release

[unix-history] / usr / src / old / refer / refer / refer.1

diff --git a/usr/src/old/refer/refer/refer.1 b/usr/src/old/refer/refer/refer.1
index 1044a5a..9b7a4b7 100644 (file)
--- a/usr/src/old/refer/refer/refer.1
+++ b/usr/src/old/refer/refer/refer.1
@@ -1,10 +1,13 @@
-.\" Copyright (c) 1990 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1985 The Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"     @(#)refer.1    6.4 (Berkeley) %G%
+.\" This module is believed to contain source code proprietary to AT&T.
+.\" Use and redistribution is subject to the Berkeley Software License
+.\" Agreement and your Software Agreement with AT&T (Western Electric).

 .\"
 .\"

-.Dd 
+.\"    @(#)refer.1     6.7 (Berkeley) 8/8/91
+.\"
+.Dd August 8, 1991

 .Dt REFER 1
 .Os ATT 7th
 .Sh NAME
 .Dt REFER 1
 .Os ATT 7th
 .Sh NAME


@@ -16,17 +19,13 @@
 .Op Fl b
 .Op Fl c
 .Op Fl e
 .Op Fl b
 .Op Fl c
 .Op Fl e

-.Oo
-.Op Fl f Ar n
-.Op Fl k Ar x
-.Op Fl l Ar m,n
-.Oo
+.Op Fl f Ns Ar n
+.Op Fl k Ns Ar x
+.Op Fl l Ns Ar m,n

 .Op Fl n
 .Op Fl p Ar bib
 .Op Fl n
 .Op Fl p Ar bib

-.Oo
-.Op Fl s Ar keys
-.Op Fl B Ar l.m
-.Oo
+.Op Fl s Ns Ar keys
+.Op Fl B Ns Ar l.m

 .Op Fl P
 .Op Fl S
 .Op Ar
 .Op Fl P
 .Op Fl S
 .Op Ar


@@ -47,8 +46,10 @@ will search a bibliographic database for references
 containing these keywords anywhere in the title, author, journal, etc.
 The input file (or standard input)
 is copied to standard output,
 containing these keywords anywhere in the title, author, journal, etc.
 The input file (or standard input)
 is copied to standard output,

-except for lines between \&.[
-and \&.]
+except for lines between
+.Ql \&.[
+and
+.Ql \&.]

 delimiters,
 which are assumed to contain keywords,
 and are replaced by information from the bibliographic database.
 delimiters,
 which are assumed to contain keywords,
 and are replaced by information from the bibliographic database.


@@ -63,45 +64,37 @@ print the finished reference text from these strings.
 By default references are flagged by footnote numbers.
 .Pp
 The following options are available:
 By default references are flagged by footnote numbers.
 .Pp
 The following options are available:

-.Tw Fl
-.Tc Fl a
-.Ar n
-.Cx
+.Bl -tag -width flag
+.It Fl a Ns Ar n 

 Reverse the first
 .Ar n
 author names (Jones, J. A. instead of J. A. Jones).
 If
 .Ar n
 is omitted all author names are reversed.
 Reverse the first
 .Ar n
 author names (Jones, J. A. instead of J. A. Jones).
 If
 .Ar n
 is omitted all author names are reversed.

-.Tp Fl b
+.It Fl b

 Bare mode: do not put any flags in text (neither numbers nor labels).
 Bare mode: do not put any flags in text (neither numbers nor labels).

-.Tc Fl c
-.Ar keys
-.Cx
+.It Fl c Ns Ar keys 

 Capitalize (with C\s-2APS\s+2 S\s-2MALL\s+2 C\s-2APS\s+2)
 the fields whose key-letters are in
 .Ar keys  .
 Capitalize (with C\s-2APS\s+2 S\s-2MALL\s+2 C\s-2APS\s+2)
 the fields whose key-letters are in
 .Ar keys  .

-.Tp Fl e
+.It Fl e

 Instead of leaving the references where encountered,
 accumulate them until a sequence of the form
 Instead of leaving the references where encountered,
 accumulate them until a sequence of the form

-.Ds I
+.Bd -literal -offset indent -compact

 \&.[
 $LIST$
 \&.]
 \&.[
 $LIST$
 \&.]

-.De
+.Ed

 is encountered, and then write out all references collected so far.
 Collapse references to same source.
 is encountered, and then write out all references collected so far.
 Collapse references to same source.

-.Tc Fl f
-.Ar n
-.Cx
+.It Fl f Ns Ar n 

 Set the footnote number to
 .Ar n
 instead of the default of 1 (one).
 With labels rather than numbers,
 this flag is a no-op.
 Set the footnote number to
 .Ar n
 instead of the default of 1 (one).
 With labels rather than numbers,
 this flag is a no-op.

-.Tc Fl k
-.Ar x
-.Cx
+.It Fl k Ns Ar x 

 Instead of numbering references, use labels as specified in a
 reference data line beginning
 .Ar \&%x ;
 Instead of numbering references, use labels as specified in a
 reference data line beginning
 .Ar \&%x ;


@@ -109,9 +102,7 @@ by default
 .Ar x
 is
 .Cm L .
 .Ar x
 is
 .Cm L .

-.Tc Fl l
-.Ar m , n
-.Cx
+.It Fl l Ns Ar m,n 

 Instead of numbering references, use labels made from
 the senior author's last name and the year of publication.
 Only the first
 Instead of numbering references, use labels made from
 the senior author's last name and the year of publication.
 Only the first


@@ -125,7 +116,7 @@ If either
 or
 .Ar n
 is omitted the entire name or date respectively is used.
 or
 .Ar n
 is omitted the entire name or date respectively is used.

-.Tp Fl n
+.It Fl n

 Do not search the default file
 .Pa /var/db/Ind .
 If there is a
 Do not search the default file
 .Pa /var/db/Ind .
 If there is a


@@ -135,17 +126,12 @@ the specified file will be searched instead of the default file;
 in this case the
 .Fl n
 flag has no effect.
 in this case the
 .Fl n
 flag has no effect.

-.Tc Fl p
-.Ws
-.Ar bib
-.Cx
+.It Fl p Ns Ar bib 

 Take the next argument
 .Ar bib
 as a file of references to be searched.
 The default file is searched last.
 Take the next argument
 .Ar bib
 as a file of references to be searched.
 The default file is searched last.

-.Tc Fl s
-.Ar keys
-.Cx
+.It Fl s Ns Ar keys 

 Sort references by fields whose key-letters are in the
 .Ar keys
 string;
 Sort references by fields whose key-letters are in the
 .Ar keys
 string;


@@ -163,9 +149,7 @@ The default is
 which sorts on the senior author and then date; to sort, for example,
 on all authors and then title, use
 .Fl sA+T .
 which sorts on the senior author and then date; to sort, for example,
 on all authors and then title, use
 .Fl sA+T .

-.Tc Fl B
-.Ar l.m
-.Cx
+.It Fl B Ns Ar l.m 

 Bibliography mode.
 Take a file composed of records separated by blank lines,
 and turn them into
 Bibliography mode.
 Take a file composed of records separated by blank lines,
 and turn them into


@@ -184,13 +168,14 @@ and
 defaulting to
 .Cm \&.AP
 (annotation paragraph).
 defaulting to
 .Cm \&.AP
 (annotation paragraph).

-.Tp Fl P
-Place punctuation marks .,:;?! after the reference signal,
+.It Fl P
+Place punctuation marks
+.Ql ".,:;?!" after the reference signal,

 rather than before.
 (Periods and commas used to be done with strings.)
 rather than before.
 (Periods and commas used to be done with strings.)

-.Tp Fl S
+.It Fl S

 Produce references in the Natural or Social Science format.
 Produce references in the Natural or Social Science format.

-.Tp
+.El

 .Pp
 To use your own references,
 put them in the format described below.
 .Pp
 To use your own references,
 put them in the format described below.


@@ -218,10 +203,12 @@ expect input from a file of references
 composed of records separated by blank lines.
 A record is a set of lines (fields),
 each containing one kind of information.
 composed of records separated by blank lines.
 A record is a set of lines (fields),
 each containing one kind of information.

-Fields start on a line beginning with a ``%'',
+Fields start on a line beginning with a
+.Ql % ,

 followed by a key-letter, then a blank,
 and finally the contents of the field,
 followed by a key-letter, then a blank,
 and finally the contents of the field,

-and continue until the next line starting with ``%''.
+and continue until the next line starting with
+.Ql % .

 The output ordering and formatting of fields
 is controlled by the macros specified for
 .Xr nroff 1
 The output ordering and formatting of fields
 is controlled by the macros specified for
 .Xr nroff 1


@@ -240,13 +227,12 @@ entry is given below.
 The following environment variable is used by
 .Nm refer
 if it exists.
 The following environment variable is used by
 .Nm refer
 if it exists.

-.Tw Fl
-.Tp Ev REFER
+.Bl -tag -width Fl
+.It Ev REFER

 Specify an alternate default search file for publication lists.
 Specify an alternate default search file for publication lists.

-.Tp
+.El

 .Sh EXAMPLES
 .Sh EXAMPLES

-.Pp
-.Ds I
+.Bd -literal -offset indent

 %A     M. E. Lesk
 %T     Some Applications of Inverted Indexes on the UNIX System
 %B     UNIX Programmer's Manual
 %A     M. E. Lesk
 %T     Some Applications of Inverted Indexes on the UNIX System
 %B     UNIX Programmer's Manual


@@ -254,21 +240,20 @@ Specify an alternate default search file for publication lists.
 %I     Bell Laboratories
 %C     Murray Hill, NJ
 %D     1978
 %I     Bell Laboratories
 %C     Murray Hill, NJ
 %D     1978

-.De
+.Ed

 .Sh FILES
 .Sh FILES

-.Dw /usr/share/dict/papers
-.Di L
-.Dp Pa /usr/share/dict/papers
-directory of default publication lists.
-.Dp Pa /var/db/Ind
-default search file (for
+.Bl -tag -width /usr/share/dict/papers -compact
+.It Pa /usr/share/dict/papers
+Directory of default publication lists.
+.It Pa /var/db/Ind
+Default search file (for

 .Em hunt
 phase).
 .Em hunt
 phase).

-.Dp Pa /usr/share/dict/eign
-contains common words.
-.Dp Pa /usr/libexec
-directory where companion programs reside.
-.Dp
+.It Pa /usr/share/dict/eign
+Contains common words.
+.It Pa /usr/libexec
+Directory where companion programs reside.
+.El

 .Sh SEE ALSO
 .Xr addbib 1 ,
 .Xr sortbib 1 ,
 .Sh SEE ALSO
 .Xr addbib 1 ,
 .Xr sortbib 1 ,


@@ -276,10 +261,12 @@ directory where companion programs reside.
 .Xr indxbib 1 ,
 .Xr lookbib 1
 .Sh HISTORY
 .Xr indxbib 1 ,
 .Xr lookbib 1
 .Sh HISTORY

+The

 .Nm Refer
 .Nm Refer

-appeared in Version 7 AT&T Unix.
+command appeared in
+.At v7 .

 .Sh AUTHOR
 .Sh AUTHOR

-Mike Lesk
+.An Mike Lesk

 .Sh BUGS
 Blank spaces at the end of lines in bibliography fields
 will cause the records to sort and reverse incorrectly.
 .Sh BUGS
 Blank spaces at the end of lines in bibliography fields
 will cause the records to sort and reverse incorrectly.