Google Git
Sign in
chromium / external / gitster / git-htmldocs / a5ec842daf494e5b4141432e38cd2044ebbac61e / . / git-instaweb.txt
blob: 22da21a54f625c434216945889127ec283d3d09f [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 Hamano764a6672007-10-23 01:23:31[diff] [blame]32Currently lighttpd, apache2 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 Hamanoba4b9282008-07-06 05:20:31[diff] [blame]47page. This will be passed to the 'git-web--browse' helper
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]48script along with the URL of the gitweb instance. See
49linkgit:git-web--browse[1] for more information about this. If
50the script fails, the URL will be printed to stdout.
Junio C Hamano7ec15722006-07-07 02:03:59[diff] [blame]51
52--start::
53Start the httpd instance and exit. This does not generate
54any of the configuration files for spawning a new instance.
55
56--stop::
57Stop the httpd instance and exit. This does not generate
58any of the configuration files for spawning a new instance,
59nor does it close the browser.
60
61--restart::
62Restart the httpd instance and exit. This does not generate
63any of the configuration files for spawning a new instance.
64
65CONFIGURATION
66-------------
67
68You may specify configuration in your .git/config
69
70-----------------------------------------------------------------------
71[instaweb]
72local = true
73httpd = apache2 -f
74port = 4321
75browser = konqueror
76modulepath = /usr/lib/apache2/modules
77
78-----------------------------------------------------------------------
79
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]80If the configuration variable 'instaweb.browser' is not set,
Junio C Hamano26e590a2008-02-17 03:53:51[diff] [blame]81'web.browser' will be used instead if it is defined. See
82linkgit:git-web--browse[1] for more information about this.
Junio C Hamano0c0da5f2007-12-13 02:45:30[diff] [blame]83
Junio C Hamano7ec15722006-07-07 02:03:59[diff] [blame]84Author
85------
86Written by Eric Wong <normalperson@yhbt.net>
87
88Documentation
89--------------
90Documentation by Eric Wong <normalperson@yhbt.net>.
91
92GIT
93---
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]94Part of the linkgit:git[1] suite