Skip to content

Commit 8b041f8

Browse files
Lutz Grossclaude
andcommitted
Update run-escript man page to match the launcher
Bring doc/manpage/man1/run-escript.1 in line with run-escript.in: * Document the -a (show output from all MPI ranks) and -x (run in a new xterm) options, which the launcher accepts but the page omitted; add -a to the synopsis. * Fix -p: total processes is "nn times np" (was the stray "ns"). * Fix the -f env var name: ESCRIPT_HOSTFILE (the underscore was lost), and correct the hostfile constraint to "at least" the number of nodes (the launcher only errors when there are fewer hosts than nodes). * Fix -i: it has no effect with -b (the launcher ignores it rather than rejecting the combination); only nn*np>1 is an error. * Fix -o redirect filenames to stdout_rrrr.out / stdout_rrrr.err (the four-digit zero-padded rank), matching ScriptMPIredirect.cpp. * Drop the untested -m/valgrind option; fix "diagonstic" typo. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 302b63b commit 8b041f8

1 file changed

Lines changed: 26 additions & 11 deletions

File tree

doc/manpage/man1/run-escript.1

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
.TH run-escript 1 "" "" "esys Escript"
1+
2+
3+
4+
.TH run-escript 1 "" "" "esys Escript"
25

36
.SH NAME
47
run-escript - a launcher for programs and scripts using the escript libraries.
@@ -14,7 +17,7 @@ nt
1417
] [-f
1518
.I
1619
hostfile
17-
] [-x ] [-V ] [-e ] [-h ] [-v ] [-o ] [-c ] [-i ] [-b ] [
20+
] [-x ] [-a ] [-V ] [-e ] [-h ] [-v ] [-o ] [-c ] [-i ] [-b ] [
1821
.I
1922
file
2023
] [
@@ -62,7 +65,7 @@ The total number of processes to be used is
6265
.I
6366
nn
6467
times
65-
.IR ns .
68+
.IR np .
6669
.\" Please put a dot here
6770
This option overwrites the value of the
6871
.B
@@ -95,11 +98,11 @@ nt
9598
Specify the name of a file with a list of host names. Some systems require to specify the addresses or names of
9699
the compute nodes where MPI process should be spawned. The list of addresses or names of the compute
97100
nodes is listed in the file with the name hostfile. In order to avoid oversubsription the number of different
98-
hosts defined in hostfile must be equal to the number of requested compute nodes
101+
hosts defined in hostfile must be at least the number of requested compute nodes
99102
.IR nn .
100103
The option
101104
overwrites the value of the
102-
.B ESCRIPT HOSTFILE
105+
.B ESCRIPT_HOSTFILE
103106
environment variable. By default value no host file is
104107
used.
105108
.HP
@@ -129,10 +132,10 @@ nn
129132
*
130133
.I
131134
np
132-
> 1) is used or if
135+
> 1) is used. It has no effect when
133136
.B
134137
-b
135-
is used.
138+
is given, since no python interpreter is started.
136139

137140
.HP
138141
.B
@@ -148,10 +151,10 @@ Outputs export statements for the additional environment variables and commands
148151
.B
149152
-o
150153
Switches on the redirection of output of processors with MPI rank greater than zero to the files
151-
"stdout_r.out" and "stderr_r.out" where
154+
"stdout_rrrr.out" and "stdout_rrrr.err" where
152155
.I
153-
r
154-
is the rank of the processor. The option overwrites the value
156+
rrrr
157+
is the four-digit zero-padded rank of the processor. The option overwrites the value
155158
of the
156159
.B
157160
ESCRIPT_CREATESTDFILES
@@ -160,5 +163,17 @@ environment variable.
160163
.HP
161164
.B
162165
-v
163-
Prints some diagonstic information.
166+
Prints some diagnostic information.
167+
168+
.HP
169+
.B
170+
-a
171+
Show output from all MPI ranks (verbose mode). This sets the
172+
.B ESCRIPT_VERBOSE_MPI
173+
environment variable.
174+
175+
.HP
176+
.B
177+
-x
178+
Run escript in a new xterm instance.
164179

0 commit comments

Comments
 (0)