diff options
Diffstat (limited to 'devdocs/git/git-instaweb.html')
| -rw-r--r-- | devdocs/git/git-instaweb.html | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/devdocs/git/git-instaweb.html b/devdocs/git/git-instaweb.html new file mode 100644 index 00000000..313d0217 --- /dev/null +++ b/devdocs/git/git-instaweb.html @@ -0,0 +1,13 @@ +<h1>git-instaweb</h1> <h2 id="_name">Name</h2> <div class="sectionbody"> <p>git-instaweb - Instantly browse your working repository in gitweb</p> </div> <h2 id="_synopsis">Synopsis</h2> <div class="sectionbody"> <div class="verseblock"> <pre class="content" data-language="shell">git instaweb [--local] [--httpd=<httpd>] [--port=<port>] + [--browser=<browser>] +git instaweb [--start] [--stop] [--restart]</pre> </div> </div> <h2 id="_description">Description</h2> <div class="sectionbody"> <p>A simple script to set up <code>gitweb</code> and a web server for browsing the local repository.</p> </div> <h2 id="_options">Options</h2> <div class="sectionbody"> <div class="dlist"> <dl> <dt class="hdlist1" id="Documentation/git-instaweb.txt--l"> -l </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---local"> --local </dt> <dd> <p>Only bind the web server to the local IP (127.0.0.1).</p> </dd> <dt class="hdlist1" id="Documentation/git-instaweb.txt--d"> -d </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---httpd"> --httpd </dt> <dd> <p>The HTTP daemon command-line that will be executed. Command-line options may be specified here, and the configuration file will be added at the end of the command-line. Currently apache2, lighttpd, mongoose, plackup, python and webrick are supported. (Default: lighttpd)</p> </dd> <dt class="hdlist1" id="Documentation/git-instaweb.txt--m"> -m </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---module-path"> --module-path </dt> <dd> <p>The module path (only needed if httpd is Apache). (Default: /usr/lib/apache2/modules)</p> </dd> <dt class="hdlist1" id="Documentation/git-instaweb.txt--p"> -p </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---port"> --port </dt> <dd> <p>The port number to bind the httpd to. (Default: 1234)</p> </dd> <dt class="hdlist1" id="Documentation/git-instaweb.txt--b"> -b </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---browser"> --browser </dt> <dd> <p>The web browser that should be used to view the gitweb page. This will be passed to the <code>git web--browse</code> helper script along with the URL of the gitweb instance. See <a href="git-web--browse">git-web--browse[1]</a> for more information about this. If the script fails, the URL will be printed to stdout.</p> </dd> <dt class="hdlist1" id="Documentation/git-instaweb.txt-start"> start </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---start"> --start </dt> <dd> <p>Start the httpd instance and exit. Regenerate configuration files as necessary for spawning a new instance.</p> </dd> <dt class="hdlist1" id="Documentation/git-instaweb.txt-stop"> stop </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---stop"> --stop </dt> <dd> <p>Stop the httpd instance and exit. This does not generate any of the configuration files for spawning a new instance, nor does it close the browser.</p> </dd> <dt class="hdlist1" id="Documentation/git-instaweb.txt-restart"> restart </dt> <dt class="hdlist1" id="Documentation/git-instaweb.txt---restart"> --restart </dt> <dd> <p>Restart the httpd instance and exit. Regenerate configuration files as necessary for spawning a new instance.</p> </dd> </dl> </div> </div> <h2 id="_configuration">Configuration</h2> <div class="sectionbody"> <p>You may specify configuration in your .git/config</p> <div class="listingblock"> <div class="content"> <pre>[instaweb] + local = true + httpd = apache2 -f + port = 4321 + browser = konqueror + modulePath = /usr/lib/apache2/modules</pre> </div> </div> <p>If the configuration variable <code>instaweb.browser</code> is not set, <code>web.browser</code> will be used instead if it is defined. See <a href="git-web--browse">git-web--browse[1]</a> for more information about this.</p> </div> <h2 id="_see_also">See also</h2> <div class="sectionbody"> <p><a href="gitweb">gitweb[1]</a></p> </div><div class="_attribution"> + <p class="_attribution-p"> + © 2012–2024 Scott Chacon and others<br>Licensed under the MIT License.<br> + <a href="https://git-scm.com/docs/git-instaweb" class="_attribution-link">https://git-scm.com/docs/git-instaweb</a> + </p> +</div> |