summaryrefslogtreecommitdiff
path: root/Documentation/git-instaweb.txt
blob: a1456abeb64801362fefe55127703277874490b2 (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
95
96
97
98
99
100
101
102
103
104
105
106
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 setup 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 lighttpd, apache2 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--browse' helper
	script along with the URL of the gitweb instance. If the
	script fails, the URL will be printed to stdout.
+
Note that the 'git-web--browse' script tries, as much as possible, to
display the HTML page in a new tab on an already opened browser.
+
The following browsers are currently supported by 'git-web--browse':
+
* firefox (this is the default under X Window when not using KDE)
* iceweasel
* konqueror (this is the default under KDE)
* w3m (this is the default outside X Window)
* links
* lynx
* dillo
 
--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.
 
You can explicitly provide a full path to your preferred browser by
setting the configuration variable 'browser.<tool>.path'. For example,
you can configure the absolute path to firefox by setting
'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool
is available in PATH.
 
Author
------
Written by Eric Wong <normalperson@yhbt.net>
 
Documentation
--------------
Documentation by Eric Wong <normalperson@yhbt.net>.
 
GIT
---
Part of the linkgit:git[7] suite