1 <?xml version="1.0" encoding="UTF-8"?>
\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
\r
4 <article lang="en" id="git-instaweb(1)">
\r
6 <title>git-instaweb(1)</title>
\r
8 <primary>git-instaweb(1)</primary>
\r
11 <simplesect id="_name">
\r
13 <simpara>git-instaweb - Instantly browse your working repository in gitweb</simpara>
\r
15 <simplesect id="_synopsis">
\r
16 <title>SYNOPSIS</title>
\r
18 <literallayout><emphasis>git instaweb</emphasis> [--local] [--httpd=<httpd>] [--port=<port>]
\r
19 [--browser=<browser>]
\r
20 <emphasis>git instaweb</emphasis> [--start] [--stop] [--restart]</literallayout>
\r
23 <simplesect id="_description">
\r
24 <title>DESCRIPTION</title>
\r
25 <simpara>A simple script to set up <literal>gitweb</literal> and a web server for browsing the local
\r
26 repository.</simpara>
\r
28 <simplesect id="_options">
\r
29 <title>OPTIONS</title>
\r
40 Only bind the web server to the local IP (127.0.0.1).
\r
53 The HTTP daemon command-line that will be executed.
\r
54 Command-line options may be specified here, and the
\r
55 configuration file will be added at the end of the command-line.
\r
56 Currently lighttpd, apache2 and webrick are supported.
\r
70 The module path (only needed if httpd is Apache).
\r
71 (Default: /usr/lib/apache2/modules)
\r
84 The port number to bind the httpd to. (Default: 1234)
\r
97 The web browser that should be used to view the gitweb
\r
98 page. This will be passed to the <emphasis>git-web—browse</emphasis> helper
\r
99 script along with the URL of the gitweb instance. See
\r
100 <xref linkend="git-web—browse(1)"/> for more information about this. If
\r
101 the script fails, the URL will be printed to stdout.
\r
111 Start the httpd instance and exit. This does not generate
\r
112 any of the configuration files for spawning a new instance.
\r
122 Stop the httpd instance and exit. This does not generate
\r
123 any of the configuration files for spawning a new instance,
\r
124 nor does it close the browser.
\r
134 Restart the httpd instance and exit. This does not generate
\r
135 any of the configuration files for spawning a new instance.
\r
141 <simplesect id="_configuration">
\r
142 <title>CONFIGURATION</title>
\r
143 <simpara>You may specify configuration in your .git/config</simpara>
\r
144 <literallayout>[instaweb]
\r
148 browser = konqueror
\r
149 modulepath = /usr/lib/apache2/modules</literallayout>
\r
150 <simpara>If the configuration variable <emphasis>instaweb.browser</emphasis> is not set,
\r
151 <emphasis>web.browser</emphasis> will be used instead if it is defined. See
\r
152 <xref linkend="git-web—browse(1)"/> for more information about this.</simpara>
\r
154 <simplesect id="_author">
\r
155 <title>Author</title>
\r
156 <simpara>Written by Eric Wong <<ulink url="mailto:normalperson@yhbt.net">normalperson@yhbt.net</ulink>></simpara>
\r
158 <simplesect id="_documentation">
\r
159 <title>Documentation</title>
\r
160 <simpara>Documentation by Eric Wong <<ulink url="mailto:normalperson@yhbt.net">normalperson@yhbt.net</ulink>>.</simpara>
\r
162 <simplesect id="_git">
\r
164 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>
\r