From 2fb2eb0fd7396de33474ce43fe95c66a5784d05b Mon Sep 17 00:00:00 2001 From: Martin Schwenke Date: Fri, 5 Feb 2010 15:30:39 +1100 Subject: [PATCH] onnode documentation - update documentation to reflect recent onnode changes. Signed-off-by: Martin Schwenke --- doc/onnode.1 | 25 ++++++++++++++++++------- doc/onnode.1.html | 39 ++++++++++++++++++++++++++------------- doc/onnode.1.xml | 24 +++++++++++++++++++----- 3 files changed, 63 insertions(+), 25 deletions(-) diff --git a/doc/onnode.1 b/doc/onnode.1 index baf3e62b..055a82e0 100644 --- a/doc/onnode.1 +++ b/doc/onnode.1 @@ -1,13 +1,13 @@ '\" t .\" Title: onnode .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.75.1 -.\" Date: 12/08/2009 +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" 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 .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 diff --git a/doc/onnode.1.html b/doc/onnode.1.html index 90c7e848..f99bdb94 100644 --- a/doc/onnode.1.html +++ b/doc/onnode.1.html @@ -1,4 +1,4 @@ -onnode

Name

onnode — run commands on ctdb nodes

Synopsis

onnode [OPTION] ... NODES COMMAND ...

DESCRIPTION

+onnode

Name

onnode — run commands on ctdb nodes

Synopsis

onnode [OPTION] ... NODES COMMAND ...

DESCRIPTION

onnode is a utility to run commands on a specific node of a CTDB cluster, or on all nodes.

@@ -13,7 +13,7 @@

The COMMAND can be any shell command. The onnode utility uses ssh or rsh to connect to the remote nodes and run the command. -

DESCRIPTIVE NODE SPECIFICATIONS

+

DESCRIPTIVE NODE SPECIFICATIONS

The following descriptive node specification can be used in place of numeric node numbers:

all

@@ -32,7 +32,7 @@ The current NAT gateway.

rm | recmaster

The current recovery master. -

OPTIONS

-c

+

OPTIONS

-c

Execute COMMAND in the current working directory on the specified nodes.

-o <prefix>

@@ -51,16 +51,18 @@ file. You can avoid the nodes file entirely by combining this with -f /dev/null.

-f <file>

- 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.

-v

Print a node addresses even if only one node is specified. Normally, onnode prints informational node addresses when more than one node is specified.

-h, --help

Show a short usage guide. -

EXAMPLES

+

EXAMPLES

The following command would show the process ID of ctdb on all nodes 

       onnode all pidof ctdbd
@@ -78,21 +80,32 @@
       directory, in parallel, on nodes 0, 2, 3 and 4.
     
       onnode -c -p 0,2-4 ./foo
-

ENVIRONMENT

CTDB_NODES_FILE

- Name of alternative nodes file to use instead of - /etc/ctdb/nodes. -

FILES

/etc/ctdb/nodes

+

ENVIRONMENT

CTDB_NODES_FILE

+ 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. +

FILES

/etc/ctdb/nodes

Default file containing a list of each node's IP address or hostname. +

+ Actually, the default is + $CTDB_BASE/nodes, + where $CTDB_BASE defaults to + /etc/ctdb. If a relative path is + given (via the -f option or $CTDB_BASE) and + no corresponding file exists relative to the current + directory then the file is also searched for in the + $CTDB_BASE directory.

/etc/ctdb/onnode.conf

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. -

SEE ALSO

+

SEE ALSO

ctdbd(1), ctdb(1), http://ctdb.samba.org/ -

COPYRIGHT/LICENSE


+

COPYRIGHT/LICENSE


Copyright (C) Andrew Tridgell 2007
Copyright (C) Ronnie sahlberg 2007
Copyright (C) Martin Schwenke 2008
diff --git a/doc/onnode.1.xml b/doc/onnode.1.xml index 17e28010..073f0672 100644 --- a/doc/onnode.1.xml +++ b/doc/onnode.1.xml @@ -158,9 +158,11 @@ -f <file> - 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. @@ -223,8 +225,10 @@ CTDB_NODES_FILE - 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. @@ -241,6 +245,16 @@ Default file containing a list of each node's IP address or hostname. + + Actually, the default is + $CTDB_BASE/nodes, + where $CTDB_BASE defaults to + /etc/ctdb. If a relative path is + given (via the -f option or $CTDB_BASE) and + no corresponding file exists relative to the current + directory then the file is also searched for in the + $CTDB_BASE directory. + -- 2.34.1