i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / Documentation / git-instaweb.txt
blobf3eef510f2ba906f64e802a4ea9e1d671530aca4
1 git-instaweb(1)
2 ===============
4 NAME
5 ----
6 git-instaweb - Instantly browse your working repository in gitweb
8 SYNOPSIS
9 --------
10 [verse]
11 'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
12                [--browser=<browser>]
13 'git instaweb' [--start] [--stop] [--restart]
15 DESCRIPTION
16 -----------
17 A simple script to set up `gitweb` and a web server for browsing the local
18 repository.
20 OPTIONS
21 -------
23 -l::
24 --local::
25         Only bind the web server to the local IP (127.0.0.1).
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 and webrick are supported.
33         (Default: lighttpd)
35 -m::
36 --module-path::
37         The module path (only needed if httpd is Apache).
38         (Default: /usr/lib/apache2/modules)
40 -p::
41 --port::
42         The port number to bind the httpd to.  (Default: 1234)
44 -b::
45 --browser::
46         The web browser that should be used to view the gitweb
47         page. This will be passed to the 'git web{litdd}browse' helper
48         script along with the URL of the gitweb instance. See
49         linkgit:git-web{litdd}browse[1] for more information about this. If
50         the script fails, the URL will be printed to stdout.
52 start::
53 --start::
54         Start the httpd instance and exit.  Regenerate configuration files
55         as necessary for spawning a new instance.
57 stop::
58 --stop::
59         Stop the httpd instance and exit.  This does not generate
60         any of the configuration files for spawning a new instance,
61         nor does it close the browser.
63 restart::
64 --restart::
65         Restart the httpd instance and exit.  Regenerate configuration files
66         as necessary for spawning a new instance.
68 CONFIGURATION
69 -------------
71 You may specify configuration in your .git/config
73 -----------------------------------------------------------------------
74 [instaweb]
75         local = true
76         httpd = apache2 -f
77         port = 4321
78         browser = konqueror
79         modulepath = /usr/lib/apache2/modules
81 -----------------------------------------------------------------------
83 If the configuration variable 'instaweb.browser' is not set,
84 'web.browser' will be used instead if it is defined. See
85 linkgit:git-web{litdd}browse[1] for more information about this.
87 SEE ALSO
88 --------
89 linkgit:gitweb[1]
91 GIT
92 ---
93 Part of the linkgit:git[1] suite