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 | 10 | [verse] |
| b1889c36 | 11 | 'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>] |
| 97925fde | 12 | [--browser=<browser>] |
| b1889c36 | 13 | 'git instaweb' [--start] [--stop] [--restart] |
| a51d37c1 EW |
14 | |
| 15 | DESCRIPTION | |
| 16 | ----------- | |
| 483bc4f0 | 17 | A simple script to set up `gitweb` and a web server for browsing the local |
| a51d37c1 EW |
18 | repository. |
| 19 | ||
| 20 | OPTIONS | |
| 21 | ------- | |
| 22 | ||
| 3240240f SB |
23 | -l:: |
| 24 | --local:: | |
| a51d37c1 EW |
25 | Only bind the web server to the local IP (127.0.0.1). |
| 26 | ||
| 3240240f SB |
27 | -d:: |
| 28 | --httpd:: | |
| a51d37c1 EW |
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. | |
| 2eb14bb2 AZ |
32 | Currently apache2, lighttpd, mongoose, plackup, python and |
| 33 | webrick are supported. | |
| a51d37c1 EW |
34 | (Default: lighttpd) |
| 35 | ||
| 3240240f SB |
36 | -m:: |
| 37 | --module-path:: | |
| a51d37c1 EW |
38 | The module path (only needed if httpd is Apache). |
| 39 | (Default: /usr/lib/apache2/modules) | |
| 40 | ||
| 3240240f SB |
41 | -p:: |
| 42 | --port:: | |
| a51d37c1 EW |
43 | The port number to bind the httpd to. (Default: 1234) |
| 44 | ||
| 3240240f SB |
45 | -b:: |
| 46 | --browser:: | |
| b261ec46 | 47 | The web browser that should be used to view the gitweb |
| 28394787 | 48 | page. This will be passed to the 'git web{litdd}browse' helper |
| cb45f83c | 49 | script along with the URL of the gitweb instance. See |
| 28394787 | 50 | linkgit:git-web{litdd}browse[1] for more information about this. If |
| cb45f83c | 51 | the script fails, the URL will be printed to stdout. |
| a51d37c1 | 52 | |
| b73f2941 | 53 | start:: |
| a51d37c1 | 54 | --start:: |
| 5ad6d387 JN |
55 | Start the httpd instance and exit. Regenerate configuration files |
| 56 | as necessary for spawning a new instance. | |
| a51d37c1 | 57 | |
| b73f2941 | 58 | stop:: |
| a51d37c1 EW |
59 | --stop:: |
| 60 | Stop the httpd instance and exit. This does not generate | |
| 61 | any of the configuration files for spawning a new instance, | |
| 62 | nor does it close the browser. | |
| 63 | ||
| b73f2941 | 64 | restart:: |
| a51d37c1 | 65 | --restart:: |
| 5ad6d387 JN |
66 | Restart the httpd instance and exit. Regenerate configuration files |
| 67 | as necessary for spawning a new instance. | |
| a51d37c1 EW |
68 | |
| 69 | CONFIGURATION | |
| 70 | ------------- | |
| 71 | ||
| 72 | You may specify configuration in your .git/config | |
| 73 | ||
| 74 | ----------------------------------------------------------------------- | |
| 75 | [instaweb] | |
| 76 | local = true | |
| 77 | httpd = apache2 -f | |
| 78 | port = 4321 | |
| 79 | browser = konqueror | |
| da0005b8 | 80 | modulePath = /usr/lib/apache2/modules |
| a51d37c1 EW |
81 | |
| 82 | ----------------------------------------------------------------------- | |
| 83 | ||
| ae9f6311 TR |
84 | If the configuration variable `instaweb.browser` is not set, |
| 85 | `web.browser` will be used instead if it is defined. See | |
| 28394787 | 86 | linkgit:git-web{litdd}browse[1] for more information about this. |
| b261ec46 | 87 | |
| 86ce2d54 JN |
88 | SEE ALSO |
| 89 | -------- | |
| 90 | linkgit:gitweb[1] | |
| 91 | ||
| a51d37c1 EW |
92 | GIT |
| 93 | --- | |
| 9e1f0a85 | 94 | Part of the linkgit:git[1] suite |