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