Permalink
Browse files

doc: remove unsupported modules from pdsh manpage

Udpate pdsh manpage to remove modules that are deprecated or no
longer included in the distribution.
  • Loading branch information...
grondo committed Jun 19, 2017
1 parent ecfc7d1 commit 632e0fb6c53cbd8f6a7bbb23adf3aa0169a39925
Showing with 1 addition and 79 deletions.
  1. +1 −79 doc/pdsh.1.in
View
@@ -90,20 +90,6 @@ the need to allocate reserved ports. In other aspects, it acts just
like rsh. Remote nodes must be running mrshd(8) in order for the mrsh
module to work.
.TP
qsh
Allows \fBpdsh\fR to execute MPI jobs over QsNet. Qshell propagates
the current working directory, pdsh environment, and Elan capabilities
to the remote process. The following environment variable are also
appended to the environment: RMS_RANK, RMS_NODEID, RMS_PROCID, RMS_NNODES,
and RMS_NPROCS. Since \fBpdsh\fR needs to run setuid root for qshell
support, qshell does not directly support propagation of LD_LIBRARY_PATH
and LD_PREOPEN. Instead the QSHELL_REMOTE_LD_LIBRARY_PATH and
QSHELL_REMOTE_LD_PREOPEN environment variables will may be used and will
be remapped to LD_LIBRARY_PATH and LD_PREOPEN by the qshell daemon if set.
.TP
mqsh
Similar to qshell, but uses the mrsh protocol instead of the rsh protocol.
.TP
krb4
The krb4 module allows users to execute remote commands after
authenticating with kerberos. Of course, the remote rshd daemons
@@ -224,22 +210,6 @@ connect and command time statistics on stderr when done.
Output \fBpdsh\fR version information, along with list of currently
loaded modules, and exit.
.SH "qsh/mqsh module options"
.TP
.I "-n tasks_per_node"
Set the number of tasks spawned per node. Default is 1.
.TP
.I "-m block | cyclic"
Set block versus cyclic allocation of processes to nodes. Default is
block.
.TP
.I "-r railmask"
Set the rail bitmask for a job on a multirail system. The default
railmask is 1, which corresponds to rail 0 only. Each bit set in
the argument to \fI-r\fR corresponds to a rail on the system, so
a value of 2 would correspond to rail 1 only, and 3 would indicate
to use both rail 1 and rail 0.
.SH "machines module options"
.TP
.I "-a"
@@ -347,51 +317,6 @@ a Torque allocation).
Target list of nodes allocated to the Torque job \fIjobid\fR. This option
may be used multiple times to target multiple Torque jobs.
.SH "rms module options"
The \fBrms\fR module allows pdsh to target nodes based on an RMS
resource. The \fBrms\fR module is typically called after all other
node selection options, and if no nodes have been selected, the
module will examine the RMS_RESOURCEID environment variable and
attempt to set the target list of hosts to the nodes in the
RMS resource. If an invalid resource is denoted, the variable is
silently ignored.
.SH "SDR module options"
The SDR module supports targeting hosts via the System Data Repository
on IBM SPs.
.TP
.I "-a"
Target all nodes in the SDR. The list is generated from the
"reliable hostname" in the SDR by default.
.TP
.I "-i"
Translate hostnames between reliable and initial in the SDR, when applicable.
If the a target hostname matches either the initial or reliable hostname
in the SDR, the alternate name will be substitued. Thus a list composed
of initial hostnames will instead be replaced with a list of reliable hostnames.
For example, when used with \fI-a\fR above, all initial hostnames in
the SDR are targeted.
.TP
.I "-v"
Do not target nodes that are marked as not responding in the SDR on
the targeted interface. (If a hostname does not appear in the SDR, then
that name will remain in the target hostlist.)
.TP
.I "-G"
In combination with \fI-a\fR, include all partitions.
.SH "nodeattr module options"
The \fBnodeattr\fR module supports access to the genders database
via the nodeattr(1) command. See the \fBgenders\fR section above
for a list of support options with this module. The option usage
with the \fBnodeattr\fR module is the same as \fBgenders\fR, above,
with the exception that the \fI-i\fR option may only be used
with \fI-a\fR or \fI-g\fR. \fBNOTE\fR: This module will only
work with very old releases of genders where the \fBnodeattr\fR(1)
command supports the \fI-r\fR option, and before the libgenders
API was available. Users running newer versions of genders
will need to use the \fBgenders\fR module instead.
.SH "dshgroup module options"
The dshgroup module allows pdsh to use dsh (or Dancer's shell) style
group files from /etc/dsh/group/ or ~/.dsh/group/. The default search
@@ -522,13 +447,10 @@ actually terminated when using a command timeout. Thus if \fI-u\fR is
used with \fBssh\fR commands may be left running on remote hosts even
after timeout has killed local \fBssh\fR processes.
Output from multiple processes per node may be interspersed when using qshell
or mqshell rcmd modules.
The number of nodes that \fBpdsh\fR can simultaneously execute remote
jobs on is limited by the maximum number of threads that can be created
concurrently, as well as the availability of reserved ports in the rsh
and qshell rcmd modules. On systems that implement Posix threads, the limit
module. On systems that implement Posix threads, the limit
is typically defined by the constant PTHREADS_THREADS_MAX.
.SH "FILES"

0 comments on commit 632e0fb

Please sign in to comment.