Browse Source

[master] work on bind10 manual

Alphabetize some options.

Add space after option character and replaceable value (to be consistent).

Add --brittle (this was only added to .8 file and not xml before).

Add --cmdctl-port.

Add --pid-file.

Clean up synopsis.

Regenerate roff file.
Jeremy C. Reed 14 years ago
parent
commit
f19053d908
2 changed files with 89 additions and 19 deletions
  1. 38 11
      src/bin/bind10/bind10.8
  2. 51 8
      src/bin/bind10/bind10.xml

File diff suppressed because it is too large
+ 38 - 11
src/bin/bind10/bind10.8


+ 51 - 8
src/bin/bind10/bind10.xml

@@ -20,7 +20,7 @@
 <refentry>
 <refentry>
 
 
   <refentryinfo>
   <refentryinfo>
-    <date>February 22, 2011</date>
+    <date>March 31, 2011</date>
   </refentryinfo>
   </refentryinfo>
 
 
   <refmeta>
   <refmeta>
@@ -44,16 +44,21 @@
   <refsynopsisdiv>
   <refsynopsisdiv>
     <cmdsynopsis>
     <cmdsynopsis>
       <command>bind10</command>
       <command>bind10</command>
+      <arg><option>-c <replaceable>config-filename</replaceable></option></arg>
       <arg><option>-m <replaceable>file</replaceable></option></arg>
       <arg><option>-m <replaceable>file</replaceable></option></arg>
       <arg><option>-n</option></arg>
       <arg><option>-n</option></arg>
+      <arg><option>-p <replaceable>data_path</replaceable></option></arg>
       <arg><option>-u <replaceable>user</replaceable></option></arg>
       <arg><option>-u <replaceable>user</replaceable></option></arg>
       <arg><option>-v</option></arg>
       <arg><option>-v</option></arg>
-      <arg><option>-c<replaceable>config-filename</replaceable></option></arg>
-      <arg><option>-p<replaceable>data_path</replaceable></option></arg>
+      <arg><option>--brittle</option></arg>
+      <arg><option>--cmdctl-port</option> <replaceable>port</replaceable></arg>
+      <arg><option>--config-file</option> <replaceable>config-filename</replaceable></arg>
+      <arg><option>--data-path</option> <replaceable>directory</replaceable></arg>
       <arg><option>--msgq-socket-file <replaceable>file</replaceable></option></arg>
       <arg><option>--msgq-socket-file <replaceable>file</replaceable></option></arg>
       <arg><option>--no-cache</option></arg>
       <arg><option>--no-cache</option></arg>
-      <arg><option>--user <replaceable>user</replaceable></option></arg>
+      <arg><option>--pid-file</option> <replaceable>filename</replaceable></arg>
       <arg><option>--pretty-name <replaceable>name</replaceable></option></arg>
       <arg><option>--pretty-name <replaceable>name</replaceable></option></arg>
+      <arg><option>--user <replaceable>user</replaceable></option></arg>
       <arg><option>--verbose</option></arg>
       <arg><option>--verbose</option></arg>
     </cmdsynopsis>
     </cmdsynopsis>
   </refsynopsisdiv>
   </refsynopsisdiv>
@@ -82,9 +87,24 @@
     <para>The arguments are as follows:</para>
     <para>The arguments are as follows:</para>
 
 
     <variablelist>
     <variablelist>
+
+      <varlistentry>
+        <term>
+          <option>--brittle</option>
+        </term>
+        <listitem>
+          <para>
+	    Shutdown if any of the child processes of
+	    <command>bind10</command> exit.  This is intended to
+	    help developers debug the server, and should not be
+	    used in production.
+          </para>
+        </listitem>
+      </varlistentry>
+
       <varlistentry>
       <varlistentry>
         <term>
         <term>
-          <option>-c</option><replaceable>config-filename</replaceable>,
+          <option>-c</option> <replaceable>config-filename</replaceable>,
           <option>--config-file</option> <replaceable>config-filename</replaceable>
           <option>--config-file</option> <replaceable>config-filename</replaceable>
         </term>
         </term>
         <listitem>
         <listitem>
@@ -97,8 +117,22 @@
 
 
       <varlistentry>
       <varlistentry>
         <term>
         <term>
-          <option>-p</option><replaceable>data-path</replaceable>,
-          <option>--data-path</option> <replaceable>data-path</replaceable>
+          <option>--cmdctl-port</option> <replaceable>port</replaceable>
+        </term>
+        <listitem>
+	  <para>The <command>b10-cmdctl</command> daemon will listen
+	    on this port.
+	    (See
+	    <refentrytitle>b10-cmdctl</refentrytitle><manvolnum>8</manvolnum>
+            for the default.)
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <option>-p</option> <replaceable>directory</replaceable>,
+          <option>--data-path</option> <replaceable>directory</replaceable>
         </term>
         </term>
         <listitem>
         <listitem>
           <para>The path where BIND 10 programs look for various data files.
           <para>The path where BIND 10 programs look for various data files.
@@ -134,7 +168,6 @@
 
 
       <varlistentry>
       <varlistentry>
         <term><option>-u</option> <replaceable>user</replaceable>, <option>--user</option> <replaceable>name</replaceable></term>
         <term><option>-u</option> <replaceable>user</replaceable>, <option>--user</option> <replaceable>name</replaceable></term>
-
         <listitem>
         <listitem>
           <para>The username for <command>bind10</command> to run as.
           <para>The username for <command>bind10</command> to run as.
 <!-- TODO: example more detail. -->
 <!-- TODO: example more detail. -->
@@ -145,6 +178,16 @@
       </varlistentry>
       </varlistentry>
 
 
       <varlistentry>
       <varlistentry>
+        <term><option>--pid-file</option> <replaceable>filename</replaceable></term>
+        <listitem>
+          <para>If defined, the PID of the <command>bind10</command> is stored
+             in this file.
+             This is used for testing purposes.
+          </para>
+         </listitem>
+      </varlistentry>
+
+      <varlistentry>
         <term><option>--pretty-name <replaceable>name</replaceable></option></term>
         <term><option>--pretty-name <replaceable>name</replaceable></option></term>
 
 
         <listitem>
         <listitem>