← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to docs/serve-branches.rst

  • Committer: Guillermo Gonzalez
  • Date: 2008-09-10 00:02:06 UTC
  • mto: This revision was merged to the branch mainline in revision 221.
  • Revision ID: guillo.gonzo@gmail.com-20080910000206-kt35kgrzu8y4472v
 * update NEWS and serve-branches man page 
 * refactored all reload logic into loggerhead.util.Reloader class

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/serve-branches.rst
1
 
:command:`serve-branches`:  Run a loggerhead server [XXX in the foreground]
2
 
===========================================================================
3
 
 
4
 
The :command:`serve-branches` command runs a standalone loggerhead server in
5
 
the foreground.
6
 
 
7
 
.. program:: serve-branches
8
 
 
9
 
Usage
10
 
-----
11
 
 
12
 
.. code-block:: sh
13
 
 
14
 
   serve-branches [OPTIONS] <target directory>
15
 
 
16
 
.. cmdoption:: -h, --help
17
 
 
18
 
    Show this help message and exit
19
 
 
20
 
.. cmdoption:: --user-dirs
21
 
 
22
 
    Serve user directories as ``~user``. XXX (Requires ``--trunk-dir``).
23
 
 
24
 
.. cmdoption:: --trunk-dir=DIR
25
 
 
26
 
    The directory that contains the trunk branches.
27
 
 
28
 
.. cmdoption:: --port
29
 
 
30
 
    Port Loggerhead should listen on (defaults to 8080).
31
 
 
32
 
.. cmdoption:: --host
33
 
 
34
 
    Host Loggerhead should listen on. XXX (defaults to 0.0.0.0).
35
 
 
36
 
.. cmdoption:: --prefix
37
 
 
38
 
    Specify host prefix. XXX this is wildly unclear.
39
 
 
40
 
.. cmdoption:: --reload
41
 
 
42
 
    Restarts the application when changing python files. Only used for
43
 
    development purposes.
44
 
 
45
 
.. cmdoption:: --log-folder=LOG_FOLDER
46
 
 
47
 
    The directory [XXX in which] to place log files
48
 
 
49
 
.. cmdoption:: --version
50
 
 
51
 
    Print the software version and exit.