usr/src/man/man1/indxbib.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 INDXBIB 1 "Sep 14, 1992"
   7 .SH NAME
   8 indxbib \- create an inverted index to a bibliographic database
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBindxbib\fR \fIdatabase-file\fR...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBindxbib\fR makes an inverted index to the named \fIdatabase-file\fR (which
  19 must reside within the current directory), typically for use by
  20 \fBlookbib\fR(1) and \fBrefer\fR(1). A \fIdatabase\fR contains bibliographic
  21 references (or other kinds of information) separated by blank lines.
  22 .sp
  23 .LP
  24 A bibliographic reference is a set of lines, constituting fields of
  25 bibliographic information.  Each field starts on a line beginning with a
  26 `\fB%\fR', followed by a key-letter, then a blank, and finally the contents of
  27 the field, which may continue until the next line starting with `\fB%\fR'.
  28 .sp
  29 .LP
  30 \fBindxbib\fR is a shell script that calls two programs:
  31 \fB/usr/lib/refer/mkey\fR and \fB/usr/lib/refer/inv\fR. \fBmkey\fR truncates
  32 words to 6 characters, and maps upper case to lower case.  It also discards
  33 words shorter than 3 characters, words among the 100 most common English words,
  34 and numbers (dates) < 1000 or > 2099.  These parameters can be changed.
  35 .sp
  36 .LP
  37 \fBindxbib\fR creates an entry file (with a \fB\&.ia\fR suffix), a posting file
  38 (\fB\&.ib\fR), and a tag file (\fB\&.ic\fR), in the working directory.
  39 .SH FILES
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fB/usr/lib/refer/mkey\fR\fR
  44 .ad
  45 .RS 23n
  46
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fB/usr/lib/refer/inv\fR\fR
  53 .ad
  54 .RS 23n
  55
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fIx\fR\fB\&.ia\fR\fR
  62 .ad
  63 .RS 23n
  64 entry file
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fIx\fR\fB\&.ib\fR\fR
  71 .ad
  72 .RS 23n
  73 posting file
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIx\fR\fB\&.ic\fR\fR
  80 .ad
  81 .RS 23n
  82 tag file
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fIx\fR\fB\&.ig\fR\fR
  89 .ad
  90 .RS 23n
  91 reference file
  92 .RE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBaddbib\fR(1), \fBlookbib\fR(1), \fBrefer\fR(1), \fBroffbib\fR(1),
  98 \fBsortbib\fR(1), \fBattributes\fR(5)
  99 .SH BUGS
 100 .sp
 101 .LP
 102 All dates should probably be indexed, since many disciplines refer to
 103 literature written in the 1800s or earlier.
 104 .sp
 105 .LP
 106 \fBindxbib\fR does not recognize pathnames.