.Xr botch fix

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

diff --git a/usr/src/old/refer/lookbib/lookbib.1 b/usr/src/old/refer/lookbib/lookbib.1
index bd1d61b..50c7db7 100644 (file)
--- a/usr/src/old/refer/lookbib/lookbib.1
+++ b/usr/src/old/refer/lookbib/lookbib.1
@@ -1,100 +1,148 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1990 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"            @(#)lookbib.1   6.2 (Berkeley) %G%
+.\" %sccs.include.redist.man%

 .\"
 .\"

-.TH LOOKBIB 1 "April 29, 1985"
-.UC 5
-.SH NAME
-indxbib, lookbib \- build inverted index for a bibliography, find references in a bibliography
-.SH SYNOPSIS
-.B indxbib
-database  ...
-.br
-.B lookbib
-[
-.B \-n
-] database
-.SH DESCRIPTION
-.I Indxbib
-makes an inverted index to the named
-.I databases
-(or files) for use by
-.IR lookbib (1)
+.\"     @(#)lookbib.1  6.3 (Berkeley) %G%
+.\"
+.Dd 
+.Dt LOOKBIB 1
+.Os BSD 4.2
+.Sh NAME
+.Nm indxbib , lookbib
+.Nd build inverted index for a bibliography,
+find references in a bibliography
+.Sh SYNOPSIS
+.Nm indxbib
+.Ar database ...
+.Nm lookbib
+.Op Fl n
+.Ar database
+.Sh DESCRIPTION
+.Nm Indxbib
+builds an inverted index to the named
+.Ar databases
+(or files), which can then be
+used by
+.Nm lookbib
+and
+.Xr refer  1  .
+The files are assumed to be
+.Xr refer
+style bibliographic databases
+(see
+.Xr addbib 1 ) .
+.Pp
+.Nm Indxbib
+is a shell script which calls
+.Nm mkey

 and
 and

-.IR refer (1).
-These files contain bibliographic references
-(or other kinds of information) separated by blank lines.
-.PP
-A bibliographic reference is a set of lines,
-constituting fields of bibliographic information.
-Each field starts on a line beginning with a ``%'',
-followed by a key-letter, then a blank,
-and finally the contents of the field,
-which may continue until the next line starting with ``%''.
-.PP
-.I Indxbib 
-is a shell script that calls
-/usr/lib/refer/mkey and /usr/lib/refer/inv.
+.Nm inv .

 The first program,
 The first program,

-.I mkey,
+.Nm mkey ,

 truncates words to 6 characters,
 and maps upper case to lower case.
 It also discards words shorter than 3 characters,
 words among the 100 most common English words,
 and numbers (dates) < 1900 or > 2000.
 truncates words to 6 characters,
 and maps upper case to lower case.
 It also discards words shorter than 3 characters,
 words among the 100 most common English words,
 and numbers (dates) < 1900 or > 2000.

-These parameters can be changed; see page 4 of the
-.I Refer
-document by Mike Lesk.
+These parameters can be changed; see page 4 of a
+.Em Refer
+document by Mike Lesk (See the SEE ALSO section below).

 The second program,
 The second program,

-.I inv,
-creates an entry file (.ia),
-a posting file (.ib), and a tag file (.ic),
+.Nm inv ,
+creates an entry file
+.Cx \&(
+.Ar file
+.Cx .ia),
+.Cx
+a posting file
+.Cx \&(
+.Ar file
+.Cx .ib),
+.Cx
+and a tag file
+.Cx \&(
+.Ar file
+.Cx .ic),
+.Cx

 all in the working directory.
 all in the working directory.

-.PP
-.I Lookbib
+.Pp
+.Nm Lookbib

 uses an inverted index made by
 uses an inverted index made by

-.I indxbib
+.Nm indxbib

 to find sets of bibliographic references.
 It reads keywords typed after the ``>'' prompt on the terminal,
 and retrieves records containing all these keywords.
 If nothing matches, nothing is returned except another ``>'' prompt.
 to find sets of bibliographic references.
 It reads keywords typed after the ``>'' prompt on the terminal,
 and retrieves records containing all these keywords.
 If nothing matches, nothing is returned except another ``>'' prompt.

-.PP
-.I Lookbib
+.Pp
+.Nm Lookbib

 will ask if you need instructions, and will print some brief information if
 will ask if you need instructions, and will print some brief information if

-you reply ``y''.  The ``\-n'' flag turns off the prompt for instructions.
-.PP
+you reply ``y''.  The
+.Fl n
+flag turns off the prompt for instructions.
+.Pp

 It is possible to search multiple databases,
 as long as they have a common index made by
 It is possible to search multiple databases,
 as long as they have a common index made by

-.I indxbib.
+.Nm indxbib .

 In that case, only the first argument given to
 In that case, only the first argument given to

-.I indxbib
+.Nm indxbib

 is specified to
 is specified to

-.I lookbib.
-.PP
+.Nm lookbib .
+.Pp

 If
 If

-.I lookbib
-does not find the index files (the .i[abc] files),
+.Nm lookbib
+does not find the index files (the 
+.Cx \&(
+.Ar file
+.Cx .i[abc]
+.Cx
+files),

 it looks for a reference file with the same name as the argument,
 without the suffixes.
 it looks for a reference file with the same name as the argument,
 without the suffixes.

-It creates a file with a '.ig' suffix, suitable for use with
-.I fgrep.
+It creates a file with a
+`.ig' suffix, suitable for use with
+.Xr fgrep 1 .

 It then uses this fgrep file to find references.
 It then uses this fgrep file to find references.

-This method is simpler to use, but the .ig file is slower to use
-than the .i[abc] files, and does not allow the use of multiple reference files.
-.SH FILES
-.IR x .ia,
-.IR x .ib,
-.IR x .ic,
-where 
-.I x
-is the first argument, or if these are not present, then
-.IR x .ig,
-.IR x
-.SH SEE ALSO
-refer(1), addbib(1), sortbib(1), roffbib(1), lookbib(1)
-.SH BUGS
+This method is simpler to use, but the 
+.Cx Ar file
+.Cx .ig
+.Cx
+is slower to use
+than the 
+.Cx Ar file
+.Cx .i[abc]
+.Cx
+files, and does not allow the use of multiple reference files.
+.Sh FILES
+.Dw /usr/libexec/mkey
+.Di L
+.Dp Pa \&*.ia
+entry file
+.Dp Pa \&*.ib
+posting file
+.Dp Pa \&*.ic
+tag file
+.Dp Pa \&*.ig
+ascii file created if index files not found.
+.Dp Pa /usr/libexec/mkey
+make keys program
+.Dp Pa /usr/libexec/inv
+hash and invert program
+.Dp
+.Sh SEE ALSO
+.Xr refer 1 ,
+.Xr addbib 1 ,
+.Xr sortbib 1 ,
+.Xr roffbib 1 ,
+.Xr lookbib 1
+.Sh BUGS
+More than one blank line in between citations
+can wreak havoc.
+.Pp

 Probably all dates should be indexed,
 since many disciplines refer to literature
 written in the 1800s or earlier.
 Probably all dates should be indexed,
 since many disciplines refer to literature
 written in the 1800s or earlier.

+.Sh HISTORY
+A
+.Nm lookbib
+appeared in Version 32 AT&T Unix.