[Nym3-commit] r441 - trunk/doc

[jr at conuropsis.org]

Author: jr
Date: 2005-12-10 23:53:58 +0100 (Sat, 10 Dec 2005)
New Revision: 441

Modified:
   trunk/doc/nymbarond.xml
Log:
- adapt nymbarond man page to the new argument format [doc] 


Modified: trunk/doc/nymbarond.xml
===================================================================
--- trunk/doc/nymbarond.xml	2005-12-10 22:36:17 UTC (rev 440)
+++ trunk/doc/nymbarond.xml	2005-12-10 22:53:58 UTC (rev 441)
@@ -16,8 +16,10 @@
 <cmdsynopsis>
   <command>nymbarond</command>    
     <group>
-    <arg choice='plain'>-m</arg>
-    <arg choice='plain'>-d</arg>
+    <arg choice='plain'>help</arg>
+    <arg choice='plain'>deliver</arg>
+    <arg choice='plain'>process</arg>
+    <arg choice='plain'>clean-surbs</arg>
     </group>
     <sbr/>
 </cmdsynopsis>
@@ -45,11 +47,22 @@
 
 <refsect1 id='bounds'><title>COMMANDS</title>
 <variablelist>
+    
 <varlistentry>
-    <term><option>-d account</option></term>
+    <term><option>help</option></term>
     <listitem>
     <para>
-    Accept an incoming email for delivery to the specified account.
+    Display a usage string describing commands available to the nymserver.
+    </para>
+    </listitem>
+</varlistentry>
+
+<varlistentry>
+    <term><option>deliver</option></term>
+    <listitem>
+    <para>
+    Accept an incoming email for delivery to the account specified by the
+    appropriate option.
     Return non-zero on failure, possibly indicating an inexistant
     account or exceeded quota. The account name will most probably be
     the localpart of the recipient email address; e.g. account name is
@@ -64,13 +77,24 @@
 </varlistentry>
 
 <varlistentry>
-    <term><option>-m</option></term>
+    <term><option>process</option></term>
     <listitem>
     <para>
-    Accept a control message from <emphasis>stdin</emphasis>.
+    Accept a control message from <emphasis>stdin</emphasis> or a file if the
+    appropriate option is used.
     </para>
     </listitem>
 </varlistentry>
+
+<varlistentry>
+    <term><option>clean-surbs</option></term>
+    <listitem>
+    <para>
+    Remove from the surbfiles of the nym accounts useless surbs,
+    either because they were already used or because they are out of date.
+    </para>
+    </listitem>
+</varlistentry>
 </variablelist>
 </refsect1>
 
@@ -111,7 +135,7 @@
     used for the host. Configure your MTA to deliver emails for this
     domain to:
 </para>
-    <synopsis>nymbarond -d account
+    <synopsis>nymbarond deliver -n account
     </synopsis>
 <para>
     as user nymbaron. If you're not familiar with your MTA, you will
@@ -129,7 +153,7 @@
     nymserver user email address directly. Make sure emails sent to
     this address are piped through the command
 </para>
-    <synopsis>nymbarond -m
+    <synopsis>nymbarond process
     </synopsis>
 <para>
     which will have to run as the chosen nymserver