This is automatically generated email about problems in a man page for which
you appear to be responsible. If you are not the right person or list, tell
me and I will attempt to correct my database.
See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated. Feel free to email me with any questions.
Note: These patches do not change the mod date of any manual page. You
may wish to do that by hand.
Problems with mpiexec.1:
1. Unknown or invalid macro. That is, one that does not fit in the
macro set that the man page seems to be using. This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.
--- mpiexec.1-orig 2004-11-13 18:02:20.180111000 -0500
+++ mpiexec.1 2004-11-13 18:02:44.022486408 -0500
@@ -141,7 +141,7 @@
file appschema(5) first.
.PP
Perhaps one of
-.IR1 mpiexec 's
+.IR mpiexec 's
most useful features is the command-line ability to launch different
executables on different architectures using the
.I -arch
@@ -195,13 +195,13 @@
local arguments. Each group must be separated by either a newline or
a colon (":"). For example:
.PP
-.vb
+.nf
# Sample mpiexec config file
# Launch foo on two nodes
-host node1.example.com foo : -host node2.example.com foo
# Launch two copies of bar on a third node
-host node3.example.com -np 2 bar
-.ve
+.fi
.SH ERRORS
In the event of an error,
.I mpiexec
-----------------------------
Problems with mpirun.1:
1. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.
--- mpirun.1-orig 2007-01-03 16:42:09.000000000 -0500
+++ mpirun.1 2007-01-03 16:48:09.000000000 -0500
@@ -1,55 +1,37 @@
.TH MPIRUN 1 "March, 2006" "LAM 7.1.2" "LAM COMMANDS"
.SH NAME
mpirun \- Run MPI programs on LAM nodes.
-.SH SYNTAX
+.SH SYNOPSIS
.hy 0
.HP
.na
mpirun
[-fhvO]
-[-c <#> | -np <#>]
-[-D | -wd <dir>]
+[-c nn | -np nn]
+[-D | -wd dir]
[-ger | -nger]
[-sigs | -nsigs]
-[-ssi <key> <value>]
+[-ssi key value]
[-nw | -w]
[-nx]
[-pty | -npty]
-[-s <node>]
+[-s node]
[-t | -toff | -ton]
[-tv]
-[-x VAR1[=VALUE1][,VAR2[=VALUE2],...]]
-[[-p <prefix_str>] [-sa | -sf]]
-[<where>]
-<program> [-- <args>]
-.PP
-.HP
+[-x settings]
+[[-p prefix_str] [-sa | -sf]]
+[where]
+{program> [-- <args>] | schema }
+
+.SH OPTION USAGE
.B Note:
Although each are individually optional, at least one of
-.IR <where> ,
+.IR where ,
.IR -np ,
or
.I -c
-must be specified in the above form (i.e., when a schema is not used).
-.PP
-.HP
-mpirun
-[-fhvO]
-[-D | -wd <dir>]
-[-ger | -nger]
-[-sigs | -nsigs]
-[-ssi <key> <value>]
-[-nw | -w]
-[-nx]
-[-pty | -npty]
-[-t | -toff | -ton]
-[-tv]
-[-x VAR1[=VALUE1][,VAR2[=VALUE2],...]]
-<schema>
-.br
+must be specified when a schema is not used.
.PP
-.HP
-.B Note:
The
.I -c2c
and
@@ -57,7 +39,6 @@
options are now obsolete. Use
.I -ssi
instead. See the "SSI" section, below.
-.RE
.ad b
.hy 1
.SH QUICK SUMMARY
@@ -178,7 +159,7 @@
exclusive with
.IR \-nsigs .
.TP
-.B -ssi <key> <value>
+.B -ssi key value
Send arguments to various SSI modules. See the "SSI" section, below.
.TP
.B -t, -ton
@@ -210,8 +191,8 @@
.IR mpirun
exits.
.TP
-.B -wd <dir>
-Change to the directory <dir> before the user's program executes.
+.BI -wd dir
+Change to the directory \fIdir\fR before the user's program executes.
Note that if the
.I -wd
option appears both on the command line and in an application schema,
@@ -220,6 +201,7 @@
.IR \-D .
.TP
.B -x
+Takes as its argument a comma-separated list of settings in the form VAR=VALUE.
Export the specified environment variables to the remote nodes before
executing the program. Existing environment variables can be
specified (see the Examples section, below), or new variable names
@@ -679,17 +661,17 @@
The
.I -ssi
switch takes two arguments:
-.I <key>
+.I key
and
-.IR <value> .
+.IR value .
The
-.I <key>
+.I key
argument generally specifies which SSI module will receive the value.
For example, the
.I <key>
"rpi" is used to select which RPI to be used for transporting MPI
messages. The
-.I <value>
+.I value
argument is the value that is passed. For example:
.TP 4
mpirun -ssi rpi lamd N foo
-----------------------------
--
Eric S. Raymond
|