1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
.\" ====================================================================
.\" @Troff-man-file{
.\" author = "Nelson H. F. Beebe",
.\" version = "1.02",
.\" date = "03 October 1992",
.\" time = "14:49:29 MDT",
.\" filename = "bibindex.man",
.\" address = "Center for Scientific Computing
.\" Department of Mathematics
.\" University of Utah
.\" Salt Lake City, UT 84112
.\" USA
.\" Tel: +1 801 581 5254
.\" FAX: +1 801 581 4148",
.\" checksum = "39992 112 591 4491",
.\" email = "beebe@math.utah.edu (Internet)",
.\" codetable = "ISO/ASCII",
.\" keywords = "bibliography, BibTeX",
.\" supported = "yes",
.\" docstring = "This file is the UNIX nroff/troff manual page
.\" documentation for bibindex, a BibTeX bibliography
.\" indexing program.
.\"
.\" The checksum field above contains a CRC-16
.\" checksum as the first value, followed by the
.\" equivalent of the standard UNIX wc (word
.\" count) utility output of lines, words, and
.\" characters. This is produced by Robert
.\" Solovay's checksum utility.",
.\" }
.\" ====================================================================
.if t .ds Bi B\s-2IB\s+2T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X
.if n .ds Bi BibTeX
.if t .ds Te T\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X
.if n .ds Te TeX
.TH BIBINDEX 1 "03 October 1992" "Version 2.2"
.SH NAME
bibindex \- create a bibliography index file for \fBbiblook\fP(1)
.SH SYNOPSIS
.B "bibindex \fIbasename\fP [[\-i] word] [[\-i] word] .\|.\|.
.SH DESCRIPTION
.I bibindex
creates a compact binary index file from a \*(Bi\& bibliography file
to permit fast lookup by \fIbiblook\fP(1). The \fIbasename\fP
argument can optionally omit the \fI.bib\fP extension. The output
index file will be named with the same basename, and extension
\fI.bix\fP.
.PP
For indexing purposes, a word is any contiguous set of letters and
numbers, \fIafter\fP the following steps:
.RS
.TP \w'1.'u+2n
1.
Letters are folded to lower case. Thus, "Voronoi" is
returned as "voronoi"
.TP
2.
All \*(Te\& commands, except those in math expressions, are
removed, but their arguments are left behind. Thus,
"Erd{\\H o}ss" is returned as "erdos".
.TP
3.
All other non-word characters are removed. Non-word
characters inside {{possibly} nested} braces or dollar
signs do not delimit words, so they may cause unexpected
results. Thus, "{this example}" is returned as
"thisexample".
.TP
4.
\*(Te\& commands in math expressions are considered normal
text. Thus, "$O(n\\log^2 n)$" is returned as "onlog2n"
instead of "onn". This occasionally gives unexpected or
unreadable results. For example, "$\\bigcup_1^n[a_i,b_i]$"
is returned as "bigcup1naibi".
.TP
5.
Apostrophes do not delimit words. Thus, "didn't" is
returned as "didnt", and "{\\'O}'D{\\'u}nlaing" is returned
as "odunlaing".
.RE
.PP
\fIbibindex\fP examines the contents of all value strings, and expects
them to be well-formed \*(Te\& input. In particular, braces and
dollar signs should be balanced.
.PP
Errors detected result in a message giving the line number of the
\*(Bi\& entry in which the error was detected, and the line number at
the point of the error. Unbalanced braces or dollar signs can result
in large differences between these line numbers; in such a case, the
error is somewhere in the entry indicated by the first line number.
.SH OPTIONS
.TP \w'\-i'u+2n
.B \-i \fIkeyword\fP
Add \fIkeyword\fP to the list of \*(Bi\& keywords that are to be
ignored, along with their string values, in preparing the index. By
default, all \fIkeyword = "value"\fP pairs are indexed. Any number
of \fB\-i\fP switches and keywords may be specified.
.SH "SEE ALSO"
bibclean(1), biblook(1), bibtex(1), latex(1), tex(1)
.SH AUTHOR
.nf
Jeff Erickson
Computer Science Division
University of California
Berkeley, CA 94720
USA
Email: <jeff@cs.berkeley.edu>, <jeffe@melody.berkeley.edu>
.fi
.PP
This program is in the public domain. You may use it or modify it to
your heart's content, at your own risk.
.\" =======================[End of bibindex.man]========================
|
