Penguin
Recent Changes
Annotated edit history of indxbib(1) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 INDXBIB
2 !!!INDXBIB
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 FILES
8 SEE ALSO
9 ----
10 !!NAME
11
12
13 indxbib - make inverted index for bibliographic databases
14 !!SYNOPSIS
15
16
17 __indxbib__ [[ __-vw__ ] [[ __-c__''file'' ] [[
18 __-d__''dir'' ] [[ __-f__''file'' ] [[
19 __-h__''n'' ] [[ __-i__''string'' ] [[
20 __-k__''n'' ] [[ __-l__''n'' ] [[
21 __-n__''n'' ] [[ __-o__''file'' ] [[
22 __-t__''n'' ] [[ ''filename''... ]
23
24
25 It is possible to have whitespace between a command line
26 option and its parameter.
27 !!DESCRIPTION
28
29
30 __indxbib__ makes an inverted index for the bibliographic
31 databases in ''filename''... for use with
32 refer(1), lookbib(1), and lkbib(1). The
33 index will be named ''filename''__.i__; the index is
34 written to a temporary file which is then renamed to this.
35 If no filenames are given on the command line because the
36 __-f__ option has been used, and no __-o__ option is
37 given, the index will be named __Ind.i__.
38
39
40 Bibliographic databases are divided into records by blank
41 lines. Within a record, each fields starts with a __%__
42 character at the beginning of a line. Fields have a one
43 letter name which follows the __%__
44 character.
45
46
47 The values set by the __-c__, __-n__, __-l__ and
48 __-t__ options are stored in the index; when the index is
49 searched, keys will be discarded and truncated in a manner
50 appropriate to these options; the original keys will be used
51 for verifying that any record found using the index actually
52 contains the keys. This means that a user of an index need
53 not know whether these options were used in the creation of
54 the index, provided that not all the keys to be searched for
55 would have been discarded during indexing and that the user
56 supplies at least the part of each key that would have
57 remained after being truncated during indexing. The value
58 set by the __-i__ option is also stored in the index and
59 will be used in verifying records found using the
60 index.
61 !!OPTIONS
62
63
64 __-v__
65
66
67 Print the version number.
68
69
70 __-w__
71
72
73 Index whole files. Each file is a separate
74 record.
75
76
77 __-c__''file''
78
79
80 Read the list of common words from ''file'' instead of
81 __/usr/share/groff/1.17.2/eign__.
82
83
84 __-d__''dir''
85
86
87 Use ''dir'' as the pathname of the current working
88 directory to store in the index, instead of the path printed
89 by pwd(1). Usually ''dir'' will be a symbolic link
90 that points to the directory printed by
91 pwd(1).
92
93
94 __-f__''file''
95
96
97 Read the files to be indexed from ''file''. If
98 ''file'' is __-__, files will be read from the
99 standard input. The __-f__ option can be given at most
100 once.
101
102
103 __-i__''string''
104
105
106 Don't index the contents of fields whose names are in
107 ''string''. Initially ''string'' is
108 __XYZ__.
109
110
111 __-h__''n''
112
113
114 Use the first prime greater than or equal to ''n'' for
115 the size of the hash table. Larger values of ''n'' will
116 usually make searching faster, but will make the index
117 larger and __indxbib__ use more memory. Initially
118 ''n'' is 997.
119
120
121 __-k__''n''
122
123
124 Use at most ''n'' keys per input record. Initially
125 ''n'' is 100.
126
127
128 __-l__''n''
129
130
131 Discard keys that are shorter than ''n''. Initially
132 ''n'' is 3.
133
134
135 __-n__''n''
136
137
138 Discard the ''n'' most common words. Initially ''n''
139 is 100.
140
141
142 __-o__''basename''
143
144
145 The index should be named
146 ''basename''__.i__.
147
148
149 __-t__''n''
150
151
152 Truncate keys to ''n''. Initially ''n'' is
153 6.
154 !!FILES
155
156
157 ''filename''__.i__
158
159
160 Index.
161
162
163 __Ind.i__ Default index name.
164
165
166 __/usr/share/groff/1.17.2/eign__
167
168
169 List of common words.
170
171
172 __indxbib__''XXXXXX''
173
174
175 Temporary file.
176 !!SEE ALSO
177
178
179 refer(1), lkbib(1),
180 lookbib(1)
181 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.