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