Update of /cvsroot/ssic-linux/openssi/openssi-tools/man
In directory sc8-pr-cvs1:/tmp/cvs-serv31822
Added Files:
onall.1 onclass.1 onnode.1 onsvc.1
Log Message:
Manpages for onnode, onall, onclass and onsvc.
--- NEW FILE: onall.1 ---
.TH ONALL 1 "14 November" "" "OpenSSI Cluster Prog Manual"
.SH NAME
onall \- executes a command on all nodes in an OpenSSI Cluster
.SH SYNOPSIS
.nf
.B onall \fR[\fB\-#bql\fR] [\fB\-x \fInode \fR[, \fInode \fR[\fI...\fR]]]
\fIcommand args . . .\fR [\fI%n\fR]
.SH DESCRIPTION
Use \fBonall\fR to execute \fIcommand\fR on each node currently operating
in a cluster. \fIcommand\fR must be an executable binary or shell
script. If \fIcommand\fR is not specified as a fully qualified
pathname, directories in the \fB$PATH\fR environment variable are
searched.
.PP
The \fB\-l\fR option executes the command as a localview process. In other
words, the process' view of /proc will be restricted to those processes
executing on the same node as command.
.PP
If successful, \fBonall\fR returns a value of zero. Any non-zero return
value indicates a failure.
.SH ARGUMENTS
.TP
.B \-#
Prints command lines instead of executing \fIcommand\fR.
.TP
.B \-b
Executes each instance of the specified command or application in the
background. Execution order is not guaranteed. Also, does not print the
node number [see the \fB\-q\fR option].
.TP
.B \-q
Does not print the node number before running \fIcommand\fR.
.TP
.B \-l
Executes the \fIcommand\fR as a localview process.
.TP
.B \-x
Runs \fIcommand\fR on all nodes except those specifically excluded by
this option. The nodes to be excluded should be specified as a
comma-separated list.
.TP
.I command
The command to execute.
.TP
.I args
Specifies the argument or arguments to \fIcommand\fR.
.TP
.I %n
Replaces each occurence of \fI%n\fR with the number of the node on
which \fIcommand\fR runs.
.SH NOTE
Double percent characters (%%) are replaced with a single percent character.
.SH EXAMPLES
To display information about all processors in each node of a cluster:
.RS
\fBonall\fR cat /proc/cpuinfo
.RE
.PP
To display information about the processors in all nodes except nodes 4 and 6:
.RS
\fBonall\fR -x 4,6 cat /proc/cpuinfo
.RE
.PP
To display the time on each node of a cluster:
.RS
\fBonall\fR -q date "'+node %n: %%H:%%M:%%S'"
.SH "SEE ALSO"
cluster(1), migrate(2), onnode(1), onsvc(1), onclass(1), rexec(2).
--- NEW FILE: onclass.1 ---
.TH ONCLASS 1 "14 November" "" "OpenSSI Cluster Prog Manual"
.SH NAME
onclass \- executes a command on all nodes running a particular service in a
cluster.
.SH SYNOPSIS
.nf
.B onclass \fR[\fB\-#bqLl\fR] \fIclass command args . . .\fR [\fI%n\fR]
.SH DESCRIPTION
Use \fBonclass\fR to execute \fIcommand\fR on each node of the class
of nodes in \fIclass\fR. \fIcommand\fR must be an executable binary or shell
script. If \fIcommand\fR is not specified as a fully qualified
pathname, directories in the \fB$PATH\fR environment variable are
searched.
.PP
A \fIclass\fR is a classification of nodes in a cluster so that similar
nodes can be given similar tasks. \fBinitnode\fR, \fBall\fR and \fBnone\fR
are the three system defined classes where \fBinitnode\fR is the node on
which the \fBinit\fR(8) process is running and \fBall\fR and \fBnone\fR are
all and none of the nodes respectively. \fIclass\fR can also be specified
as:
.RS
node=<comma separated list of node numbers>.
.RE
.PP
The \fB\-l\fR option executes the command as a localview process. In other
words, the process' view of /proc will be restricted to those processes
executing on the same node as \fIcommand\fR.
.PP
If successful, \fBonclass\fR returns a value of zero. Any non-zero return
value indicates a failure.
.SH ARGUMENTS
.TP
.B \-#
Prints command lines instead of executing \fIcommand\fR.
.TP
.B \-b
Executes each instance of the specified command or application in the
background. Execution order is not guaranteed. Also, does not print the
node number [see the \fB\-q\fR option].
.TP
.B \-q
Does not print the node number before running \fIcommand\fR.
.TP
.B \-L
Executes the \fIcommand\fR only on the local node (only if the local node
is a part of \fIclass\fR).
.TP
.B \-l
Executes the \fIcommand\fR as a localview process.
.TP
.I class
The class of nodes on which to execute the \fIcommand\fR.
.TP
.I command
The command to execute.
.TP
.I args
Specifies the argument or arguments to \fIcommand\fR.
.TP
.I %n
Replaces each occurence of \fI%n\fR with the number of the node on
which \fIcommand\fR runs.
.SH NOTE
Double percent characters (%%) are replaced with a single percent character.
.SH "SEE ALSO"
cluster(1), migrate(2), onnode(1), onall(1), onsvc(1), rexec(2).
--- NEW FILE: onnode.1 ---
.TH ONNODE 1 "14 November 2003" "" "OpenSSI Cluster Prog Manual"
.SH NAME
onnode \- executes a command on a specified node
.SH SYNOPSIS
.nf
.B onnode [\-p | \-P] [\-c] [\-f] [\-l] \fInode command\fR [\fIarg\fR]
.sp
.SH DESCRIPTION
Use \fBonnode\fR to execute a command on a specific \fInode\fR. The task is
associated with the node it is started on. \fIcommand\fR names an
executable binary or shell script and can be specified either as a
pathname or as a simple command (containing no slashes). In the latter
case, directories in \fB$PATH\fR are searched for \fIcommand\fR. \fBonnode\fR
does not handle shell aliases or shell built-in commands. \fBonnode\fR
passes any \fIargs\fR to \fIcommand\fR without interpreting them.
.PP
The \fB\-p\fR option pins the specified command onto the specified node. In
other words, the command is not subject to migration or \fBrexec\fR(2).
The \fB\-P\fR option will unpin the specified command from the specified
node. In other words, the command now becomes subject to migration or
\fBrexec\fR.
.PP
The \fB\-l\fR option executes the command as a localview process. In other
words, the process' view of /proc will be restricted to those processes
executing on the same node as command.
.SH ARGUMENTS
.TP
.B \-p
Pins the command on the specified node.
.TP
.B \-P
Unpins the command from the specified node.
.TP
.B \-c
Don't associate the process with the specified node.
.TP
.B \-f
Allows a privileged user to execute a command on a node that is not
fully \fIUP\fR. The \fB \-f \fR option is for experts only. When a node is in
the \fICOMINGUP\fR state, the \fBinit\fR command is responsible for executing
all initialization procedures. Forcing the execution of a command on a
node in this state may cause improper cluster operation.
.TP
.B \-l
Executes the command as a localview process.
.TP
.I node
The number of a processor node.
.TP
.I command
The command to execute.
.TP
.I arg
The argument(s) to command.
.SH "SEE ALSO"
cluster(1), migrate(2), onall(1), onsvc(1), onclass(1), rexec(2).
--- NEW FILE: onsvc.1 ---
.TH ONSVC 1 "14 November" "" "OpenSSI Cluster Prog Manual"
.SH NAME
onsvc \- executes a command on all nodes running a particular service in a
cluster.
.SH SYNOPSIS
.nf
.B onsvc \fR[\fB\-#bqLl\fR] \fIsvcname command args . . .\fR [\fI%n\fR]
.SH DESCRIPTION
Use \fBonsvc\fR to execute \fIcommand\fR on each node currently operating
in a cluster. \fIcommand\fR must be an executable binary or shell
script. If \fIcommand\fR is not specified as a fully qualified
pathname, directories in the \fB$PATH\fR environment variable are
searched.
.PP
The \fB\-l\fR option executes the command as a localview process. In other
words, the process' view of /proc will be restricted to those processes
executing on the same node as \fIcommand\fR.
.PP
If successful, \fBonsvc\fR returns a value of zero. Any non-zero return
value indicates a failure.
.SH ARGUMENTS
.TP
.B \-#
Prints command lines instead of executing \fIcommand\fR.
.TP
.B \-b
Executes each instance of the specified command or application in the
background. Execution order is not guaranteed. Also, does not print the
node number [see the \fB\-q\fR option].
.TP
.B \-q
Does not print the node number before running \fIcommand\fR.
.TP
.B \-L
Executes the \fIcommand\fR only on the local node (only if the service
\fIsvcname\fR is running).
.TP
.B \-l
Executes the \fIcommand\fR as a localview process.
.TP
.I svcname
The name of the service.
.TP
.I command
The command to execute.
.TP
.I args
Specifies the argument or arguments to \fIcommand\fR.
.TP
.I %n
Replaces each occurence of \fI%n\fR with the number of the node on
which \fIcommand\fR runs.
.SH NOTE
Double percent characters (%%) are replaced with a single percent character.
.SH "SEE ALSO"
cluster(1), migrate(2), onnode(1), onall(1), onclass(1), rexec(2).
-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive? Does it
help you create better code? SHARE THE LOVE, and help us help
YOU! Click Here: http://sourceforge.net/donate/
|
