Indexable is not marked _done_ until all the child indexables (including child of...
[beagle.git] / beagled / beagle-build-index.8
blobcb2f94455c0b8e6fb5f65bc441fea3ac064bfa12
1 .\" beagle-build-index(8) manpage
2 .\"
3 .\" Copyright (C) 2005 Novell, Inc.
4 .\"
5 .TH BEAGLE "8" "Jul 2005" "beagle" ""
6 .SH NAME
7 beagle-build-index
8 .SH SYNOPSIS
9 .B beagle-build-index
10 [\fIoptions\fR] 
11 <\fIindex_path\fR>
12 <\fIpath\fR>
13 [\fIpath path path\fR]
14 .SH DESCRIPTION
15 .PP
16 .BR beagle-build-index ,
17 is a tool designed for building static indexes outside of the Beagle daemon. 
18 .PP
19 Running
20 .BR beagle-build-index
21 by hand is of use for those wishing to create and build static indexes used by
22 the Beagle daemon. The static indexes can be helpful in many cases but most
23 notably used as system-wide indexes shared by all users, and as a way for
24 system-administrators to run indexing on a central server in a network
25 environment. 
26 .PP
27 .BR beagle-build-index
28 will index the data specified by the \fIpath\fR arguments and create an index
29 in the \fIindex_path\fR directory. If a suitable index is found in the index
30 directory, if will automatically append data to the index if the file at hand
31 has been modified since it was last indexed. If it can't find a suitable index
32 (non-existant or version-mismatch) is will purge the directory recursively.
33 .PP
34 The 
35 .BR beagle-build-index
36 tool is not intended to be invoked by the standard user.
37 .SH OPTIONS
38 .BR beagle-build-index
39 takes the following options
40 .TP
41 .B --recursive
42 If specified, do recursive crawling on the paths specified      
43 .TP
44 .B --debug
45 If specified, echo verbose debugging information
46 .TP
47 .B --cache-text
48 If specified, build text-cache of documents used for snippets
49 .TP
50 .B --allow-pattern [pattern]
51 Only allow files that match the pattern to be indexed.
52 .TP
53 .B --deny-pattern [pattern]
54 Keep any files that match the pattern from being indexed.
55 .TP
56 .B --remap \fR[\fIpath1\fR:\fIpath2\fR]
57 If specified, remap the target path by prefix. \fIpath1\fR will be replaced
58 with \fIpath2\fR. This option is intended to be used when generating pre-built
59 indexes, where the final path will be differ from the current one.
60 .SH AUTHOR
61 Novell, Inc.
62 .SH "REPORTING BUGS"
63 Report bugs to <dashboard-hackers@gnome.org>.
64 .SH COPYRIGHT
65 Copyright \(co 2005 Novell, Inc.
66 .sp
67 This is free software; see the source for copying conditions.  There is NO
68 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
69 .SH "SEE ALSO"
70 .BR beagled (1),
71 .BR beagle-manage-index (8)