1git-instaweb(1) 2=============== 3 4NAME 5---- 6git-instaweb - Instantly browse your working repository in gitweb 7 8SYNOPSIS 9-------- 10[verse] 11'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>] 12 [--browser=<browser>] 13'git instaweb' [--start] [--stop] [--restart] 14 15DESCRIPTION 16----------- 17A simple script to set up `gitweb` and a web server for browsing the local 18repository. 19 20OPTIONS 21------- 22 23-l:: 24--local:: 25 Only bind the web server to the local IP (127.0.0.1). 26 27-d:: 28--httpd:: 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. 32 Currently apache2, lighttpd, mongoose, plackup and webrick are supported. 33 (Default: lighttpd) 34 35-m:: 36--module-path:: 37 The module path (only needed if httpd is Apache). 38 (Default: /usr/lib/apache2/modules) 39 40-p:: 41--port:: 42 The port number to bind the httpd to. (Default: 1234) 43 44-b:: 45--browser:: 46 The web browser that should be used to view the gitweb 47 page. This will be passed to the 'git web--browse' helper 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. 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 80If the configuration variable 'instaweb.browser' is not set, 81'web.browser' will be used instead if it is defined. See 82linkgit:git-web--browse[1] for more information about this. 83 84Author 85------ 86Written by Eric Wong <normalperson@yhbt.net> 87 88Documentation 89-------------- 90Documentation by Eric Wong <normalperson@yhbt.net>. 91 92GIT 93--- 94Part of the linkgit:git[1] suite