onnode documentation - update documentation to reflect recent onnode changes.
authorMartin Schwenke <martin@meltin.net>
Fri, 5 Feb 2010 04:30:39 +0000 (15:30 +1100)
committerMartin Schwenke <martin@meltin.net>
Fri, 5 Feb 2010 04:30:39 +0000 (15:30 +1100)
Signed-off-by: Martin Schwenke <martin@meltin.net>
doc/onnode.1
doc/onnode.1.html
doc/onnode.1.xml

index baf3e62bed4c1299d6af4d062c69f8677820c714..055a82e089ce73f45cb3d95ba3e6d6d3bad7d519 100644 (file)
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: onnode
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\"      Date: 12/08/2009
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 02/05/2010
 .\"    Manual:  
 .\"    Source:  
 .\"  Language: English
 .\"
-.TH "ONNODE" "1" "12/08/2009" "" ""
+.TH "ONNODE" "1" "02/05/2010" "" ""
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -98,8 +98,9 @@ Allow nodes to be specified by name rather than node numbers\&. These nodes don\
 .PP
 \-f <file>
 .RS 4
-Specify an alternative nodes file to use instead of
-/etc/ctdb/nodes\&. This overrides the CTDB_NODES_FILE environment variable\&.
+Specify an alternative nodes file to use instead of the default\&. This option overrides the CTDB_NODES_FILE environment variable\&. See the discussion of
+/etc/ctdb/nodes
+in the FILES section for more details\&.
 .RE
 .PP
 \-v
@@ -168,14 +169,24 @@ The following command would run \&./foo in the current working directory, in par
 .PP
 \fBCTDB_NODES_FILE\fR
 .RS 4
-Name of alternative nodes file to use instead of
-/etc/ctdb/nodes\&.
+Name of alternative nodes file to use instead of the default\&. See the discussion of
+/etc/ctdb/nodes
+in the FILES section for more details\&.
 .RE
 .SH "FILES"
 .PP
 /etc/ctdb/nodes
 .RS 4
 Default file containing a list of each node\'s IP address or hostname\&.
+.sp
+Actually, the default is
+$\fBCTDB_BASE\fR/nodes, where
+\fB$CTDB_BASE\fR
+defaults to
+/etc/ctdb\&. If a relative path is given (via the \-f option or
+\fB$CTDB_BASE\fR) and no corresponding file exists relative to the current directory then the file is also searched for in the
+$\fBCTDB_BASE\fR
+directory\&.
 .RE
 .PP
 /etc/ctdb/onnode\&.conf
index 90c7e8482f629715a557c3a4f72852f4afbd3bf2..f99bdb94e8398f268a3096d33e7bb7c9b8956f07 100644 (file)
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>onnode</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="onnode"><a name="onnode.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>onnode &#8212; run commands on ctdb nodes</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">onnode [OPTION] ... NODES COMMAND ...</code> </p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id268574"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>onnode</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="onnode"><a name="onnode.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>onnode &#8212; run commands on ctdb nodes</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">onnode [OPTION] ... NODES COMMAND ...</code> </p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2602518"></a><h2>DESCRIPTION</h2><p>
       onnode is a utility to run commands on a specific node of a CTDB
       cluster, or on all nodes.
     </p><p>
@@ -13,7 +13,7 @@
     </p><p>
       The COMMAND can be any shell command. The onnode utility uses
       ssh or rsh to connect to the remote nodes and run the command.
-    </p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="id268596"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p>
+    </p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="id2602547"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p>
       The following descriptive node specification can be used in
       place of numeric node numbers:
     </p><div class="variablelist"><dl><dt><span class="term">all</span></dt><dd><p>
@@ -32,7 +32,7 @@
             The current NAT gateway.
          </p></dd><dt><span class="term">rm | recmaster</span></dt><dd><p>
             The current recovery master.
-         </p></dd></dl></div></div><div class="refsect1" title="OPTIONS"><a name="id310004"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-c</span></dt><dd><p>
+         </p></dd></dl></div></div><div class="refsect1" title="OPTIONS"><a name="id2600718"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-c</span></dt><dd><p>
             Execute COMMAND in the current working directory on the
             specified nodes.
          </p></dd><dt><span class="term">-o &lt;prefix&gt;</span></dt><dd><p>
             file.  You can avoid the nodes file entirely by combining
             this with <code class="code">-f /dev/null</code>.
          </p></dd><dt><span class="term">-f &lt;file&gt;</span></dt><dd><p>
