summaryrefslogtreecommitdiff
path: root/ctdb/doc
diff options
context:
space:
mode:
authorMartin Schwenke <martin@meltin.net>2012-07-17 16:52:04 +1000
committerAmitay Isaacs <amitay@gmail.com>2012-07-30 15:34:41 +1000
commit89d935de6d6d6a97f9d219e50dc7517df7c28a04 (patch)
tree70a47b8413426405e0ac6c2ef0c2d140137c6bcd /ctdb/doc
parentf53b4f82f51ba89b04dfae26c6c9bd11a8e19495 (diff)
downloadsamba-89d935de6d6d6a97f9d219e50dc7517df7c28a04.tar.gz
doc: Document the new onnode -P option
Signed-off-by: Martin Schwenke <martin@meltin.net> (This used to be ctdb commit fa0f3cba5adaa38bed37dd8b121ad53e962a010d)
Diffstat (limited to 'ctdb/doc')
-rw-r--r--ctdb/doc/onnode.126
-rw-r--r--ctdb/doc/onnode.1.html20
-rw-r--r--ctdb/doc/onnode.1.xml10
3 files changed, 42 insertions, 14 deletions
diff --git a/ctdb/doc/onnode.1 b/ctdb/doc/onnode.1
index 055a82e089c..28ad0d06973 100644
--- a/ctdb/doc/onnode.1
+++ b/ctdb/doc/onnode.1
@@ -1,13 +1,22 @@
'\" t
.\" Title: onnode
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\" Date: 02/05/2010
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 07/17/2012
.\" Manual:
.\" Source:
.\" Language: English
.\"
-.TH "ONNODE" "1" "02/05/2010" "" ""
+.TH "ONNODE" "1" "07/17/2012" "" ""
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@@ -92,7 +101,7 @@ Do not print node addresses\&. Normally, onnode prints informational node addres
.PP
\-n
.RS 4
-Allow nodes to be specified by name rather than node numbers\&. These nodes don\'t need to be listed in the nodes file\&. You can avoid the nodes file entirely by combining this with
+Allow nodes to be specified by name rather than node numbers\&. These nodes don\*(Aqt need to be listed in the nodes file\&. You can avoid the nodes file entirely by combining this with
\-f /dev/null\&.
.RE
.PP
@@ -108,6 +117,11 @@ in the FILES section for more details\&.
Print a node addresses even if only one node is specified\&. Normally, onnode prints informational node addresses when more than one node is specified\&.
.RE
.PP
+\-P
+.RS 4
+Push files to nodes\&. Names of files to push are specified rather than the usual command\&. Quoting is fragile/broken \- filenames with whitespace in them are not supported\&.
+.RE
+.PP
\-h, \-\-help
.RS 4
Show a short usage guide\&.
@@ -127,7 +141,7 @@ The following command would show the process ID of ctdb on all nodes
.RE
.\}
.PP
-The following command would show the last 5 lines of log on each node, preceded by the node\'s hostname
+The following command would show the last 5 lines of log on each node, preceded by the node\*(Aqs hostname
.sp
.if n \{\
.RS 4
@@ -177,7 +191,7 @@ in the FILES section for more details\&.
.PP
/etc/ctdb/nodes
.RS 4
-Default file containing a list of each node\'s IP address or hostname\&.
+Default file containing a list of each node\*(Aqs IP address or hostname\&.
.sp
Actually, the default is
$\fBCTDB_BASE\fR/nodes, where
diff --git a/ctdb/doc/onnode.1.html b/ctdb/doc/onnode.1.html
index f99bdb94e83..399941a98c9 100644
--- a/ctdb/doc/onnode.1.html
+++ b/ctdb/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="id2602518"></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.76.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="idp234704"></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="id2602547"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p>
+ </p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="idp236384"></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="id2600718"></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="idp253704"></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>
@@ -60,9 +60,13 @@
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">-P</span></dt><dd><p>
+ Push files to nodes. Names of files to push are specified
+ rather than the usual command. Quoting is fragile/broken
+ - filenames with whitespace in them are not supported.
</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="id2600855"></a><h2>EXAMPLES</h2><p>
+ </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="idp262848"></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
@@ -80,12 +84,12 @@
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="id2600905"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">CTDB_NODES_FILE</code></span></dt><dd><p>
+ </pre></div><div class="refsect1" title="ENVIRONMENT"><a name="idp265888"></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>
+ </p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="idp124208"></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>
@@ -103,9 +107,9 @@
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="id2652258"></a><h2>SEE ALSO</h2><p>
+ </p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="idp129264"></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="id2652271"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+ </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="idp130040"></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/ctdb/doc/onnode.1.xml b/ctdb/doc/onnode.1.xml
index 073f0672c4f..1b97c2f2964 100644
--- a/ctdb/doc/onnode.1.xml
+++ b/ctdb/doc/onnode.1.xml
@@ -177,6 +177,16 @@
</listitem>
</varlistentry>
+ <varlistentry><term>-P</term>
+ <listitem>
+ <para>
+ Push files to nodes. Names of files to push are specified
+ rather than the usual command. Quoting is fragile/broken
+ - filenames with whitespace in them are not supported.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry><term>-h, --help</term>
<listitem>
<para>
View Lorry Controller Status