git.samba.org / metze / ctdb / wip.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 9b206d9)
Document CTDB_NODES_FILE environment variable used by onnode.
authorMartin Schwenke <martin@meltin.net>
Tue, 6 Oct 2009 02:38:00 +0000 (13:38 +1100)
committerMartin Schwenke <martin@meltin.net>
Tue, 6 Oct 2009 02:38:00 +0000 (13:38 +1100)
Signed-off-by: Martin Schwenke <martin@meltin.net>
doc/onnode.1 patch | blob | history
doc/onnode.1.html patch | blob | history
doc/onnode.1.xml patch | blob | history

diff --git a/doc/onnode.1 b/doc/onnode.1
index 44b8aade7c8eb98be5b7f94be26e3808a0713632..fe86a57fd14fdb4b44cdf5e3ce6172cd139219ce 100644 (file)
--- a/doc/onnode.1
+++ b/doc/onnode.1
@@ -2,12 +2,12 @@
 .\"     Title: onnode
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 09/08/2009
+.\"      Date: 10/06/2009
 .\"    Manual: [FIXME: manual]
 .\"    Source: [FIXME: source]
 .\"  Language: English
 .\"
-.TH "ONNODE" "1" "09/08/2009" "[FIXME: source]" "[FIXME: manual]"
+.TH "ONNODE" "1" "10/06/2009" "[FIXME: source]" "[FIXME: manual]"
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -152,11 +152,18 @@ The following command would run \&./foo in the current working directory, in par
 .if n \{\
 .RE
 .\}
+.SH "ENVIRONMENT"
+.PP
+\fBCTDB_NODES_FILE\fR
+.RS 4
+Name of alternative nodes file to use instead of
+/etc/ctdb/nodes\&.
+.RE
 .SH "FILES"
 .PP
 /etc/ctdb/nodes
 .RS 4
-Contains a list of each node\'s IP address or hostname\&.
+Default file containing a list of each node\'s IP address or hostname\&.
 .RE
 .PP
 /etc/ctdb/onnode\&.conf
diff --git a/doc/onnode.1.html b/doc/onnode.1.html
index c662d7cbe537fdef3f1f0df3f0cb5c50fd0cf33d..c8e3157dffd82cc2196d5ee8112f46a15fad30e1 100644 (file)
--- a/doc/onnode.1.html
+++ b/doc/onnode.1.html
@@ -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.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="id2998330"></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="id2711756"></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="id2998358"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p>
+    </p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="id2711784"></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="id2997827"></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="id2711252"></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>
@@ -51,7 +51,7 @@
             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="id2997920"></a><h2>EXAMPLES</h2><p>
+         </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id2711346"></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
@@ -69,17 +69,21 @@
       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="FILES"><a name="id2997971"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term">/etc/ctdb/nodes</span></dt><dd><p>
-            Contains a list of each node's IP address or hostname.
-         </p></dd><dt><span class="term">/etc/ctdb/onnode.conf</span></dt><dd><p>
+    </pre></div><div class="refsect1" title="ENVIRONMENT"><a name="id2711396"></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="id2711425"></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></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="id2998010"></a><h2>SEE ALSO</h2><p>
+         </p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="id2711471"></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="id2998022"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+    </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id2711483"></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>
diff --git a/doc/onnode.1.xml b/doc/onnode.1.xml
index d3f6bf4498466c8ea240263716e73e80eed0ef92..578baf9e692a15899b6b56fc79c2cf79555bb597 100644 (file)
--- a/doc/onnode.1.xml
+++ b/doc/onnode.1.xml
@@ -194,18 +194,34 @@
     </screen>
   </refsect1>
 
+  <refsect1><title>ENVIRONMENT</title>
+
+    <variablelist>
+      <varlistentry><term><envar>CTDB_NODES_FILE</envar></term>
+        <listitem>
+          <para>
+            Name of alternative nodes file to use instead of
+            <filename>/etc/ctdb/nodes</filename>.
+         </para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+  </refsect1>
+
   <refsect1><title>FILES</title>
 
     <variablelist>
-      <varlistentry><term>/etc/ctdb/nodes</term>
+      <varlistentry><term><filename>/etc/ctdb/nodes</filename></term>
         <listitem>
           <para>
-            Contains a list of each node's IP address or hostname.
+            Default file containing a list of each node's IP address
+            or hostname.
          </para>
         </listitem>
       </varlistentry>
 
-      <varlistentry><term>/etc/ctdb/onnode.conf</term>
+      <varlistentry><term><filename>/etc/ctdb/onnode.conf</filename></term>
         <listitem>
           <para>
             If this file exists it is sourced by onnode.  The main
Work in progress branches