Export some email and pretty-printing functions
[git/jnareb-git.git] / Documentation / git-instaweb.txt
blob51f1532ef7ce34786ec0dcae32b9e60b710cc9c4
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 setup gitweb and a web server for browsing the local
18 repository.
20 OPTIONS
21 -------
23 -l|--local::
24         Only bind the web server to the local IP (127.0.0.1).
26 -d|--httpd::
27         The HTTP daemon command-line that will be executed.
28         Command-line options may be specified here, and the
29         configuration file will be added at the end of the command-line.
30         Currently lighttpd, apache2 and webrick are supported.
31         (Default: lighttpd)
33 -m|--module-path::
34         The module path (only needed if httpd is Apache).
35         (Default: /usr/lib/apache2/modules)
37 -p|--port::
38         The port number to bind the httpd to.  (Default: 1234)
40 -b|--browser::
41         The web browser that should be used to view the gitweb
42         page. This will be passed to the 'git-web--browse' helper
43         script along with the URL of the gitweb instance. See
44         linkgit:git-web--browse[1] for more information about this. If
45         the script fails, the URL will be printed to stdout.
47 --start::
48         Start the httpd instance and exit.  This does not generate
49         any of the configuration files for spawning a new instance.
51 --stop::
52         Stop the httpd instance and exit.  This does not generate
53         any of the configuration files for spawning a new instance,
54         nor does it close the browser.
56 --restart::
57         Restart the httpd instance and exit.  This does not generate
58         any of the configuration files for spawning a new instance.
60 CONFIGURATION
61 -------------
63 You may specify configuration in your .git/config
65 -----------------------------------------------------------------------
66 [instaweb]
67         local = true
68         httpd = apache2 -f
69         port = 4321
70         browser = konqueror
71         modulepath = /usr/lib/apache2/modules
73 -----------------------------------------------------------------------
75 If the configuration variable 'instaweb.browser' is not set,
76 'web.browser' will be used instead if it is defined. See
77 linkgit:git-web--browse[1] for more information about this.
79 Author
80 ------
81 Written by Eric Wong <normalperson@yhbt.net>
83 Documentation
84 --------------
85 Documentation by Eric Wong <normalperson@yhbt.net>.
87 GIT
88 ---
89 Part of the linkgit:git[7] suite