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