← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to docs/start-loggerhead.rst

  • Committer: geoffreyfishing at gmail
  • Date: 2011-05-31 02:50:52 UTC
  • mto: (431.2.18 loggerhead) (459.2.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 461.
  • Revision ID: geoffreyfishing@gmail.com-20110531025052-d384l8fyhhrd6fzt
Updated exporter.

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