-            Specify an alternative nodes file to use instead of
-            <code class="filename">/etc/ctdb/nodes</code>.  This overrides the
-            CTDB_NODES_FILE environment variable.
+            Specify an alternative nodes file to use instead of the
+            default.  This option overrides the CTDB_NODES_FILE
+            environment variable.  See the discussion of
+            <code class="filename">/etc/ctdb/nodes</code> in the FILES section
+            for more details.
          </p></dd><dt><span class="term">-v</span></dt><dd><p>
             Print a node addresses even if only one node is specified.
             Normally, onnode prints informational node addresses when
             more than one node is specified.
          </p></dd><dt><span class="term">-h, --help</span></dt><dd><p>
             Show a short usage guide.
-         </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id310128"></a><h2>EXAMPLES</h2><p>
+         </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id2600855"></a><h2>EXAMPLES</h2><p>
       The following command would show the process ID of ctdb on all nodes
     </p><pre class="screen">
       onnode all pidof ctdbd
       directory, in parallel, on nodes 0, 2, 3 and 4.
     </p><pre class="screen">
       onnode -c -p 0,2-4 ./foo
-    </pre></div><div class="refsect1" title="ENVIRONMENT"><a name="id310172"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">CTDB_NODES_FILE</code></span></dt><dd><p>
-            Name of alternative nodes file to use instead of
-            <code class="filename">/etc/ctdb/nodes</code>.
-         </p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="id310200"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/ctdb/nodes</code></span></dt><dd><p>
+    </pre></div><div class="refsect1" title="ENVIRONMENT"><a name="id2600905"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">CTDB_NODES_FILE</code></span></dt><dd><p>
+           Name of alternative nodes file to use instead of the
+            default.  See the discussion of
+            <code class="filename">/etc/ctdb/nodes</code> in the FILES section
+            for more details.
+         </p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="id2652169"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/ctdb/nodes</code></span></dt><dd><p>
             Default file containing a list of each node's IP address
             or hostname.
+         </p><p>
+           Actually, the default is
+            <code class="filename">$<code class="envar">CTDB_BASE</code>/nodes</code>,
+            where <code class="envar">$CTDB_BASE</code> defaults to
+            <code class="filename">/etc/ctdb</code>.  If a relative path is
+            given (via the -f option or <code class="envar">$CTDB_BASE</code>) and
+            no corresponding file exists relative to the current
+            directory then the file is also searched for in the
+            <code class="filename">$<code class="envar">CTDB_BASE</code></code> directory.
          </p></dd><dt><span class="term"><code class="filename">/etc/ctdb/onnode.conf</code></span></dt><dd><p>
             If this file exists it is sourced by onnode.  The main
             purpose is to allow the administrator to set $SSH to
             something other than "ssh".  In this case the -t option is
             ignored.  For example, the administrator may choose to use
             use rsh instead of ssh.
-         </p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="id310243"></a><h2>SEE ALSO</h2><p>
+         </p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="id2652258"></a><h2>SEE ALSO</h2><p>
       ctdbd(1), ctdb(1), <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
-    </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id310256"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+    </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id2652271"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
 Copyright (C) Andrew Tridgell 2007<br>
 Copyright (C) Ronnie sahlberg 2007<br>
 Copyright (C) Martin Schwenke 2008<br>
index 17e2801087bde6e4e37bb53aaa9d219a5e5996ec..073f0672c4f6f5e23277b8415a1de6578ef3a7a0 100644 (file)
       <varlistentry><term>-f &lt;file&gt;</term>
         <listitem>
           <para>
-            Specify an alternative nodes file to use instead of
-            <filename>/etc/ctdb/nodes</filename>.  This overrides the
-            CTDB_NODES_FILE environment variable.
+            Specify an alternative nodes file to use instead of the
+            default.  This option overrides the CTDB_NODES_FILE
+            environment variable.  See the discussion of
+            <filename>/etc/ctdb/nodes</filename> in the FILES section
+            for more details.
          </para>
         </listitem>
       </varlistentry>
       <varlistentry><term><envar>CTDB_NODES_FILE</envar></term>
         <listitem>
           <para>
-            Name of alternative nodes file to use instead of
-            <filename>/etc/ctdb/nodes</filename>.
+           Name of alternative nodes file to use instead of the
+            default.  See the discussion of
+            <filename>/etc/ctdb/nodes</filename> in the FILES section
+            for more details.
          </para>
         </listitem>
       </varlistentry>
             Default file containing a list of each node's IP address
             or hostname.
          </para>
+         <para>
+           Actually, the default is
+            <filename>$<envar>CTDB_BASE</envar>/nodes</filename>,
+            where <envar>$CTDB_BASE</envar> defaults to
+            <filename>/etc/ctdb</filename>.  If a relative path is
+            given (via the -f option or <envar>$CTDB_BASE</envar>) and
+            no corresponding file exists relative to the current
+            directory then the file is also searched for in the
+            <filename>$<envar>CTDB_BASE</envar></filename> directory.
+         </para>
         </listitem>
       </varlistentry>