]>
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. | |
78646987 | 32 | Currently apache2, lighttpd, mongoose, plackup and webrick are supported. |
a51d37c1 EW |
33 | (Default: lighttpd) |
34 | ||
3240240f SB |
35 | -m:: |
36 | --module-path:: | |
a51d37c1 EW |
37 | The module path (only needed if httpd is Apache). |
38 | (Default: /usr/lib/apache2/modules) | |
39 | ||
3240240f SB |
40 | -p:: |
41 | --port:: | |
a51d37c1 EW |
42 | The port number to bind the httpd to. (Default: 1234) |
43 | ||
3240240f SB |
44 | -b:: |
45 | --browser:: | |
b261ec46 | 46 | The web browser that should be used to view the gitweb |
28394787 | 47 | page. This will be passed to the 'git web{litdd}browse' helper |
cb45f83c | 48 | script along with the URL of the gitweb instance. See |
28394787 | 49 | linkgit:git-web{litdd}browse[1] for more information about this. If |
cb45f83c | 50 | the script fails, the URL will be printed to stdout. |
a51d37c1 | 51 | |
b73f2941 | 52 | start:: |
a51d37c1 EW |
53 | --start:: |
54 | Start the httpd instance and exit. This does not generate | |
55 | any of the configuration files for spawning a new instance. | |
56 | ||
b73f2941 | 57 | stop:: |
a51d37c1 EW |
58 | --stop:: |
59 | Stop the httpd instance and exit. This does not generate | |
60 | any of the configuration files for spawning a new instance, | |
61 | nor does it close the browser. | |
62 | ||
b73f2941 | 63 | restart:: |
a51d37c1 EW |
64 | --restart:: |
65 | Restart the httpd instance and exit. This does not generate | |
66 | any of the configuration files for spawning a new instance. | |
67 | ||
68 | CONFIGURATION | |
69 | ------------- | |
70 | ||
71 | You may specify configuration in your .git/config | |
72 | ||
73 | ----------------------------------------------------------------------- | |
74 | [instaweb] | |
75 | local = true | |
76 | httpd = apache2 -f | |
77 | port = 4321 | |
78 | browser = konqueror | |
79 | modulepath = /usr/lib/apache2/modules | |
80 | ||
81 | ----------------------------------------------------------------------- | |
82 | ||
c07a07c5 | 83 | If the configuration variable 'instaweb.browser' is not set, |
cb45f83c | 84 | 'web.browser' will be used instead if it is defined. See |
28394787 | 85 | linkgit:git-web{litdd}browse[1] for more information about this. |
b261ec46 | 86 | |
a51d37c1 EW |
87 | Author |
88 | ------ | |
89 | Written by Eric Wong <normalperson@yhbt.net> | |
90 | ||
91 | Documentation | |
92 | -------------- | |
93 | Documentation by Eric Wong <normalperson@yhbt.net>. | |
94 | ||
95 | GIT | |
96 | --- | |
9e1f0a85 | 97 | Part of the linkgit:git[1] suite |