mirror of
https://github.com/git/git.git
synced 2024-11-01 23:07:55 +01:00
0b444cdb19
The documentation was quite inconsistent when spelling 'git cmd' if it
only refers to the program, not to some specific invocation syntax:
both 'git-cmd' and 'git cmd' spellings exist.
The current trend goes towards dashless forms, and there is precedent
in 647ac70 (git-svn.txt: stop using dash-form of commands.,
2009-07-07) to actively eliminate the dashed variants.
Replace 'git-cmd' with 'git cmd' throughout, except where git-shell,
git-cvsserver, git-upload-pack, git-receive-pack, and
git-upload-archive are concerned, because those really live in the
$PATH.
94 lines
2.3 KiB
Text
94 lines
2.3 KiB
Text
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 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--browse' helper
|
|
script along with the URL of the gitweb instance. See
|
|
linkgit:git-web--browse[1] for more information about this. If
|
|
the script fails, the URL will be printed to stdout.
|
|
|
|
--start::
|
|
Start the httpd instance and exit. This does not generate
|
|
any of the configuration files for spawning a new instance.
|
|
|
|
--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 the httpd instance and exit. This does not generate
|
|
any of the configuration files 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--browse[1] for more information about this.
|
|
|
|
Author
|
|
------
|
|
Written by Eric Wong <normalperson@yhbt.net>
|
|
|
|
Documentation
|
|
--------------
|
|
Documentation by Eric Wong <normalperson@yhbt.net>.
|
|
|
|
GIT
|
|
---
|
|
Part of the linkgit:git[1] suite
|