← 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-25 10:28:03 UTC
  • mto: This revision was merged to the branch mainline in revision 405.
  • Revision ID: tseaver@agendaless.com-20100325102803-y42pjxwkzbshzjya
Consistent punctuation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/serve-branches.rst
 
1
:command:`serve-branches`
 
2
=========================
 
3
 
 
4
The :command:`serve-branches` script 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
Options
 
17
-------
 
18
 
 
19
.. cmdoption:: --user-dirs
 
20
 
 
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.
 
25
 
 
26
.. cmdoption:: --trunk-dir=DIR
 
27
 
 
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.
 
32
 
 
33
.. cmdoption:: --port
 
34
 
 
35
    Listen on the given port.
 
36
    
 
37
    Defaults to 8080.
 
38
 
 
39
.. cmdoption:: --host
 
40
 
 
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").
 
50
 
 
51
.. cmdoption:: --prefix
 
52
 
 
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``.
 
60
 
 
61
.. cmdoption:: --log-folder=LOG_FOLDER
 
62
 
 
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
 
88
 
 
89
.. cmdoption:: --version
 
90
 
 
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.