Add the 'fetch.recurseSubmodules' config setting
[gitweb.git] / Documentation / git-instaweb.txt
index 11e6a817792d6cf7e194bb10573c6288daa2af66..e70cea932063b04f3ab3c78b882f4981514d663e 100644 (file)
@@ -8,51 +8,59 @@ git-instaweb - Instantly browse your working repository in gitweb
 SYNOPSIS
 --------
 [verse]
-'git-instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
+'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
                [--browser=<browser>]
-'git-instaweb' [--start] [--stop] [--restart]
+'git instaweb' [--start] [--stop] [--restart]
 
 DESCRIPTION
 -----------
-A simple script to setup gitweb and a web server for browsing the local
+A simple script to set up `gitweb` and a web server for browsing the local
 repository.
 
 OPTIONS
 -------
 
--l|--local::
+-l::
+--local::
        Only bind the web server to the local IP (127.0.0.1).
 
--d|--httpd::
+-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 lighttpd, apache2 and webrick are supported.
+       Currently apache2, lighttpd, mongoose, plackup and webrick are supported.
        (Default: lighttpd)
 
--m|--module-path::
+-m::
+--module-path::
        The module path (only needed if httpd is Apache).
        (Default: /usr/lib/apache2/modules)
 
--p|--port::
+-p::
+--port::
        The port number to bind the httpd to.  (Default: 1234)
 
--b|--browser::
+-b::
+--browser::
        The web browser that should be used to view the gitweb
-       page. This will be passed to the 'git-web--browse' helper
+       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::
        Start the httpd instance and exit.  This does not generate
        any of the configuration files 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.  This does not generate
        any of the configuration files for spawning a new instance.