← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to docs/start-loggerhead.rst

  • Committer: Tres Seaver
  • Date: 2010-03-23 15:44:51 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100323154451-enjul7pa2crkk18b
Add Sphinx-based documentation.

Show diffs side-by-side

added added

removed removed

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