diff options
Diffstat (limited to 'ctdb/doc')
| -rw-r--r-- | ctdb/doc/onnode.1 | 105 | ||||
| -rw-r--r-- | ctdb/doc/onnode.1.html | 17 | ||||
| -rw-r--r-- | ctdb/doc/onnode.1.xml | 8 |
3 files changed, 43 insertions, 87 deletions
diff --git a/ctdb/doc/onnode.1 b/ctdb/doc/onnode.1 index 44b8aade7c8..99abd80f13b 100644 --- a/ctdb/doc/onnode.1 +++ b/ctdb/doc/onnode.1 @@ -1,177 +1,146 @@ -'\" 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: 09/08/2009 -.\" Manual: [FIXME: manual] -.\" Source: [FIXME: source] -.\" Language: English +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/> +.\" Date: 05/12/2009 +.\" Manual: +.\" Source: .\" -.TH "ONNODE" "1" "09/08/2009" "[FIXME: source]" "[FIXME: manual]" -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- +.TH "ONNODE" "1" "05/12/2009" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- .SH "NAME" -onnode \- run commands on ctdb nodes +onnode - run commands on ctdb nodes .SH "SYNOPSIS" -.HP \w'\fBonnode\ [OPTION]\ \&.\&.\&.\ NODES\ COMMAND\ \&.\&.\&.\fR\ 'u -\fBonnode [OPTION] \&.\&.\&. NODES COMMAND \&.\&.\&.\fR +.HP 38 +\fBonnode [OPTION] \.\.\. NODES COMMAND \.\.\.\fR .SH "DESCRIPTION" .PP -onnode is a utility to run commands on a specific node of a CTDB cluster, or on all nodes\&. +onnode is a utility to run commands on a specific node of a CTDB cluster, or on all nodes\. .PP -The NODES option specifies which node to run a command on\&. You can specify a numeric node number (from 0 to N\-1) or a descriptive node specification (see DESCRIPTIVE NODE SPECIFICATIONS below)\&. You can also specify lists of nodes, separated by commas, and ranges of numeric node numbers, separated by dashes\&. If nodes are specified multiple times then the command will be executed multiple times on those nodes\&. The order of nodes is significant\&. +The NODES option specifies which node to run a command on\. You can specify a numeric node number (from 0 to N\-1) or a descriptive node specification (see DESCRIPTIVE NODE SPECIFICATIONS below)\. You can also specify lists of nodes, separated by commas, and ranges of numeric node numbers, separated by dashes\. If nodes are specified multiple times then the command will be executed multiple times on those nodes\. The order of nodes is significant\. .PP -The COMMAND can be any shell command\&. The onnode utility uses ssh or rsh to connect to the remote nodes and run the command\&. +The COMMAND can be any shell command\. The onnode utility uses ssh or rsh to connect to the remote nodes and run the command\. .SH "DESCRIPTIVE NODE SPECIFICATIONS" .PP The following descriptive node specification can be used in place of numeric node numbers: .PP all .RS 4 -All nodes\&. -.RE -.PP -any -.RS 4 -A node where ctdbd is running\&. This semi\-random but there is a bias towards choosing a low numbered node\&. +All nodes\. .RE .PP ok | healthy .RS 4 -All nodes that are not disconnected, banned, disabled or unhealthy\&. +All nodes that are not disconnected, banned, disabled or unhealthy\. .RE .PP con | connected .RS 4 -All nodes that are not disconnected\&. +All nodes that are not disconnected\. .RE .PP lvs | lvsmaster .RS 4 -The current LVS master\&. +The current LVS master\. .RE .PP natgw | natgwlist .RS 4 -The current NAT gateway\&. +The current NAT gateway\. .RE .PP rm | recmaster .RS 4 -The current recovery master\&. +The current recovery master\. .RE .SH "OPTIONS" .PP \-c .RS 4 -Execute COMMAND in the current working directory on the specified nodes\&. +Execute COMMAND in the current working directory on the specified nodes\. .RE .PP \-o <prefix> .RS 4 -Causes standard output from each node to be saved into a file with name <prefix>\&.<ip>\&. +Causes standard output from each node to be saved into a file with name <prefix>\.<ip>\. .RE .PP \-p .RS 4 -Run COMMAND in parallel on the specified nodes\&. The default is to run COMMAND sequentially on each node\&. +Run COMMAND in parallel on the specified nodes\. The default is to run COMMAND sequentially on each node\. .RE .PP \-q .RS 4 -Do not print node addresses\&. Normally, onnode prints informational node addresses if more than one node is specified\&. This overrides \-v\&. +Do not print node addresses\. Normally, onnode prints informational node addresses if more than one node is specified\. This overrides \-v\. .RE .PP \-v .RS 4 -Print a node addresses even if only one node is specified\&. Normally, onnode prints informational node addresses when more than one node is specified\&. +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 \-h, \-\-help .RS 4 -Show a short usage guide\&. +Show a short usage guide\. .RE .SH "EXAMPLES" .PP The following command would show the process ID of ctdb on all nodes .sp -.if n \{\ .RS 4 -.\} .nf onnode all pidof ctdbd .fi -.if n \{\ .RE -.\} .PP The following command would show the last 5 lines of log on each node, preceded by the node\'s hostname .sp -.if n \{\ .RS 4 -.\} .nf - onnode all "hostname; tail \-5 /var/log/log\&.ctdb" + onnode all "hostname; tail \-5 /var/log/log\.ctdb" .fi -.if n \{\ .RE -.\} .PP -The following command would restart the ctdb service on all nodes\&. +The following command would restart the ctdb service on all nodes\. .sp -.if n \{\ .RS 4 -.\} .nf onnode all service ctdb restart .fi -.if n \{\ .RE -.\} .PP -The following command would run \&./foo in the current working directory, in parallel, on nodes 0, 2, 3 and 4\&. +The following command would run \./foo in the current working directory, in parallel, on nodes 0, 2, 3 and 4\. .sp -.if n \{\ .RS 4 -.\} .nf - onnode \-c \-p 0,2\-4 \&./foo + onnode \-c \-p 0,2\-4 \./foo .fi -.if n \{\ .RE -.\} .SH "FILES" .PP /etc/ctdb/nodes .RS 4 -Contains a list of each node\'s IP address or hostname\&. +Contains a list of each node\'s IP address or hostname\. .RE .PP -/etc/ctdb/onnode\&.conf +/etc/ctdb/onnode\.conf .RS 4 -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\&. +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\. .RE .SH "SEE ALSO" .PP ctdbd(1), ctdb(1), -\m[blue]\fB\%http://ctdb.samba.org/\fR\m[] +\fI\%http://ctdb.samba.org/\fR .SH "COPYRIGHT/LICENSE" .sp -.if n \{\ .RS 4 -.\} .nf Copyright (C) Andrew Tridgell 2007 Copyright (C) Ronnie sahlberg 2007 @@ -180,16 +149,14 @@ Copyright (C) Martin Schwenke 2008 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at -your option) any later version\&. +your option) any later version\. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU -General Public License for more details\&. +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\. See the GNU +General Public License for more details\. You should have received a copy of the GNU General Public License -along with this program; if not, see http://www\&.gnu\&.org/licenses/\&. +along with this program; if not, see http://www\.gnu\.org/licenses/\. .fi -.if n \{\ .RE -.\} diff --git a/ctdb/doc/onnode.1.html b/ctdb/doc/onnode.1.html index c662d7cbe53..03d40557ce5 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 — 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.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="onnode.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>onnode — run commands on ctdb nodes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">onnode [OPTION] ... NODES COMMAND ...</code> </p></div></div><div class="refsect1" lang="en"><a name="id2477311"></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,14 +13,11 @@ </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" lang="en"><a name="id2478322"></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> All nodes. - </p></dd><dt><span class="term">any</span></dt><dd><p> - A node where ctdbd is running. This semi-random but - there is a bias towards choosing a low numbered node. </p></dd><dt><span class="term">ok | healthy</span></dt><dd><p> All nodes that are not disconnected, banned, disabled or unhealthy. @@ -32,7 +29,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" lang="en"><a name="id2479544"></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 <prefix></span></dt><dd><p> @@ -51,7 +48,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" lang="en"><a name="id2479637"></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,7 +66,7 @@ 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> + </pre></div><div class="refsect1" lang="en"><a name="id2479688"></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> If this file exists it is sourced by onnode. The main @@ -77,9 +74,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="id2998010"></a><h2>SEE ALSO</h2><p> + </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2479727"></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" lang="en"><a name="id2479739"></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 d3f6bf44984..8710d36b2ea 100644 --- a/ctdb/doc/onnode.1.xml +++ b/ctdb/doc/onnode.1.xml @@ -55,14 +55,6 @@ </para> </listitem> </varlistentry> - <varlistentry><term>any</term> - <listitem> - <para> - A node where ctdbd is running. This semi-random but - there is a bias towards choosing a low numbered node. - </para> - </listitem> - </varlistentry> <varlistentry><term>ok | healthy</term> <listitem> <para> |