- Next message: esr_at_[hidden]: "problems in LAM.7, MPI.7"
- Previous message: Josh Lehan: "Patch for lamhalt lamd segfault if tkill not found"
- Next in thread: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
- Reply: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
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 lamboot.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.
2. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.
--- lamboot.1-orig 2007-01-02 19:36:22.000000000 -0500
+++ lamboot.1 2007-01-02 19:37:05.000000000 -0500
@@ -1,7 +1,7 @@
.TH LAMBOOT 1 "March, 2006" "LAM 7.1.2" "LAM TOOLS"
.SH NAME
lamboot \- Start a LAM multicomputer.
-.SH SYNTAX
+.SH SYNOPSIS
.hy 0
.HP
.na
@@ -315,9 +315,9 @@
package works properly. However, it is sometimes desirable to close
the stdio of the local LAM daemon as well. For example:
.PP
-.vb
+.RS
rsh somenode lamboot -s hostfile
-.ve
+.RE
.PP
This is because
.I rsh
-----------------------------
Problems with lamexec.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.
2. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.
--- lamexec.1-orig 2007-01-02 19:39:48.000000000 -0500
+++ lamexec.1 2007-01-02 19:40:15.000000000 -0500
@@ -1,7 +1,7 @@
.TH MPIEXEC 1 "March, 2006" "LAM 7.1.2" "LAM COMMANDS"
.SH NAME
mpiexec \- Run MPI programs on LAM nodes.
-.SH SYNTAX
+.SH SYNOPSIS
.hy 0
.HP
mpiexec [global_args] local_args1 [: local_args2 [...]]
@@ -145,7 +145,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
@@ -199,13 +199,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 lammsg.1:
1. Use of low-level troff hackery to set special indents or breaks can't
be translated. The page will have rendering faults in HTML, and
probably also under third-party man page browsers such as Xman, TkMan,
Rosetta, and the KDE help browser.
2. TBL markup not used where it should be. Tables stitched together
with .ta requests can't be lifted to DocBook and will often
choke third-party viewers such as TKMan, XMan, Rosetta, etc.
3. Broken command synopsis syntax. This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).
4. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.
--- lammsg.1-orig 2007-01-02 19:58:51.000000000 -0500
+++ lammsg.1 2007-01-02 20:02:22.000000000 -0500
@@ -1,12 +1,12 @@
.TH MPIMSG 1 "March, 2006" "LAM 7.1.2" "LAM COMMANDS"
.SH NAME
mpimsg \- Monitor MPI message buffers under LAM.
-.SH SYNTAX
+.SH SYNOPSIS
.hy 0
.HP
.na
-mpimsg [-gps] [-h] [-O] [-c <seq>] [-d <seq>] [-m <seq>] [-e <#>] [-B <#>]
-[<nodes>] [<processes>]
+mpimsg [-gps] [-h] [-O] [-c seq] [-d seq] [-m seq] [-e nn] [-B nn]
+[nodes] [processes]
.hy 1
.ad b
.SH OPTIONS
@@ -22,22 +22,22 @@
Do no data conversion.
See mpirun(1).
.TP
-.B \-c <seq>
+.B \-c seq
Print a description of the communicator used in message <seq>.
See mpitask(1).
.TP
-.B \-d <seq>
+.B \-d seq
Print a description of the datatype used in message <seq>.
See mpitask(1).
.TP
-.B \-e <#>
+.B \-e nn
Limit printing the contents of a message to <#> elements.
.TP
-.B \-m <seq>
+.B \-m seq
Print the contents of message <seq>.
See "Message Contents".
.TP
-.B \-B <#>
+.B \-B nn
Change the limit on the number of messages reported.
.PP
The \-c, \-d and \-m options are mutually exclusive.
@@ -54,14 +54,12 @@
With no processes or nodes explicitly specified on the command
line, all MPI messages on all nodes are reported.
.PP
-.nf
-.if n .ta 15 30 38 46 56 68
-.if t .ta 1.25i 2.5i 3.75i 4.5i 5.25i 6.25i
-.in 0
% mpimsg
+.TS
+l l l l l l l l l.
SRC (G/L) DEST (G/L) TAG COMM COUNT DATATYPE MSG
0/0 1/1 123 WORLD 64 INT n1,#0
-.fi
+.TE
.PP
For each message
.I mpimsg
-----------------------------
Problems with lamrun.1:
1. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.
--- lamrun.1-orig 2007-01-02 20:04:21.000000000 -0500
+++ lamrun.1 2007-01-02 20:04:34.000000000 -0500
@@ -1,7 +1,7 @@
.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
-----------------------------
Problems with lamtask.1:
1. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.
2. TBL markup not used where it should be. Tables stitched together
with .ta requests can't be lifted to DocBook and will often
choke third-party viewers such as TKMan, XMan, Rosetta, etc.
--- lamtask.1-orig 2007-01-02 20:06:19.000000000 -0500
+++ lamtask.1 2007-01-02 20:07:17.000000000 -0500
@@ -1,7 +1,7 @@
.TH MPITASK 1 "March, 2006" "LAM 7.1.2" "LAM COMMANDS"
.SH NAME
mpitask \- Monitor MPI processes under LAM.
-.SH SYNTAX
+.SH SYNOPSIS
.hy 0
.HP
mpitask [-cdh] [-gps] [<nodes>] [<processes>]
@@ -31,15 +31,13 @@
nodes explicitly specified on the command line, all MPI processes on
all nodes are reported.
.PP
-.nf
-.if n .ta 21 35 46 53 60 68
-.if t .ta 1.25i 2.5i 3.75i 4.5i 5.25i 6i
-.in 0
% mpitask
+.TS
+l l l l l l l l.
TASK (G/L) FUNCTION PEER|ROOT TAG COMM COUNT DATATYPE
0/0 trivial Ssend 1/1 123 WORLD 64 INT
1/1 trivial Recv 0/0 456 WORLD 64 INT
-.fi
+.TE
.PP
For each process
.I mpitask
-----------------------------
Problems with lamshrink.1:
1. Broken command synopsis syntax. This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).
2. SYNTAX section is actually a Unix SYNOPSIS and should be so marked.
--- lamshrink.1-orig 2007-01-02 20:08:31.000000000 -0500
+++ lamshrink.1 2007-01-02 20:09:32.000000000 -0500
@@ -1,10 +1,10 @@
.TH LAMSHRINK 1 "March, 2006" "LAM 7.1.2" "LAM COMMANDS"
.SH NAME
lamshrink \- Shrink a LAM universe.
-.SH SYNTAX
+.SH SYNOPSIS
.hy 0
.HP
-lamshrink [-dhv] [-w <delay>] <nodeid>
+lamshrink [-dhv] [-w delay] nodeid
.hy 1
.br
.SH OPTIONS
@@ -18,12 +18,12 @@
.B \-v
Be verbose.
.TP
-.B <nodeid>
-Remove the LAM node with this ID.
-.TP
-.B \-w <delay>
+.B \-w delay
Notify processes on the doomed node and pause for <delay> seconds
before proceeding.
+.TP
+.B nodeid
+Remove the LAM node with this ID.
.SH DESCRIPTION
An existing LAM session, initiated by lamboot(1), can be shrunk to
include less nodes with
-----------------------------
Problems with lamd.1:
1. Use of low-level troff hackery to set special indents or breaks can't
be translated. The page will have rendering faults in HTML, and
probably also under third-party man page browsers such as Xman, TkMan,
Rosetta, and the KDE help browser.
--- lamd.1-orig 2007-01-02 19:41:35.000000000 -0500
+++ lamd.1 2007-01-02 19:43:28.000000000 -0500
@@ -46,48 +46,40 @@
.SS Unloading MPI Trace Data
lamtrace(1)
.SS Reference Documents
-.HP
+.TP
"LAM/MPI Installation Guide"
-.br
included in the LAM/MPI distribution and available on
.I http://www.lam-mpi.org/
-.HP
+.TP
"LAM/MPI User's Guide"
-.br
included in the LAM/MPI distribution and available on
.I http://www.lam-mpi.org/
-.HP
+.TP
"LAM Frequently Asked Questions"
-.br
at
.I http://www.lam-mpi.org/faq/
-.HP
+.TP
"MPI Primer / Developing with LAM", Ohio Supercomputer Center
-.HP
-"MPI: A Message-Passing Interface Standard", Message-Passing
-Interface Forum, version 1.1
-.br
+.TP
+"MPI: A Message-Passing Interface Standard", Message-Passing Interface Forum, version 1.1
at
.I http://www.mpi-forum.org/
-.HP
-"MPI-2: Extensions to the Message Passing Interface", Message Passing
-Interface Forum, version 2.0
-.br
+.TP
+"MPI-2: Extensions to the Message Passing Interface", Message Passing Interface Forum, version 2.0
at
.I http://www.mpi-forum.org/
.SS MPI Quick Tutorials
-.HP
+.TP
"LAM/MPI ND User Guide / Introduction"
-.br
at
.I http://www.lam-mpi.org/mpi/tutorials/lam/
-.HP
+.TP
"MPI: It's Easy to Get Started"
-.HP
+.TP
"MPI: Everyday Datatypes"
-.HP
+.TP
"MPI: Everyday Collective Communication"
.SS Guaranteed Envelope Resources
-.HP
+.TP
"Robust MPI Message Delivery Through Guaranteed Resources",
MPI Developer's Conference, 1995
-----------------------------
--
Eric S. Raymond
- Next message: esr_at_[hidden]: "problems in LAM.7, MPI.7"
- Previous message: Josh Lehan: "Patch for lamhalt lamd segfault if tkill not found"
- Next in thread: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
- Reply: Brian Barrett: "Re: problems in lamboot.1, lamexec.1, lammsg.1, lamrun.1, lamtask.1, lamshrink.1, lamd.1"
|
