Thumbnail file hits. Based on a patch from D Bera
[beagle.git] / beagled / beagled.1
blob14058bffff1098dd4b74542fc1def7802d554a38
1 .\" beagled(1) manpage
2 .\"
3 .\" Copyright (C) 2005 Novell, Inc.
4 .\"
5 .TH BEAGLE "1" "Feb 2005" "beagle" "Linux User's Manual"
6 .SH NAME
7 beagled \- the Beagle 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 background.
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 --allow-backend \flbackend\fP
45 Constrain the Beagle daemon to only use specified backends. This argument can
46 be used multiple times.
47 .TP
48 .B --deny-backend \flbackend\fP
49 Constrain the Beagle daemon by disabling specified backends. This argument can
50 be used multiple times.
51 .TP
52 .B --list-backends
53 Retrieve a list of all known backends. This list of backends can then be
54 used with with the --allow/deny-backend options. Using this argument will
55 print out the list of backends and then exit.
56 .TP
57 .B --disable-scheduler
58 Disable the internal scheduler and thus refrain the Beagle daemon from
59 performing any crawling or indexing. Search facilities will remain enabled.
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 beagle-query (1),
71 .BR beagle-status (1),
72 .BR beagle-shutdown (1),
73 .BR best (1)