BSD 4_4 development
authorCSRG <csrg@ucbvax.Berkeley.EDU>
Fri, 18 Jun 1993 00:12:42 +0000 (16:12 -0800)
committerCSRG <csrg@ucbvax.Berkeley.EDU>
Fri, 18 Jun 1993 00:12:42 +0000 (16:12 -0800)
Work on file usr/contrib/man/cat1/bib.0
Work on file usr/contrib/man/cat1/invert.0

Synthesized-from: CSRG/cd3/4.4

usr/contrib/man/cat1/bib.0 [new file with mode: 0644]
usr/contrib/man/cat1/invert.0 [new file with mode: 0644]

diff --git a/usr/contrib/man/cat1/bib.0 b/usr/contrib/man/cat1/bib.0
new file mode 100644 (file)
index 0000000..bf1bb95
--- /dev/null
@@ -0,0 +1,264 @@
+
+
+
+BIB(1)                        1988                        BIB(1)
+
+
+N\bNA\bAM\bME\bE
+       bib, listrefs, bibinc, bib2tib -        bibliographic formatter
+
+S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
+       b\bbi\bib\bb [options] ...
+       l\bli\bis\bst\btr\bre\bef\bfs\bs        [options] ...
+       b\bbi\bib\bbi\bin\bnc\bc [options]    ...
+
+D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
+       _\bB_\bi_\bb  is   a preprocessor for _\bn_\br_\bo_\bf_\bf or _\bt_\br_\bo_\bf_\bf(1) that formats
+       citations and bibliographies.  The input         files  (standard
+       input  default) are copied to the standard output, except
+       for text        between [. and .]  pairs, which are assumed to be
+       keywords         for  searching  a  bibliographic database.  If a
+       matching         reference  is  found  a  citation  is  generated
+       replacing  the text.  References        are collected, optionally
+       sorted, and written out at a  location  specified  by  the
+       user.   Citation         and  reference formats are controlled by
+       the -t option.
+
+       Reference databases are created using the _\bi_\bn_\bv_\be_\br_\bt     utility.
+
+       The  following  options are available.  Note that standard
+       format styles (see the -t option)  set  options automati-
+       cally.  Thus  if a standard format style is used the user
+       need not        indicate any further options for most  documents.
+
+       -aa     reduce authors first names to abbreviations.
+
+       -ar_\bn_\bu_\bm  reverse the first _\bn_\bu_\bm author's names.  If a number
+              is not given all authors names are reversed.
+
+       -ax     print authors last names        in Caps-Small Caps style.
+              For example Budd becomes BUDD.  This style is used
+              by certain ACM publications.
+
+       -c_\bs_\bt_\br   build citations according  to  the  template  _\bs_\bt_\br.
+              See  the reference format designers guide for more
+              information on templates.
+
+       -d      changes the default  search  directory  for  style
+              files,  include files, etc.  and changes the value
+              of the macro BMACLIB for bib, and of the macro  l]
+              used  to  find  the  troff  macro  definition file
+              bmac.std.  Defaults to /usr/new/lib/bmac.  If  you
+              have  your own private copies of all the necessary
+              files, using this option is  the  easiest  way  to
+              specify them.
+
+       -ea     reduce editors' first names to abbreviations.
+
+       -ex     print editors' last names in Caps-Small Caps style
+              (see -ax option).
+
+
+
+
+September                      2                               1
+
+
+
+
+
+BIB(1)                        1988                        BIB(1)
+
+
+       -er_\bn_\bu_\bm  reverse the first _\bn_\bu_\bm editors' names.  If a number
+              is not given all editors' names are reversed.
+
+       -f      instead of collecting references, dump each refer-
+              ence immediately following the line on  which  the
+              citation  is  placed  (used  for  footnoted refer-
+              ences).
+
+       -i _\bf_\bi_\bl_\be
+
+       -i_\bf_\bi_\bl_\be  process the indicated file, such        as a file of def-
+              initions.  (see technical report for a description
+              of file format).
+
+       -h      replace citations to three or more adjacent refer-
+              ence  items  with  a hyphenated string (eg 2,3,4,5
+              becomes 2-5).  This option implies the -o  option.
+
+       -n_\bs_\bt_\br   turn  off indicated options.  _\bs_\bt_\br must be composed
+              of the letters afhosx.
+
+       -o      contiguous citations are        ordered according the the
+              reference list before being printed (default).
+
+       -p _\bf_\bi_\bl_\be
+
+       -p_\bf_\bi_\bl_\be  instead of  searching  the file INDEX, search the
+              indicated reference  files  before  searching  the
+              system  file.   _\bf_\bi_\bl_\be_\bs is       a comma separated list of
+              inverted indices, created using the  _\bi_\bn_\bv_\be_\br_\bt  util-
+              ity.
+
+       -s_\bs_\bt_\br   sort references according to the  template _\bs_\bt_\br.
+
+       -t _\bt_\by_\bp_\be
+
+       -t_\bt_\by_\bp_\be  use  the         standard  macros and switch settings for
+              the indicated style to generate citations and ref-
+              erences.   There  are  a number of standard styles
+              provided.  In addition users  can  generate  their
+              own  style macros.  See the format designers guide
+              for details.
+
+       -Tib    the abbreviations and macros used all use the  TiB
+              style  of macro call in which the name is enclosed
+              in vertical |bars|.
+
+       -Tibx   instead of processing the input files,  write  the
+              file  bib.m4.in containing m4(I) macro definitions
+              that make converting from bib style to  Tib  style
+              macros  a  little  easier.   Note that m4 does not
+              allow ampersands in macro names: this file and all
+              of  the  files  to  be  converted  will have to be
+              changed by hand.  The m4 macros will _\bo_\bn_\bl_\by identify
+
+
+
+September                      2                               2
+
+
+
+
+
+BIB(1)                        1988                        BIB(1)
+
+
+              words  that  bib would normally expand: they do no
+              other conversions.  After creating .bib.m4.in, run
+              the scriptfile bib2tib passing it the names of the
+              files you wish converted.
+
+       _\bL_\bi_\bs_\bt_\br_\be_\bf_\bs         formats  an  entire  reference  database   file.
+       Options to _\bl_\bi_\bs_\bt_\br_\be_\bf_\bs are the same        as for _\bb_\bi_\bb.
+
+       _\bB_\bi_\bb_\bi_\bn_\bc  is an od    hack tool for solving the problem of mul-
+       tiple define files  for multiple  styles.   Some  journal
+       styles  require that  journal  names  be spelled out com-
+       pletely,        while others allow abbreviated names.  Two  macro
+       definition  files are available that allow this multiplic-
+       ity of style: bibinc.fullnames and  bibinc.shortnames.  A
+       frequent         source  of error is updating one of these files,
+       and forgetting to update        the other.  _\bB_\bi_\bb_\bi_\bn_\bc allows a  sin-
+       gle  file,  say bibinc.names, to define both the long and
+       the short versions of names, and        from which the files bib-
+       inc.fullnames and bibinc.shortnames can easily be created.
+       _\bB_\bi_\bb_\bi_\bn_\bc can also be used to define macro files for the  TiB
+       bibliographic preprocessor.
+
+       _\bB_\bi_\bb_\b2_\bt_\bi_\bb will use  the bib.m4.in file created with the -Tibx
+       option to convert any files you specify into one        using the
+       TiB-style  macro         conventions.  It is a simple script that
+       does about 95% of the necessary grunge work to  make  this
+       conversion,  but        be aware that the user will still need to
+       eyeball the converted files for correctness.  To        make  use
+       of  the facility, run a _\bb_\bi_\bb job with the  -Tibx option: _\bb_\bi_\bb
+       will  not  process  the input  files,  but  will   create
+       bib.m4.in  instead, after gathering together all        the defi-
+       nitions it can find. Then for each of  your  bibliographic
+       database        files, run _\bb_\bi_\bb_\bi_\bn_\bc.
+
+       _\bB_\bi_\bb  was   designed  initially for use with the -ms macros,
+       and uses        a couple of the -ms macros (.ip and .lp)  in  its
+       macro  definitions.  To use it with the -me macros, prefix
+       the file        being sent  to  nroff/troff  with  the  following
+       macro definitions:
+                .de IP
+                .ip \$1 \$2
+                ..
+                .de LP
+                .lp
+                ..
+
+       A  file "bibmac.me" containing these macro definitions may
+       be found        in /usr/new/lib/bmac.
+
+F\bFI\bIL\bLE\bES\bS
+       INDEX              inverted index for reference database
+       /usr/dict/papers/INDEXdefault system index
+       /usr/new/lib/bmac/bmac.*formatting macro        packages
+       /usr/new/lib/bmac/bibinc.namesinput to _\bb_\bi_\bb_\bi_\bn_\bc
+
+
+
+September                      2                               3
+
+
+
+
+
+BIB(1)                        1988                        BIB(1)
+
+
+       /usr/new/lib/bmac/tibmacs/*for use with TiB-style |macros|
+       /usr/new/lib/bmac/bibmacs/*for  use  with  old  bib-style
+       macros
+       /usr/tmp/bibr*     scratch file for collecting references
+       /usr/tmp/bibp*     output of pass one of bib
+       bib.m4.in          macros  for  converting  to  TiB  (see
+       -Tibx above)
+
+S\bSE\bEE\bE A\bAL\bLS\bSO\bO
+       _\bA _\bU_\bN_\bI_\bX _\bB_\bi_\bb_\bl_\bi_\bo_\bg_\br_\ba_\bp_\bh_\bi_\bc _\bD_\ba_\bt_\ba_\bb_\ba_\bs_\be _\bF_\ba_\bc_\bi_\bl_\bi_\bt_\by,     Timothy  A.  Budd
+       and  Gary M. Levin, University of Arizona Technical Report
+       82-1, 1982.  (includes format designers guide).
+       BIB - A Program for Formatting Bibliographies, Timothy  A.
+       Budd, a BSD UNIX        document found in /usr/doc/usd/31.bib.
+       invert(1), troff(1)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+September                      2                               4
+
+
diff --git a/usr/contrib/man/cat1/invert.0 b/usr/contrib/man/cat1/invert.0
new file mode 100644 (file)
index 0000000..4d12389
--- /dev/null
@@ -0,0 +1,198 @@
+
+
+
+INVERT(1)                     1983                     INVERT(1)
+
+
+N\bNA\bAM\bME\bE
+       invert, lookup -        create and access an inverted index
+
+S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
+       i\bin\bnv\bve\ber\brt\bt [option ... ] file ...
+
+       l\blo\boo\bok\bku\bup\bp [option ... ]
+
+D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
+       _\bI_\bn_\bv_\be_\br_\bt  creates     an  inverted  index to one or more files.
+       _\bL_\bo_\bo_\bk_\bu_\bp retrieves    records from files for which an  inverted
+       index  exists.  The inverted indices are intended for use
+       with _\bb_\bi_\bb(1).
+
+       _\bI_\bn_\bv_\be_\br_\bt creates one inverted index  to  all  of  its  input
+       files.  The index must be stored in the current directory
+       and may not be moved.  Input files may  be  absolute  path
+       names  or  paths         relative to the current directory.  Each
+       input file is viewed as a set of        records; each record con-
+       sists  of  non-blank lines; records are separated by blank
+       lines.
+
+       _\bL_\bo_\bo_\bk_\bu_\bp retrieves    records based on its input _\b(_\bs_\bt_\bd_\bi_\bn_\b)_\b.  Each
+       line  of         input  is a retrieval request.  All records that
+       contain all of the keywords in the retrieval  request  are
+       sent to _\bs_\bt_\bd_\bo_\bu_\bt_\b.   If there are no matching references, ``No
+       references found.'' is  sent  to         _\bs_\bt_\bd_\bo_\bu_\bt_\b.    _\bL_\bo_\bo_\bk_\bu_\bp  first
+       searches         in  the user's private index (default INDEX) and
+       then, if        no references are  found,  in  the  system  index
+       (/usr/dict/papers/INDEX).   The system index was produced
+       using _\bi_\bn_\bv_\be_\br_\bt with the default  options;     in  general,  the
+       user is advised to use the defaults.
+
+       Keywords        are a sequence of non-white space characters with
+       non-alphanumeric        characters removed.  Keywords must be  at
+       least  two characters and are truncated (default        length is
+       6).  Some common        words are ignored.  Some lines  of  input
+       are ignored for the purpose of collecting keywords.
+
+       The following options are available for _\bi_\bn_\bv_\be_\br_\bt_\b:
+
+       -c _\bf_\bi_\bl_\be
+
+       -c_\bf_\bi_\bl_\be  File  contains common words, one        per line.  Common
+              words   are   not   used   as   keys.     (Default
+              /usr/new/lib/bmac/common.)
+
+       -k _\bi
+
+       -k_\bi     Maximum       number  of keys kept per record. (Default
+              100)
+
+       -l _\bi
+
+
+
+
+September                      2                               1
+
+
+
+
+
+INVERT(1)                     1983                     INVERT(1)
+
+
+       -l_\bi     Maximum length of keys. (Default      6)
+
+       -p _\bf_\bi_\bl_\be
+
+       -p_\bf_\bi_\bl_\be  File is the name        of the private index file (output
+              of  _\bi_\bn_\bv_\be_\br_\bt).   (Default is INDEX.)  The index must
+              be stored in the current directory.   (Be  careful
+              of  the  second  form.  The shell will not know to
+              expand the file name.  E.g. -p~/index won't  work;
+              use -p ~/index.)
+
+       -s      Silent. Suppress statistics.
+
+       -%_\bs_\bt_\br   Ignore lines that begin with %x where x is in _\bs_\bt_\br_\b.
+              (Default is CNOPVX. See _\bb_\bi_\bb(1) for explanation  of
+              field names.)
+
+       _\bL_\bo_\bo_\bk_\bu_\bp  has  only  the  options     c\bc, l\bl, and p\bp with the same
+       meanings        as _\bb_\bi_\bb_\b.  In particular, the p\bp option can be  fol-
+       lowed by        a list of comma separated index files.  These are
+       searched        in order from left to right until  at  least  one
+       reference is found.
+
+F\bFI\bIL\bLE\bES\bS
+       INDEX                   inverted index
+       /usr/tmp/invertxxxxxx   scratch file for invert
+       /usr/new/lib/bmac/common            default list of common words
+       /usr/dict/papers/INDEX  default system index
+
+S\bSE\bEE\bE A\bAL\bLS\bSO\bO
+       _\bA  _\bU_\bN_\bI_\bX       _\bB_\bi_\bb_\bl_\bi_\bo_\bg_\br_\ba_\bp_\bh_\bi_\bc  _\bD_\ba_\bt_\ba_\bb_\ba_\bs_\be       _\bF_\ba_\bc_\bi_\bl_\bi_\bt_\by, Timothy A. Budd
+       and Gary        M. Levin, University of Arizona Technical  Report
+       82-1, 1982.
+       bib(1)
+
+D\bDI\bIA\bAG\bGN\bNO\bOS\bST\bTI\bIC\bCS\bS
+       Messages         indicating  trouble  accessing files are sent on
+       _\bs_\bt_\bd_\be_\br_\br_\b.   There is  an  explicit  message  on  _\bs_\bt_\bd_\bo_\bu_\bt  from
+       _\bl_\bo_\bo_\bk_\bu_\bp if no references are found.
+
+       _\bI_\bn_\bv_\be_\br_\bt      produces   a   one  line  message  of  the  form,
+       %D documents   %D distinct keys %D key occurrences.  This
+       can be suppressed with the -s option.
+
+       The  message  locate: first key (%s) matched too        many refs
+       indicates that the first        key matched more references  than
+       could  be stored        in memory.  The simple solution is to use
+       a less frequently occurring key as the first  key  in  the
+       citation.
+
+B\bBU\bUG\bGS\bS
+       No  attempt  is made to check the compatibility between an
+       index and the files indexed.  The user must create  a  new
+       index whenever the files        that are indexed are modified.
+
+
+
+September                      2                               2
+
+
+
+
+
+INVERT(1)                     1983                     INVERT(1)
+
+
+       Attempting to invert a file containing unprintable charac-
+       ters can        cause chaos.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+September                      2                               3
+
+