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