Annotation of 43BSDReno/usr.bin/refer/lookbib/lookbib.1, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983, 1990 Regents of the University of California.
                      2: .\" All rights reserved.
                      3: .\"
                      4: .\" Redistribution and use in source and binary forms are permitted provided
                      5: .\" that: (1) source distributions retain this entire copyright notice and
                      6: .\" comment, and (2) distributions including binaries display the following
                      7: .\" acknowledgement:  ``This product includes software developed by the
                      8: .\" University of California, Berkeley and its contributors'' in the
                      9: .\" documentation or other materials provided with the distribution and in
                     10: .\" all advertising materials mentioning features or use of this software.
                     11: .\" Neither the name of the University nor the names of its contributors may
                     12: .\" be used to endorse or promote products derived from this software without
                     13: .\" specific prior written permission.
                     14: .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
                     15: .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
                     16: .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
                     17: .\"
                     18: .\"     @(#)lookbib.1  6.3 (Berkeley) 7/24/90
                     19: .\"
                     20: .Dd July 24, 1990
                     21: .Dt LOOKBIB 1
                     22: .Os BSD 4.2
                     23: .Sh NAME
                     24: .Nm indxbib , lookbib
                     25: .Nd build inverted index for a bibliography,
                     26: find references in a bibliography
                     27: .Sh SYNOPSIS
                     28: .Nm indxbib
                     29: .Ar database ...
                     30: .Nm lookbib
                     31: .Op Fl n
                     32: .Ar database
                     33: .Sh DESCRIPTION
                     34: .Nm Indxbib
                     35: builds an inverted index to the named
                     36: .Ar databases
                     37: (or files), which can then be
                     38: used by
                     39: .Nm lookbib
                     40: and
                     41: .Xr refer  1  .
                     42: The files are assumed to be
                     43: .Xr refer
                     44: style bibliographic databases
                     45: (see
                     46: .Xr addbib 1 ) .
                     47: .Pp
                     48: .Nm Indxbib
                     49: is a shell script which calls
                     50: .Nm mkey
                     51: and
                     52: .Nm inv .
                     53: The first program,
                     54: .Nm mkey ,
                     55: truncates words to 6 characters,
                     56: and maps upper case to lower case.
                     57: It also discards words shorter than 3 characters,
                     58: words among the 100 most common English words,
                     59: and numbers (dates) < 1900 or > 2000.
                     60: These parameters can be changed; see page 4 of a
                     61: .Em Refer
                     62: document by Mike Lesk (See the SEE ALSO section below).
                     63: The second program,
                     64: .Nm inv ,
                     65: creates an entry file
                     66: .Cx \&(
                     67: .Ar file
                     68: .Cx .ia),
                     69: .Cx
                     70: a posting file
                     71: .Cx \&(
                     72: .Ar file
                     73: .Cx .ib),
                     74: .Cx
                     75: and a tag file
                     76: .Cx \&(
                     77: .Ar file
                     78: .Cx .ic),
                     79: .Cx
                     80: all in the working directory.
                     81: .Pp
                     82: .Nm Lookbib
                     83: uses an inverted index made by
                     84: .Nm indxbib
                     85: to find sets of bibliographic references.
                     86: It reads keywords typed after the ``>'' prompt on the terminal,
                     87: and retrieves records containing all these keywords.
                     88: If nothing matches, nothing is returned except another ``>'' prompt.
                     89: .Pp
                     90: .Nm Lookbib
                     91: will ask if you need instructions, and will print some brief information if
                     92: you reply ``y''.  The
                     93: .Fl n
                     94: flag turns off the prompt for instructions.
                     95: .Pp
                     96: It is possible to search multiple databases,
                     97: as long as they have a common index made by
                     98: .Nm indxbib .
                     99: In that case, only the first argument given to
                    100: .Nm indxbib
                    101: is specified to
                    102: .Nm lookbib .
                    103: .Pp
                    104: If
                    105: .Nm lookbib
                    106: does not find the index files (the 
                    107: .Cx \&(
                    108: .Ar file
                    109: .Cx .i[abc]
                    110: .Cx
                    111: files),
                    112: it looks for a reference file with the same name as the argument,
                    113: without the suffixes.
                    114: It creates a file with a
                    115: `.ig' suffix, suitable for use with
                    116: .Xr fgrep 1 .
                    117: It then uses this fgrep file to find references.
                    118: This method is simpler to use, but the 
                    119: .Cx Ar file
                    120: .Cx .ig
                    121: .Cx
                    122: is slower to use
                    123: than the 
                    124: .Cx Ar file
                    125: .Cx .i[abc]
                    126: .Cx
                    127: files, and does not allow the use of multiple reference files.
                    128: .Sh FILES
                    129: .Dw /usr/libexec/mkey
                    130: .Di L
                    131: .Dp Pa \&*.ia
                    132: entry file
                    133: .Dp Pa \&*.ib
                    134: posting file
                    135: .Dp Pa \&*.ic
                    136: tag file
                    137: .Dp Pa \&*.ig
                    138: ascii file created if index files not found.
                    139: .Dp Pa /usr/libexec/mkey
                    140: make keys program
                    141: .Dp Pa /usr/libexec/inv
                    142: hash and invert program
                    143: .Dp
                    144: .Sh SEE ALSO
                    145: .Xr refer 1 ,
                    146: .Xr addbib 1 ,
                    147: .Xr sortbib 1 ,
                    148: .Xr roffbib 1 ,
                    149: .Xr lookbib 1
                    150: .Sh BUGS
                    151: More than one blank line in between citations
                    152: can wreak havoc.
                    153: .Pp
                    154: Probably all dates should be indexed,
                    155: since many disciplines refer to literature
                    156: written in the 1800s or earlier.
                    157: .Sh HISTORY
                    158: A
                    159: .Nm lookbib
                    160: appeared in Version 32 AT&T Unix.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.