man-pages/man1/git-instaweb.1.html
2021-03-31 01:06:50 +01:00

169 lines
3.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of GIT-INSTAWEB</TITLE>
</HEAD><BODY>
<H1>GIT-INSTAWEB</H1>
Section: Git Manual (1)<BR>Updated: 03/04/2021<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
git-instaweb - Instantly browse your working repository in gitweb
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<PRE>
<I>git instaweb</I> [--local] [--httpd=&lt;httpd&gt;] [--port=&lt;port&gt;]
[--browser=&lt;browser&gt;]
<I>git instaweb</I> [--start] [--stop] [--restart]
</PRE>
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
A simple script to set up <B>gitweb</B> and a web server for browsing the local repository.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
-l, --local
<DL COMPACT><DT id="1"><DD>
Only bind the web server to the local IP (127.0.0.1).
</DL>
<P>
-d, --httpd
<DL COMPACT><DT id="2"><DD>
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)
</DL>
<P>
-m, --module-path
<DL COMPACT><DT id="3"><DD>
The module path (only needed if httpd is Apache). (Default: /usr/lib/apache2/modules)
</DL>
<P>
-p, --port
<DL COMPACT><DT id="4"><DD>
The port number to bind the httpd to. (Default: 1234)
</DL>
<P>
-b, --browser
<DL COMPACT><DT id="5"><DD>
The web browser that should be used to view the gitweb page. This will be passed to the
<I>git web--browse</I>
helper script along with the URL of the gitweb instance. See
<B><A HREF="/cgi-bin/man/man2html?1+git-web--browse">git-web--browse</A></B>(1)
for more information about this. If the script fails, the URL will be printed to stdout.
</DL>
<P>
start, --start
<DL COMPACT><DT id="6"><DD>
Start the httpd instance and exit. Regenerate configuration files as necessary for spawning a new instance.
</DL>
<P>
stop, --stop
<DL COMPACT><DT id="7"><DD>
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.
</DL>
<P>
restart, --restart
<DL COMPACT><DT id="8"><DD>
Restart the httpd instance and exit. Regenerate configuration files as necessary for spawning a new instance.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>CONFIGURATION</H2>
<P>
You may specify configuration in your .git/config
<P>
<DL COMPACT><DT id="9"><DD>
<PRE>
[instaweb]
local = true
httpd = apache2 -f
port = 4321
browser = konqueror
modulePath = /usr/lib/apache2/modules
</PRE>
</DL>
<P>
<P>
If the configuration variable <B>instaweb.browser</B> is not set, <B>web.browser</B> will be used instead if it is defined. See <B><A HREF="/cgi-bin/man/man2html?1+git-web--browse">git-web--browse</A></B>(1) for more information about this.
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+gitweb">gitweb</A></B>(1)
<A NAME="lbAH">&nbsp;</A>
<H2>GIT</H2>
<P>
Part of the <B><A HREF="/cgi-bin/man/man2html?1+git">git</A></B>(1) suite
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="14"><A HREF="#lbAF">CONFIGURATION</A><DD>
<DT id="15"><A HREF="#lbAG">SEE ALSO</A><DD>
<DT id="16"><A HREF="#lbAH">GIT</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:14 GMT, March 31, 2021
</BODY>
</HTML>