Code

user-manual: Add section on ignoring files
[git.git] / Documentation / git-instaweb.txt
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 and apache2 are the only supported servers.
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::
42         The web browser command-line to execute to view the gitweb page.
43         If blank, the URL of the gitweb instance will be printed to
44         stdout.  (Default: 'firefox')
46 --start::
47         Start the httpd instance and exit.  This does not generate
48         any of the configuration files for spawning a new instance.
50 --stop::
51         Stop the httpd instance and exit.  This does not generate
52         any of the configuration files for spawning a new instance,
53         nor does it close the browser.
55 --restart::
56         Restart the httpd instance and exit.  This does not generate
57         any of the configuration files for spawning a new instance.
59 CONFIGURATION
60 -------------
62 You may specify configuration in your .git/config
64 -----------------------------------------------------------------------
65 [instaweb]
66         local = true
67         httpd = apache2 -f
68         port = 4321
69         browser = konqueror
70         modulepath = /usr/lib/apache2/modules
72 -----------------------------------------------------------------------
74 Author
75 ------
76 Written by Eric Wong <normalperson@yhbt.net>
78 Documentation
79 --------------
80 Documentation by Eric Wong <normalperson@yhbt.net>.
82 GIT
83 ---
84 Part of the gitlink:git[7] suite