Documentation/notes: describe content of notes blobs
[gitweb.git] / Documentation / git-instaweb.txt
index 51f1532ef7ce34786ec0dcae32b9e60b710cc9c4..a1f17df0744361ab999314b1834c2e2384af90bd 100644 (file)
@@ -8,38 +8,43 @@ 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 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.
@@ -86,4 +91,4 @@ Documentation by Eric Wong <normalperson@yhbt.net>.
 
 GIT
 ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite