Git fork
1git-instaweb(1)
2===============
3
4NAME
5----
6git-instaweb - Instantly browse your working repository in gitweb
7
8SYNOPSIS
9--------
10[verse]
11'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
12 [--browser=<browser>]
13'git instaweb' [--start] [--stop] [--restart]
14
15DESCRIPTION
16-----------
17A simple script to set up `gitweb` and a web server for browsing the local
18repository.
19
20OPTIONS
21-------
22
23-l::
24--local::
25 Only bind the web server to the local IP (127.0.0.1).
26
27-d::
28--httpd::
29 The HTTP daemon command-line that will be executed.
30 Command-line options may be specified here, and the
31 configuration file will be added at the end of the command-line.
32 Currently apache2, lighttpd, mongoose, plackup, python and
33 webrick are supported.
34 (Default: lighttpd)
35
36-m::
37--module-path::
38 The module path (only needed if httpd is Apache).
39 (Default: /usr/lib/apache2/modules)
40
41-p::
42--port::
43 The port number to bind the httpd to. (Default: 1234)
44
45-b::
46--browser::
47 The web browser that should be used to view the gitweb
48 page. This will be passed to the 'git web{litdd}browse' helper
49 script along with the URL of the gitweb instance. See
50 linkgit:git-web{litdd}browse[1] for more information about this. If
51 the script fails, the URL will be printed to stdout.
52
53start::
54--start::
55 Start the httpd instance and exit. Regenerate configuration files
56 as necessary for spawning a new instance.
57
58stop::
59--stop::
60 Stop the httpd instance and exit. This does not generate
61 any of the configuration files for spawning a new instance,
62 nor does it close the browser.
63
64restart::
65--restart::
66 Restart the httpd instance and exit. Regenerate configuration files
67 as necessary for spawning a new instance.
68
69CONFIGURATION
70-------------
71
72You may specify configuration in your .git/config
73
74-----------------------------------------------------------------------
75[instaweb]
76 local = true
77 httpd = apache2 -f
78 port = 4321
79 browser = konqueror
80 modulePath = /usr/lib/apache2/modules
81
82-----------------------------------------------------------------------
83
84If the configuration variable `instaweb.browser` is not set,
85`web.browser` will be used instead if it is defined. See
86linkgit:git-web{litdd}browse[1] for more information about this.
87
88SEE ALSO
89--------
90linkgit:gitweb[1]
91
92GIT
93---
94Part of the linkgit:git[1] suite