persistent: if a node failed to update_record, trigger a recovery

[sahlberg/ctdb.git] / doc / onnode.1

diff --git a/doc/onnode.1 b/doc/onnode.1
index 44b8aade7c8eb98be5b7f94be26e3808a0713632..055a82e089ce73f45cb3d95ba3e6d6d3bad7d519 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
-.\"    Manual: [FIXME: manual]
-.\"    Source: [FIXME: source]
+.\"      Date: 02/05/2010
+.\"    Manual:  
+.\"    Source:  
 .\"  Language: English
 .\"
-.TH "ONNODE" "1" "09/08/2009" "[FIXME: source]" "[FIXME: manual]"
+.TH "ONNODE" "1" "02/05/2010" "" ""
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -90,6 +90,19 @@ Run COMMAND in parallel on the specified nodes\&. The default is to run COMMAND
 Do not print node addresses\&. Normally, onnode prints informational node addresses if more than one node is specified\&. This overrides \-v\&.
 .RE
 .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
+\-f /dev/null\&.
+.RE
+.PP
+\-f <file>
+.RS 4
+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
 .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\&.
@@ -152,11 +165,28 @@ 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 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
-Contains a list of each node\'s IP address or hostname\&.
+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