/usr/share/doc/loggerhead/html/serve-branches.html is in loggerhead-doc 1.19~bzr461-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>serve-branches — Loggerhead v1.17 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.17',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Loggerhead v1.17 documentation" href="index.html" />
<link rel="prev" title="Loggerhead: A web viewer for bzr branches" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="index.html" title="Loggerhead: A web viewer for bzr branches"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Loggerhead v1.17 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="serve-branches">
<h1><strong class="command">serve-branches</strong><a class="headerlink" href="#serve-branches" title="Permalink to this headline">¶</a></h1>
<p>The <strong class="command">serve-branches</strong> script runs a standalone Loggerhead server in
the foreground.</p>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-sh"><div class="highlight"><pre>serve-branches <span class="o">[</span>OPTIONS<span class="o">]</span> <target directory>
</pre></div>
</div>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--user-dirs">
<tt class="descname">--user-dirs</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--user-dirs" title="Permalink to this definition">¶</a></dt>
<dd><p>Serve user directories as <tt class="docutils literal"><span class="pre">~user</span></tt> (requires <tt class="docutils literal"><span class="pre">--trunk-dir</span></tt>).</p>
<p>If both options are set, then for requests where the CGI <tt class="docutils literal"><span class="pre">PATH_INFO</span></tt>
starts with “/~<name>”, serve branches under the <name> directory.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--trunk-dir">
<tt class="descname">--trunk-dir</tt><tt class="descclassname">=DIR</tt><a class="headerlink" href="#cmdoption-serve-branches--trunk-dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The directory that contains the trunk branches (requires <tt class="docutils literal"><span class="pre">--user-dirs</span></tt>).</p>
<p>If both options are set, then for requests where the CGI <tt class="docutils literal"><span class="pre">PATH_INFO</span></tt>
does not start with “/~<name>”, serve branches under DIR.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--port">
<tt class="descname">--port</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--port" title="Permalink to this definition">¶</a></dt>
<dd><p>Listen on the given port.</p>
<p>Defaults to 8080.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--host">
<tt class="descname">--host</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--host" title="Permalink to this definition">¶</a></dt>
<dd><p>Listen on the interface corresponding to the given IP.</p>
<p>Defaults to listening on all interfaces, i.e., “0.0.0.0”.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--protocol">
<tt class="descname">--protocol</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--protocol" title="Permalink to this definition">¶</a></dt>
<dd><p>Serve the application using the specified protocol.</p>
<p>Can be one of: “http”, “scgi”, “fcgi”, “ajp” (defaults to “http”).</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--prefix">
<tt class="descname">--prefix</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--prefix" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the supplied value as the CGI <tt class="docutils literal"><span class="pre">SCRIPT_NAME</span></tt> for the application.</p>
<p>This option is intended for use when serving Loggerhead behind a
reverse proxy, with Loggerhead being “mounted” at a directory below
the root. E.g., if the reverse proxy translates requests for
<tt class="docutils literal"><span class="pre">http://example.com/loggerhead</span></tt> onto the standalone Loggerhead process,
that process should be run with <tt class="docutils literal"><span class="pre">--prefix=/loggerhead</span></tt>.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--log-folder">
<tt class="descname">--log-folder</tt><tt class="descclassname">=LOG_FOLDER</tt><a class="headerlink" href="#cmdoption-serve-branches--log-folder" title="Permalink to this definition">¶</a></dt>
<dd><p>The directory in which to place Loggerhead’s log files.</p>
<p>Defaults to the current directory.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--cache-dir">
<tt class="descname">--cache-dir</tt><tt class="descclassname">=SQL_CACHE_DIR</tt><a class="headerlink" href="#cmdoption-serve-branches--cache-dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The directory in which to place the SQL cache.</p>
<p>Defaults to the current directory.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--use-cdn">
<tt class="descname">--use-cdn</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--use-cdn" title="Permalink to this definition">¶</a></dt>
<dd><p>Serve YUI javascript libraries from Yahoo!’s CDN.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--allow-writes">
<tt class="descname">--allow-writes</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--allow-writes" title="Permalink to this definition">¶</a></dt>
<dd><p>Allow writing to the Bazaar server.</p>
<p>Setting this option keeps Loggerhead from adding a ‘readonly+’ prefix
to the base URL of the branch. The only effect of suppressing this prefix
is to make visible the display of instructions for checking out the
‘public_branch’ URL for the branch being browsed.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches-h">
<tt class="descname">-h</tt><tt class="descclassname"></tt><tt class="descclassname">, </tt><tt class="descname">--help</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches-h" title="Permalink to this definition">¶</a></dt>
<dd><p>Print the help message and exit</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--version">
<tt class="descname">--version</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--version" title="Permalink to this definition">¶</a></dt>
<dd><p>Print the software version and exit.</p>
</dd></dl>
</div>
<div class="section" id="debugging-options">
<h2>Debugging Options<a class="headerlink" href="#debugging-options" title="Permalink to this headline">¶</a></h2>
<p>The following options are only useful when developing / debugging Loggerhead
itself.</p>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--profile">
<tt class="descname">--profile</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--profile" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate per-request callgrind profile data.</p>
<p>Data for each request is written to a file <tt class="docutils literal"><span class="pre">%d-stats.callgrind</span></tt>,
where <tt class="docutils literal"><span class="pre">%d</span></tt> is replaced by the sequence number of the request.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--memory-profile">
<tt class="descname">--memory-profile</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--memory-profile" title="Permalink to this definition">¶</a></dt>
<dd><p>Profile the memory usage using the <a class="reference external" href="http://pypi.python.org/pypi/Dozer">Dozer</a> middleware.</p>
</dd></dl>
<dl class="cmdoption">
<dt id="cmdoption-serve-branches--reload">
<tt class="descname">--reload</tt><tt class="descclassname"></tt><a class="headerlink" href="#cmdoption-serve-branches--reload" title="Permalink to this definition">¶</a></dt>
<dd><p>Restart the application when any of its python file change.</p>
<p>This option should only used for development purposes.</p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#"><strong class="command">serve-branches</strong></a><ul>
<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#debugging-options">Debugging Options</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Loggerhead: A web viewer for <tt class="docutils literal docutils literal"><span class="pre">bzr</span></tt> branches</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/serve-branches.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="index.html" title="Loggerhead: A web viewer for bzr branches"
>previous</a> |</li>
<li><a href="index.html">Loggerhead v1.17 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Loggerhead team (https://launchpad.net/~loggerhead-team).
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.8.
</div>
</body>
</html>
|