Google Git
Sign in
googlers / jrn / git / b03a71a660d15d76b63d7d3c5205b896f89f34b5 / . / Documentation / git-instaweb.txt
blob: 22da21a54f625c434216945889127ec283d3d09f [file] [log] [blame]
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]1git-instaweb(1)
2===============
3
4NAME
5----
Junio C Hamanoc3f0baa2007-01-18 15:53:37 -0800[diff] [blame]6git-instaweb - Instantly browse your working repository in gitweb
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]7
8SYNOPSIS
9--------
Matthias Kestenholz97925fd2007-05-18 15:39:34 +0200[diff] [blame]10[verse]
Jonathan Niederb1889c32008-06-30 01:09:04 -0500[diff] [blame]11'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
Matthias Kestenholz97925fd2007-05-18 15:39:34 +0200[diff] [blame]12 [--browser=<browser>]
Jonathan Niederb1889c32008-06-30 01:09:04 -0500[diff] [blame]13'git instaweb' [--start] [--stop] [--restart]
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]14
15DESCRIPTION
16-----------
Jonathan Nieder483bc4f2008-06-30 13:56:34 -0500[diff] [blame]17A simple script to set up `gitweb` and a web server for browsing the local
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]18repository.
19
20OPTIONS
21-------
22
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]23-l::
24--local::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]25 Only bind the web server to the local IP (127.0.0.1).
26
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]27-d::
28--httpd::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]29 The HTTP daemon command-line that will be executed.
30 Command-line options may be specified here, and the
31 configuration file will be added at the end of the command-line.
Mike Dalessio425b78e2007-10-06 13:29:49 -0400[diff] [blame]32 Currently lighttpd, apache2 and webrick are supported.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]33 (Default: lighttpd)
34
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]35-m::
36--module-path::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]37 The module path (only needed if httpd is Apache).
38 (Default: /usr/lib/apache2/modules)
39
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]40-p::
41--port::
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]42 The port number to bind the httpd to. (Default: 1234)
43
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]44-b::
45--browser::
Christian Couderb261ec42008-02-09 07:10:57 +0100[diff] [blame]46 The web browser that should be used to view the gitweb
Jonathan Niederba020ef2008-07-03 00:41:41 -0500[diff] [blame]47 page. This will be passed to the 'git-web--browse' helper
Christian Coudercb45f832008-02-14 08:01:23 +0100[diff] [blame]48 script along with the URL of the gitweb instance. See
49 linkgit:git-web--browse[1] for more information about this. If
50 the script fails, the URL will be printed to stdout.
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]51
52--start::
53 Start the httpd instance and exit. This does not generate
54 any of the configuration files for spawning a new instance.
55
56--stop::
57 Stop the httpd instance and exit. This does not generate
58 any of the configuration files for spawning a new instance,
59 nor does it close the browser.
60
61--restart::
62 Restart the httpd instance and exit. This does not generate
63 any 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]
72 local = true
73 httpd = apache2 -f
74 port = 4321
75 browser = konqueror
76 modulepath = /usr/lib/apache2/modules
77
78-----------------------------------------------------------------------
79
Christian Couderc07a07c2007-12-05 06:09:40 +0100[diff] [blame]80If the configuration variable 'instaweb.browser' is not set,
Christian Coudercb45f832008-02-14 08:01:23 +0100[diff] [blame]81'web.browser' will be used instead if it is defined. See
82linkgit:git-web--browse[1] for more information about this.
Christian Couderb261ec42008-02-09 07:10:57 +0100[diff] [blame]83
Eric Wonga51d37c2006-07-01 15:14:14 -0700[diff] [blame]84Author
85------
86Written by Eric Wong <normalperson@yhbt.net>
87
88Documentation
89--------------
90Documentation by Eric Wong <normalperson@yhbt.net>.
91
92GIT
93---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200[diff] [blame]94Part of the linkgit:git[1] suite