[Monotone-commits-diffs] net.venge.monotone.contrib.usher: 3c197d3566365d93ba7cde0053fe5e75ef73019a

[code]

revision:            3c197d3566365d93ba7cde0053fe5e75ef73019a
date:                2011-01-23T22:42:38
author:              Richard Levitte <address@hidden>
branch:              net.venge.monotone.contrib.usher
changelog:
Copy all the newest changes from documentation.html.


manifest:
format_version "1"

new_manifest [863d77621e8e907e6f8a4f3aafb52347577d94fc]

old_revision [9baf7f031d31a5fcc8e65ded1b63f88e2214ce94]

patch "doc/usher.conf.man"
 from [8ebd004644b5c138f8cda7afa8729574f23062cf]
   to [95c52dfb45325ced6c2aa6af5f18bfef205465c3]
============================================================
--- doc/usher.conf.man	8ebd004644b5c138f8cda7afa8729574f23062cf
+++ doc/usher.conf.man	95c52dfb45325ced6c2aa6af5f18bfef205465c3
@@ -124,10 +124,12 @@ form, ending with a newline:
 .I arg
 ] ...
 .PP
-After any command except
-.B USERPASS
-the usher will send a reply and close the connection. The reply will
-end with a newline.
+Arguments can be quoted with single or double quotes, and the
+backslash character can be used to quote any other character except
+inside single quotes ("\en" becomes a newline, backslash followed by
+any other character becomes that character). You cannot use literal
+newlines even inside quotes, but must use "\en" if you want a newline
+character.
 .SH "ADMINISTRATIVE COMMANDS"
 .TP
 \fBUSERPASS\fP \fIusername password\fP
@@ -181,7 +183,7 @@ connections to list.  
 the remote end of the connection. Returns "none" if there are no
 connections to list.  
 .TP
-\fBSTOP\fP \fIservername\fP
+\fBSTOP\fP \fIservername\fP [ \fIreason\fP ]
 Prevent the given local server from receiving further
 connections, and stop it once all connections are closed. The result
 will be the new status of that server: \fCACTIVE\fP local servers will become
@@ -194,7 +196,7 @@ states are not affected.
 become \fCACTIVE\fP, and \fCSTOPPED\fP servers become \fCSLEEPING\fP. Servers in other
 states are not affected.
 .TP
-\fBKILL_NOW\fP \fIservername\fP
+\fBKILL_NOW\fP \fIservername\fP [ \fIreason\fP ]
 Immediately kill the given local server, dropping any open
 connections, and prevent it from receiving new connections and
 restarting. The named server will immediately change to state \fCSTOPPED\fP.
@@ -204,7 +206,7 @@ of all servers which are in the given st
 space-separated list of all servers. With an argument, returns a list
 of all servers which are in the given state.
 .TP
-\fBSHUTDOWN\fP
+\fBSHUTDOWN\fP [ \fIreason\fP ]
 Do not accept new connections for any servers, local or
 remote. Returns "\fCok\fP".
 .TP
@@ -219,17 +221,13 @@ reloaded.
 will be "ok", and will not be given until the config file has been
 reloaded.
 .TP
-\fBRUN\fP \fIscriptname\fP \fIarg\fP ...
+\fBSCRIPT\fP \fIscriptname\fP [ \fIarg\fP ... ]
 Run the named script, which was defined with the \fBscript\fP config
 file directive. Arguments given here are appended to the end of the
-command line, after any arguments given in the \fBscript\fP
-directive.  Arguments with spaces can be quoted with single or double
-quotes, and the "\en", "\e'", "\e"", and "\e\e" escape sequences are
-recognized except inside single quotes. You cannot use literal
-newlines even inside quotes, but must use "\en" if you want a newline
-character. Returns the output (combined stdout and stderr) of the
-script, followed by a newline, the exit status and a comment, and
-another newline.
+command line, after any arguments given in the "script" directive.
+Returns the output (combined stdout and stderr) of the script,
+followed by a newline, the exit status and a comment, and another
+newline.
 .TP
 \fBREMOVE_SERVER\fP \fIservername\fP
 Remove the named server, as if by removing it from the config
@@ -242,9 +240,7 @@ arguments to the underlying
 "\fIarg\fP ..." is either "\fIhostname port\fP" for remote servers, or
 arguments to the underlying
 .B monotone
-server for local servers. Quotes are treated the same as for
-.BR RUN .
-Returns "\fCok\fP", or an error message.
+server for local servers. Returns "\fCok\fP", or an error message.
 .SH "SEE ALSO"
 .BR usher (1)
 .SH "AUTHOR"