[netfilter-cvslog] r3408 - trunk/nfsim/core

[jk at netfilter.org]

Author: jk at netfilter.org
Date: 2004-12-16 06:43:26 +0100 (Thu, 16 Dec 2004)
New Revision: 3408

Modified:
   trunk/nfsim/core/core.c
Log:
Add documentation to core arguments


Modified: trunk/nfsim/core/core.c
===================================================================
--- trunk/nfsim/core/core.c	2004-12-16 05:39:38 UTC (rev 3407)
+++ trunk/nfsim/core/core.c	2004-12-16 05:43:26 UTC (rev 3408)
@@ -169,13 +169,43 @@
 
 static const struct option options[] = {
 	{"echo",   0, 0, 'x'},
+/*** XML Argument:
+    <section id="a:echo">
+     <title><option>--echo</option></title>
+     <subtitle>Echo commands as they are executed</subtitle>
+     <para>nfsim will echo each command before it is executed. Useful when
+      commands are read from a file</para>
+    </section>
+*/
 	{"quiet",  0, 0, 'q'},
+/*** XML Argument:
+    <section id="a:quiet">
+     <title><option>--quiet</option></title>
+     <subtitle>Run quietly</subtitle>
+     <para>Causes nfsim to reduce its output to the minimum possible - no prompt
+      is displayed, and most warning messages are suppressed
+     </para>
+    </section>
+*/
 	{"exit",  0, 0, 'e'},
+/*** XML Argument:
+    <section id="a:exit">
+     <title><option>--exit</option></title>
+     <subtitle>Exit on error</subtitle>
+     <para>If <option>--exit</option> is specified, nfsim will exit (with a
+     non-zero error code) on the first script error it encounters (eg an
+     expect command does not match). This is useful when nfsim is invoked as a
+     non-interactive script</para>
+    </section>
+*/
 	{"no-modules",  0, 0, 'N'},
 /*** XML Argument:
     <section id="a:no-modules">
      <title><option>--no-modules</option></title>
      <subtitle>Don't load all available modules on startup</subtitle>
+     <para>Usually all netfilter modules are loaded on startup, this option
+     will suppress this behaviour. To load the modules after this command has
+     been specified, use the <command>isnmod</command> command</para>
     </section>
 */
 	{"version",  0, 0, 'V'},