1ODIDX(1) Quick Database Manager ODIDX(1)
2
3
4
6 odidx - indexer of document files
7
9 odidx register [-l file] [-wmax num] [-tsuf sufs] [-hsuf sufs]
10 name[dir]
11 odidx relate name
12 odidx purge name
13
15 This manual page documents briefly the odidx commands.
16
17 The command odidx is a utility for indexing files on the local file
18 system. This command is useful for a full-text search system of a Web
19 site. Supported file format are plain text and HTML. Supported charac‐
20 ter encoding are US-ASCII and ISO-8859-1. The URI of each document is
21 specified with the path of its file. Attributes named as title and date
22 are given to each documents. When a document is already existing in the
23 database, it is registered if its last modification time is newer, or
24 it is ignored. Modification times are stored in the sub database
25 `_mtime' in the main database directory. Score information are stored
26 in the sub database `_score' in the main database directory. This com‐
27 mand is used in the above format. name specifies a database name. dir
28 specifies a directory name.
29
31 A summary of options is included below. For a complete description,
32 see the file:///usr/share/doc/qdbm-doc/spex.html#odeumcli.
33
34 -l file
35 read a file and get list of paths of files to register. If `-'
36 is specified, the standard input is read.
37
38 -wmax num
39 specify the max number of words to be stored in the document
40 database.
41
42 -tsuf sufs
43 specify suffixes of plain text files in comma separated format.
44 The default is `-tsuf .txt,.text'.
45
46 -hsuf sufs
47 specify suffixes of HTML files in comma separated format. The
48 default is `-hsuf .html,.htm'.
49
51 For example, to register files which are under `/home/mikio' and whose
52 suffix are `.txt', `.c', or `.h', perform the following command.
53 odidx register -tsuf ".txt,.c,.h" -hsuf "" casket /home/mikio
54
55 Thus, to retrieve documents which include `unix' and `posix' and show
56 the top 8 terms, perform the following command.
57 odmgr search -max 8 -h casket "unix posix"
58
60 qdbm(3), odmgr(1), odeum(3), odopen(3).
61
63 QDBM was written by Mikio Hirabayashi <mikio@fallabs.com>.
64
65 This manual page was written by Fumitoshi UKAI <ukai@debian.or.jp>, for
66 the Debian project (but may be used by others).
67
68
69
70Man Page 2005-05-23 ODIDX(1)