Tokenize 001234 as 1234. Include a testing function in NoiseFilter to figure out...
[beagle.git] / beagled / beagled.1
blob58a76970f03b176446c6c7e8e8ae915d5d52e75c
1 .\" beagled(1) manpage
2 .\" 
3 .\" Copyright (C) 2005-2006 Novell, Inc.
4 .\" 
5 .TH "BEAGLE" "1" "June 2006" "beagle" "Linux User's Manual"
6 .SH "NAME"
7 beagled \- the Beagle desktop search daemon
8 .SH "SYNOPSIS"
9 .B beagled
10 [\fIoptions\fR]
11 .SH "DESCRIPTION"
12 .PP 
13 .BR beagled ,
14 the Beagle daemon, is the heart of Beagle, a system for searching and managing
15 your personal information space.  The Beagle daemon should normally be started
16 as part of your system's boot process: For example, by an initscript.
17 .PP 
18 Running
19 .BR beagled
20 by hand is of use for those wishing to customize the Beagle daemon's execution
21 via command\-line options, developers testing Beagle, or those who use Beagle
22 only infrequently.
23 .SH "OPTIONS"
24 .BR beagled
25 has many options, although most are for debugging and fine\-tuning execution and
26 are thus not required for standard use.
27 .TP 
28 .B \-\-foreground|\-\-fg
29 If specified, execute the Beagle daemon in the foreground.
30 .TP 
31 .B \-\-background|\-\-bg
32 If specified, execute the Beagle daemon in the background (default).
33 .TP 
34 .B \-\-replace
35 If specified, the daemon tries to shutdown and replace any other Beagle daemon
36 already running.
37 .TP 
38 .B \-\-debug
39 Enable extensive logging suited for general debugging purposes.
40 .TP 
41 .B \-\-debug\-memory
42 Enable extensive logging suited for memory debugging purposes.
43 .TP 
44 .B \-\-indexing\-test\-mode
45  Run in foreground, and exit when fully indexed.
46 .TP 
47 .B \-\-indexing\-delay 
48 Time to wait before indexing.  (Default 60 seconds)
49 .TP 
50 .B \-\-backend           
51 Configure which backends to use.  
52 .TP 
53 .B      \-\-backend <name>    
54         Only start backend 'name'
55 .TP 
56 .B      \-\-backend +<name>
57         Additionally start backend 'name'       
58 .TP 
59 .B      \-\-backend \-<name>
60         Disable backend 'name'  
61 .TP 
62 .B \-\-allow\-backend \flbackend
63 (DEPRECIATED) Constrain the Beagle daemon to only use specified backends. This argument can
64 be used multiple times.
65 .TP 
66 .B \-\-deny\-backend \flbackend
67 (DEPRECIATED) Constrain the Beagle daemon by disabling specified backends. This argument can
68 be used multiple times.
69 .TP 
70 .B \-\-list\-backends
71 Retrieve a list of all known backends. This list of backends can then be
72 used with with the \-\-allow/deny\-backend options. Using this argument will
73 print out the list of backends and then exit.
74 .TP 
75 .B \-\-add\-static\-backend
76 Add a static backend by path.
77 .TP 
78 .B \-\-disable\-scheduler
79 Disable the internal scheduler and thus refrain the Beagle daemon from
80 performing any crawling or indexing. Search facilities will remain enabled.
81 .SH "AUTHOR"
82 Novell, Inc.
83 .SH "REPORTING BUGS"
84 Report bugs to bugs.gnome.org
85 .SH "COPYRIGHT"
86 Copyright \(co 2005-2006 Novell, Inc.
87 .sp
88 This is free software; see the source for copying conditions.  There is NO
89 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
90 .SH "SEE ALSO"
91 .BR beagle\-query (1),
92 .BR beagle\-status (1),
93 .BR beagle\-shutdown (1),