~loggerhead-team/loggerhead/trunk-rich

401.2.2 by Tres Seaver
ReST fixups, better cross-references.
1
:command:`start-loggerhead`
2
===========================
401.2.1 by Tres Seaver
Add Sphinx-based documentation.
3
4
The :command:`start-loggerhead` command starts a new standalone loggerhead
401.2.2 by Tres Seaver
ReST fixups, better cross-references.
5
server.  By default, the server runs in the background (daemonized).
401.2.1 by Tres Seaver
Add Sphinx-based documentation.
6
7
.. program:: start-loggerhead
8
9
Usage
10
-----
11
12
.. code-block:: sh
13
14
   start-loggerhead [OPTIONS]
15
401.2.2 by Tres Seaver
ReST fixups, better cross-references.
16
Options
17
-------
18
401.2.1 by Tres Seaver
Add Sphinx-based documentation.
19
.. cmdoption:: --version
20
21
    Print the software version and exit.
22
23
.. cmdoption:: -h, --help
24
25
    Show this help message and exit
26
27
.. cmdoption:: --foreground
28
29
    Run in the foreground;  don't daemonize.
30
31
.. cmdoption:: -C, --check
32
33
    Only start if not already running (useful for cron jobs)
34
35
.. cmdoption:: -p, --pidfile=PIDFILE
36
37
    override pid file location
38
39
.. cmdoption:: -c, --config-file=CONFIGFILE
40
41
   Override configuration file location [XXX default is
42
   :file:`/etc/loggerhead.conf`]
43
44
.. cmdoption:: --log-folder=LOG_FOLDER
45
46
    The directory [XXX in which] to place log files