5ad6d387f1
Currently start/restart does not generate any configuration files for spawning a new instance. This means that $ git instaweb --http=<server> --start might pick up stale 'httpd.conf' file for a different web server (e.g. for default lighttpd when requesting apache2). This commit changes that, and makes git-instaweb generate web server config file and/or gitweb config file if don't exists. This required naming config files after the name of web server (alternate solution would be to somehow mark for which web server was config file generated). Note that web servers that embed configuration in server script file, namely webrick and plackup, and which delete "$conf" in their *_conf function, would have their config (server script) always regenerated. Note: this commit introduces a bit of code repetition (but only a few lines). Reported-by: Gurjeet Singh <singh.gurjeet@gmail.com> Signed-off-by: Jakub Narebski <jnareb@gmail.com> Acked-by: Eric Wong <normalperson@yhbt.net>
90 lines
2.2 KiB
Plaintext
90 lines
2.2 KiB
Plaintext
git-instaweb(1)
|
|
===============
|
|
|
|
NAME
|
|
----
|
|
git-instaweb - Instantly browse your working repository in gitweb
|
|
|
|
SYNOPSIS
|
|
--------
|
|
[verse]
|
|
'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
|
|
[--browser=<browser>]
|
|
'git instaweb' [--start] [--stop] [--restart]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
A simple script to set up `gitweb` and a web server for browsing the local
|
|
repository.
|
|
|
|
OPTIONS
|
|
-------
|
|
|
|
-l::
|
|
--local::
|
|
Only bind the web server to the local IP (127.0.0.1).
|
|
|
|
-d::
|
|
--httpd::
|
|
The HTTP daemon command-line that will be executed.
|
|
Command-line options may be specified here, and the
|
|
configuration file will be added at the end of the command-line.
|
|
Currently apache2, lighttpd, mongoose, plackup and webrick are supported.
|
|
(Default: lighttpd)
|
|
|
|
-m::
|
|
--module-path::
|
|
The module path (only needed if httpd is Apache).
|
|
(Default: /usr/lib/apache2/modules)
|
|
|
|
-p::
|
|
--port::
|
|
The port number to bind the httpd to. (Default: 1234)
|
|
|
|
-b::
|
|
--browser::
|
|
The web browser that should be used to view the gitweb
|
|
page. This will be passed to the 'git web{litdd}browse' helper
|
|
script along with the URL of the gitweb instance. See
|
|
linkgit:git-web{litdd}browse[1] for more information about this. If
|
|
the script fails, the URL will be printed to stdout.
|
|
|
|
start::
|
|
--start::
|
|
Start the httpd instance and exit. Regenerate configuration files
|
|
as necessary for spawning a new instance.
|
|
|
|
stop::
|
|
--stop::
|
|
Stop the httpd instance and exit. This does not generate
|
|
any of the configuration files for spawning a new instance,
|
|
nor does it close the browser.
|
|
|
|
restart::
|
|
--restart::
|
|
Restart the httpd instance and exit. Regenerate configuration files
|
|
as necessary for spawning a new instance.
|
|
|
|
CONFIGURATION
|
|
-------------
|
|
|
|
You may specify configuration in your .git/config
|
|
|
|
-----------------------------------------------------------------------
|
|
[instaweb]
|
|
local = true
|
|
httpd = apache2 -f
|
|
port = 4321
|
|
browser = konqueror
|
|
modulepath = /usr/lib/apache2/modules
|
|
|
|
-----------------------------------------------------------------------
|
|
|
|
If the configuration variable 'instaweb.browser' is not set,
|
|
'web.browser' will be used instead if it is defined. See
|
|
linkgit:git-web{litdd}browse[1] for more information about this.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|