0fb7159c00cd initial-docs

docs/cli: add docs for --web
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 05 Jul 2010 23:02:18 -0400
parents 11a7e1d494d2
children d303f56078eb
branches/tags initial-docs
files docs/cli.rst

Changes

--- a/docs/cli.rst	Mon Jul 05 22:55:50 2010 -0400
+++ b/docs/cli.rst	Mon Jul 05 23:02:18 2010 -0400
@@ -157,7 +157,7 @@
 
 Check the review status of a changeset. Usage::
 
-    USAGE: hg review --check [-r REV] [--no-nos] [--yeses NUM] [--seen]
+    hg review --check [-r REV] [--no-nos] [--yeses NUM] [--seen]
 
 Check that the given changeset "passes" the given tests of review status. If no
 tests are given an error is returned.
@@ -191,3 +191,30 @@
 
 ``--web``
 ---------
+
+Start the web interface. Usage::
+
+    hg review --web [--read-only] [--allow-anon] [--address ADDRESS] [--port PORT]
+
+Visit http://localhost:8080/ (replace the port number if you specified
+a different port) in a modern browser of your choice to use the web interface.
+
+Use ``Ctrl+C`` to stop the interface.
+
+Options:
+
+``--read-only``
+    Make the web interface read-only; disallowing comments, signoffs, pushes
+    and pulls (default: ``False``).
+
+``--allow-anon``
+    Allow anonymous comments on the web interface and set the username for
+    comments to an anonymous username (default: ``False`` (i.e. allow comments
+    and use your Mercurial username)).
+
+``--address VALUE``
+    Run the web interface on the specified address (default: ``127.0.0.1``).
+
+``--port VALUE``
+    Run the web interface on the specified port (default: ``8080``).
+