← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to docs/serve-branches.rst

  • Committer: Tres Seaver
  • Date: 2010-03-23 19:54:47 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100323195447-sfo0bjbqgpzca1na
ReST fixups, better cross-references.

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
 
===========================================================================
 
1
:command:`serve-branches`
 
2
=========================
3
3
 
4
 
The :command:`serve-branches` command runs a standalone loggerhead server in
 
4
The :command:`serve-branches` script runs a standalone loggerhead server in
5
5
the foreground.
6
6
 
7
7
.. program:: serve-branches
13
13
 
14
14
   serve-branches [OPTIONS] <target directory>
15
15
 
16
 
.. cmdoption:: -h, --help
17
 
 
18
 
    Show this help message and exit
 
16
Options
 
17
-------
19
18
 
20
19
.. cmdoption:: --user-dirs
21
20
 
22
 
    Serve user directories as ``~user``. XXX (Requires ``--trunk-dir``).
 
21
    Serve user directories as ``~user`` (requires ``--trunk-dir``).
 
22
 
 
23
    If both options are set, then for requests where the CGI ``PATH_INFO``
 
24
    starts with "/~<name>", serve branches under the <name> directory.
23
25
 
24
26
.. cmdoption:: --trunk-dir=DIR
25
27
 
26
 
    The directory that contains the trunk branches.
 
28
    The directory that contains the trunk branches (requires ``--user-dirs``).
 
29
 
 
30
    If both options are set, then for requests where the CGI ``PATH_INFO``
 
31
    does not start with "/~<name>", serve branches under DIR.
27
32
 
28
33
.. cmdoption:: --port
29
34
 
30
 
    Port Loggerhead should listen on (defaults to 8080).
 
35
    Listen on the given port.
 
36
    
 
37
    Defaults to 8080.
31
38
 
32
39
.. cmdoption:: --host
33
40
 
34
 
    Host Loggerhead should listen on. XXX (defaults to 0.0.0.0).
 
41
    Listen on the interface corresponding to the given IP. 
 
42
    
 
43
    Defaults to listening on all interfaces, i.e., "0.0.0.0".
 
44
 
 
45
.. cmdoption:: --protocol
 
46
 
 
47
    Serve the application using the specified protocol.
 
48
    
 
49
    Can be one of: "http", "scgi", "fcgi", "ajp" (defaults to "http").
35
50
 
36
51
.. cmdoption:: --prefix
37
52
 
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.
 
53
    Set the supplied value as the CGI ``SCRIPT_NAME`` for the application.
 
54
 
 
55
    This option is intended for use when serving Loggerhead behind a
 
56
    reverse proxy, with Loggerhead being "mounted" at a directory below
 
57
    the root.  E.g., if the reverse proxy translates requests for
 
58
    ``http://example.com/loggerhead`` onto the standalone Loggerhead process,
 
59
    that process should be run with ``--prefix=/loggerhead``.
44
60
 
45
61
.. cmdoption:: --log-folder=LOG_FOLDER
46
62
 
47
 
    The directory [XXX in which] to place log files
 
63
    The directory in which to place loggerhead's log files.
 
64
    
 
65
    Defaults to the current directory.
 
66
 
 
67
.. cmdoption:: --cache-dir=SQL_CACHE_DIR
 
68
 
 
69
    The directory in which to place the SQL cache.
 
70
 
 
71
    Defaults to the current directory.
 
72
 
 
73
.. cmdoption:: --use-cdn
 
74
   
 
75
    Serve YUI javascript libraries from Yahoo!'s CDN.
 
76
 
 
77
.. cmdoption:: --allow-writes
 
78
   
 
79
    Allow writing to the Bazaar server.
 
80
    
 
81
    Setting this option keeps loggerhead from adding a 'readonly+' prefix
 
82
    to the base URL of is to make visible the display of instructions for
 
83
    checking out the 'public_branch' URL for the branch being browsed.
 
84
 
 
85
.. cmdoption:: -h, --help
 
86
 
 
87
    Print the help message and exit
48
88
 
49
89
.. cmdoption:: --version
50
90
 
51
91
    Print the software version and exit.
 
92
 
 
93
Debugging Options
 
94
-----------------
 
95
 
 
96
The following options are only useful when developing / debugging Loggerhead
 
97
itself.
 
98
 
 
99
.. cmdoption:: --profile
 
100
   
 
101
    Generate per-request callgrind profile data.
 
102
    
 
103
    Data for each request is written to a file ``%d-stats.callgrind``,
 
104
    where ``%d`` is replaced by the sequence number of the request.
 
105
 
 
106
.. cmdoption:: --memory-profile
 
107
 
 
108
    Profile the memory usage using the `Dozer
 
109
    <http://pypi.python.org/pypi/Dozer>`_ middleware.
 
110
 
 
111
.. cmdoption:: --reload
 
112
 
 
113
    Restart the application when any of its python file change.
 
114
    
 
115
    This option should only used for development purposes.