Update documentation of -M and PDSH_MISC_MODULES

Author: grondo

ChangeLog

@@ -1,5 +1,8 @@
 2010-09-01  Mark Grondona <mgrondona@llnl.gov>
 
+	* README.modules, doc/pdcp.1.in, doc/pdsh.1.in :
+	  Update documentation: adding -M and PDSH_MISC_MODULES.
+
 	* src/pdsh/opt.c :
 	  Add new option -M to allow named misc modules to be
 	  pre-initialized before others, thus overriding which

README.modules

@@ -13,8 +13,10 @@ the environment variable PDSH_RCMD_TYPE.
 When pdsh initializes it reads all available modules from the
 `pkglibdir' (typically /usr/lib/pdsh or /usr/local/lib/pdsh). If
 conflicting modules are installed, they are loaded on a first-come
-first-serve basis (i.e. the first module loaded wins). There
-is no guarantee as to which module will be loaded first.
+first-serve basis (i.e. the first module loaded wins). Modules
+may be force-initialized by specifying them to the '-M' pdsh/pdcp
+option, or via the PDSH_MISC_MODULES environment variable.
+
 
 PDSH MODULES:
 =============

doc/pdcp.1.in

@@ -149,6 +149,14 @@ Set rcmd module to \fIname\fR. This option may also be set via the
 PDSH_RCMD_TYPE environment variable. A list of available rcmd
 modules may be obtained via either the \fI-h\fR or \fI-L\fR options.
 .TP
+.I "-M name,..."
+When multiple \fBmisc\fR modules provide the same options to \fBpdsh\fR,
+the first module initialized "wins" and subsequent modules are not loaded.
+The \fI-M\fR option allows a list of modules to be specified that will be
+force-initialized before all others, in-effect ensuring that they load
+without conflict (unless they conflict with eachother). This option may
+also be set via the PDSH_MISC_MODULES environment variable.
+.TP
 .I "-L"
 List info on all loaded \fBpdcp\fR modules and quit.
 .TP

doc/pdsh.1.in

@@ -184,6 +184,14 @@ PDSH_RCMD_TYPE environment variable. A list of available rcmd
 modules may be obtained via the \fI-h\fR, \fI-V\fR, or \fI-L\fR options. 
 The default will be listed with \fI-h\fR or \fI-V\fI.
 .TP
+.I "-M name,..."
+When multiple \fBmisc\fR modules provide the same options to \fBpdsh\fR,
+the first module initialized "wins" and subsequent modules are not loaded.
+The \fI-M\fR option allows a list of modules to be specified that will be
+force-initialized before all others, in-effect ensuring that they load
+without conflict (unless they conflict with eachother). This option may
+also be set via the PDSH_MISC_MODULES environment variable.
+.TP
 .I "-L"
 List info on all loaded \fBpdsh\fR modules and quit.
 .TP