Commit 8390fb6a authored by Pavan Balaji's avatar Pavan Balaji
Browse files

Replace "-" with "\-" to keep Debian lintian checks happy.



Replace "-" with "\-", so the manpage shows a minus instead of a
hyphen.  Thanks to Torquil Macdonald Sørensen <torquil@gmail.com> for
providing the initial patch.
Signed-off-by: default avatarTorquil Macdonald Sørensen <torquil@gmail.com>
Signed-off-by: Pavan Balaji's avatarPavan Balaji <balaji@mcs.anl.gov>
parent f77aacb8
......@@ -10,28 +10,28 @@
as it provides the necessary libraries.
Command line arguments:
+ -show - Show the commands that would be used without
+ \-show - Show the commands that would be used without
running them
. -help - Give short help
. -cc=name - Use compiler 'name' instead of the default choice. Use
. \-help - Give short help
. \-cc=name - Use compiler 'name' instead of the default choice. Use
this only if the compiler is compatible with the MPICH
library (see below)
. -config=name - Load a configuration file for a particular compiler.
. \-config=name - Load a configuration file for a particular compiler.
This allows a single 'mpicc' command to be used with
multiple compilers.
. -compile_info - Show the steps for compiling a program. This option
. \-compile_info - Show the steps for compiling a program. This option
can be used to see what options and include paths are
used by mpicc.
. -link_info - Show the steps for linking a program. This optoin
. \-link_info - Show the steps for linking a program. This option
can be used to see what options and libraries are used by
mpicc.
. -profile=name - Use the MPI profiling given by name. See below for
. \-profile=name - Use the MPI profiling given by name. See below for
details
. -echo - Show exactly what this program is doing.
. \-echo - Show exactly what this program is doing.
This option should normally not be used.
- others - are passed to the compiler or linker. For example, '-c'
causes files to be compiled, '-g' selects compilation with
debugging on most systems, and '-o name' causes linking
- others - are passed to the compiler or linker. For example, '\-c'
causes files to be compiled, '\-g' selects compilation with
debugging on most systems, and '\-o name' causes linking
with the output executable given the name 'name'.
Environment Variables:
......@@ -42,8 +42,8 @@
code compiled with the different compilers.
The environment variable 'MPICC_PROFILE' specifies a profile library
and has the same effect as if '-profile=$MPICC_PROFILE' were used as
an argument to 'mpicc'. See the discussion of '-profile' below for more
and has the same effect as if '\-profile=$MPICC_PROFILE' were used as
an argument to 'mpicc'. See the discussion of '\-profile' below for more
details.
Compatible Compilers:
......@@ -52,7 +52,7 @@
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
exceptions; if you use the 'MPICH_CC' environment variable or the
'-cc=name' command-line argument to override the choice of compiler
'\-cc=name' command-line argument to override the choice of compiler
and encounter problems, try reconfiguring MPICH with the new compiler
and installing MPICH in a separate location. See the installation manual
for more details.
......@@ -60,21 +60,21 @@
Examples:
To compile a single file 'foo.c', use
.vb
mpicc -c foo.c
mpicc \-c foo.c
.ve
To link the output and make an executable, use
.vb
mpicc -o foo foo.o
mpicc \-o foo foo.o
.ve
Combining compilation and linking in a single command
.vb
mpicc -o foo foo.c
mpicc \-o foo foo.c
.ve
is a convenient way to build simple programs.
Selecting a Profiling Library:
The '-profile=name' argument allows you to specify an MPI profiling
The '\-profile=name' argument allows you to specify an MPI profiling
library to be used. 'name' can have two forms\:
.n A library in the same directory as the MPI library
......@@ -95,12 +95,12 @@ is a convenient way to build simple programs.
you could create the file 'myprof.conf' with the lines
.vb
PROFILE_PRELIB="-L/usr/local/myprof/lib -lmyprof"
PROFILE_INCPATHS="-I/usr/local/myprof/include"
PROFILE_PRELIB="\-L/usr/local/myprof/lib \-lmyprof"
PROFILE_INCPATHS="\-I/usr/local/myprof/include"
.ve
and place it in the sysconfdir directory (this directory is set at
configure time when MPICH is built). Then using the command-line
argument '-profile=myprof' will cause these
argument '\-profile=myprof' will cause these
definitions to be added to the relevant compile commands.
.seealso: mpif77, mpicxx, mpif90, mpiexec
......
......@@ -10,28 +10,28 @@
as it provides the necessary libraries.
Command line arguments:
+ -show - Show the commands that would be used without
+ \-show - Show the commands that would be used without
running them
. -help - Give short help
. -cxx=name - Use compiler 'name' instead of the default choice. Use
. \-help - Give short help
. \-cxx=name - Use compiler 'name' instead of the default choice. Use
this only if the compiler is compatible with the MPICH
library (see below)
. -config=name - Load a configuration file for a particular compiler.
. \-config=name - Load a configuration file for a particular compiler.
This allows a single 'mpicxx' command to be used with
multiple compilers.
. -compile_info - Show the steps for compiling a program. This option
. \-compile_info - Show the steps for compiling a program. This option
can be used to see what options and include paths are
used by mpicxx.
. -link_info - Show the steps for linking a program. This optoin
. \-link_info - Show the steps for linking a program. This option
can be used to see what options and libraries are used by
mpicxx.
. -profile=name - Use the MPI profiling given by name. See below for
. \-profile=name - Use the MPI profiling given by name. See below for
details
. -echo - Show exactly what this program is doing.
. \-echo - Show exactly what this program is doing.
This option should normally not be used.
- others - are passed to the compiler or linker. For example, '-c'
causes files to be compiled, '-g' selects compilation with
debugging on most systems, and '-o name' causes linking
- others - are passed to the compiler or linker. For example, '\-c'
causes files to be compiled, '\-g' selects compilation with
debugging on most systems, and '\-o name' causes linking
with the output executable given the name 'name'.
Environment Variables:
......@@ -42,8 +42,8 @@
code compiled with the different compilers.
The environment variable 'MPICC_PROFILE' specifies a profile library
and has the same effect as if '-profile=$MPICC_PROFILE' were used as
an argument to 'mpicc'. See the discussion of '-profile' below for more
and has the same effect as if '\-profile=$MPICC_PROFILE' were used as
an argument to 'mpicc'. See the discussion of '\-profile' below for more
details.
Compatible Compilers:
......@@ -52,7 +52,7 @@
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
exceptions; if you use the 'MPICH_CXX' environment variable or the
'-cxx=name' command-line argument to override the choice of compiler
'\-cxx=name' command-line argument to override the choice of compiler
and encounter problems, try reconfiguring MPICH with the new compiler,
and installing MPICH in a separate location. See the installation manual
for more details.
......@@ -60,21 +60,21 @@
Examples:
To compile a single file 'foo.c', use
.vb
mpicxx -c foo.cxx
mpicxx \-c foo.cxx
.ve
To link the output and make an executable, use
.vb
mpicxx -o foo foo.o
mpicxx \-o foo foo.o
.ve
Combining compilation and linking in a single command
.vb
mpicxx -o foo foo.cxx
mpicxx \-o foo foo.cxx
.ve
is a convenient way to build simple programs.
Selecting a Profiling Library:
The '-profile=name' argument allows you to specify an MPI profiling
The '\-profile=name' argument allows you to specify an MPI profiling
library to be used. 'name' can have two forms\:
.n A library in the same directory as the MPI library
......@@ -95,12 +95,12 @@ is a convenient way to build simple programs.
you could create the file 'myprof.conf' with the lines
.vb
PROFILE_PRELIB="-L/usr/local/myprof/lib -lmyprof"
PROFILE_INCPATHS="-I/usr/local/myprof/include"
PROFILE_PRELIB="\-L/usr/local/myprof/lib \-lmyprof"
PROFILE_INCPATHS="\-I/usr/local/myprof/include"
.ve
and place it in the sysconfdir directory (this directory is set at
configure time when MPICH is built). Then using the command-line
argument '-profile=myprof' will cause these
argument '\-profile=myprof' will cause these
definitions to be added to the relevant compile commands.
.seealso: mpif77, mpicc, mpif90, mpiexec
......
......@@ -11,23 +11,23 @@
Multiple Data applications). For example, the following command will run
the MPI program 'a.out' on 4 processes\:
.vb
mpiexec -n 4 a.out
mpiexec \-n 4 a.out
.ve
The MPI standard specifies the following arguments and their meanings\:
+ -n <np> - Specify the number of processes to use
. -host <hostname> - Name of host on which to run processes
. -arch <architecture name> - Pick hosts with this architecture type
. -wdir <working directory> - cd to this one `before` running executable
. -path <pathlist> - use this to find the executable
. -soft <triplets> - comma separated triplets that specify requested numbers
+ \-n <np> - Specify the number of processes to use
. \-host <hostname> - Name of host on which to run processes
. \-arch <architecture name> - Pick hosts with this architecture type
. \-wdir <working directory> - cd to this one `before` running executable
. \-path <pathlist> - use this to find the executable
. \-soft <triplets> - comma separated triplets that specify requested numbers
of processes (see the MPI-2 specification for more details)
. -file <name> - implementation-defined specification file
- -configfile <name> - file containing specifications of host/program,
. \-file <name> - implementation-defined specification file
- \-configfile <name> - file containing specifications of host/program,
one per line, with # as a comment indicator, e.g., the usual
mpiexec input, but with ":" replaced with a newline. That is,
the configfile contains lines with -soft, -n etc.
the configfile contains lines with \-soft, \-n etc.
Additional arguments that are specific to the MPICH implementation
are discussed below.
......@@ -35,14 +35,14 @@ The MPI standard specifies the following arguments and their meanings\:
Note that not all of these parameters are meaningful for all
systems. For example, the 'gforker' version of 'mpiexec' creates all
processes on the same system on which it is running; in that case, the
'-arch' and '-host' options are ignored.
'\-arch' and '\-host' options are ignored.
The colon character (':') may be used to separate different executables
for MPMD (multiple program multiple data) programming. For example,
to run the program 'ocean' on 4 processes and 'air' on 8 processes, use\:
.vb
mpiexec -n 4 ocean : -n 8 air
mpiexec \-n 4 ocean : \-n 8 air
.ve
......@@ -51,29 +51,29 @@ The MPI standard specifies the following arguments and their meanings\:
Many of the implementations of process managers in MPICH support the
following arguments to 'mpiexec'\:
+ -np <num> - A synonym for the standard '-n' argument
. -env <name> <value> - Set the environment variable '<name>' to '<value>' for
+ \-np <num> - A synonym for the standard '\-n' argument
. \-env <name> <value> - Set the environment variable '<name>' to '<value>' for
the processes being run by 'mpiexec'
. -envnone - Pass no environment variables (other than ones specified with
other '-env' or '-genv' arguments) to the processes being run by 'mpiexec'.
. \-envnone - Pass no environment variables (other than ones specified with
other '\-env' or '\-genv' arguments) to the processes being run by 'mpiexec'.
By default, all environment
variables are provided to each MPI process (rationale: principle of
least surprise for the user)
. -envlist <list> - Pass the listed environment variables (names separated
. \-envlist <list> - Pass the listed environment variables (names separated
by commas), with their current values, to the processes being run by
'mpiexec'.
. -genv <name> <value> - The '-genv' options have the same meaning as their
corresponding '-env' version, except they apply to all executables, not just
. \-genv <name> <value> - The '\-genv' options have the same meaning as their
corresponding '\-env' version, except they apply to all executables, not just
the current executable (in the case that the colon syntax is used to specify
multiple execuables).
. -genvnone - Like '-envnone', but for all executables
. -genvlist <list> - Like '-envlist', but for all executables
. -usize <n> - Specify the value returned for the value of the attribute
. \-genvnone - Like '\-envnone', but for all executables
. \-genvlist <list> - Like '\-envlist', but for all executables
. \-usize <n> - Specify the value returned for the value of the attribute
'MPI_UNIVERSE_SIZE'.
. -l - Label standard out and standard error ('stdout' and 'stderr') with
. \-l - Label standard out and standard error ('stdout' and 'stderr') with
the rank of the process
. -maxtime <n> - Set a timelimit of '<n>' seconds.
- -exitinfo - Provide more information on the reason each process exited if
. \-maxtime <n> - Set a timelimit of '<n>' seconds.
- \-exitinfo - Provide more information on the reason each process exited if
there is an abnormal exit
Environment variables for mpiexec:
......
......@@ -10,28 +10,28 @@
as it provides the necessary libraries.
Command line arguments:
+ -show - Show the commands that would be used without
+ \-show - Show the commands that would be used without
running them
. -help - Give short help
. -f77=name - Use compiler 'name' instead of the default choice. Use
. \-help - Give short help
. \-f77=name - Use compiler 'name' instead of the default choice. Use
this only if the compiler is compatible with the MPICH
library (see below)
. -config=name - Load a configuration file for a particular compiler.
. \-config=name - Load a configuration file for a particular compiler.
This allows a single 'mpif77' command to be used with
multiple compilers.
. -compile_info - Show the steps for compiling a program. This option
. \-compile_info - Show the steps for compiling a program. This option
can be used to see what options and include paths are
used by mpif77.
. -link_info - Show the steps for linking a program. This optoin
. \-link_info - Show the steps for linking a program. This option
can be used to see what options and libraries are used by
mpif77.
. -profile=name - Use the MPI profiling given by name. See below for
. \-profile=name - Use the MPI profiling given by name. See below for
details
. -echo - Show exactly what this program is doing.
. \-echo - Show exactly what this program is doing.
This option should normally not be used.
- others - are passed to the compiler or linker. For example, '-c'
causes files to be compiled, '-g' selects compilation with
debugging on most systems, and '-o name' causes linking
- others - are passed to the compiler or linker. For example, '\-c'
causes files to be compiled, '\-g' selects compilation with
debugging on most systems, and '\-o name' causes linking
with the output executable given the name 'name'.
Environment Variables:
......@@ -47,7 +47,7 @@
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
exceptions; if you use the 'MPICH_F77' environment variable or the
'-f77=name' command-line argument to override the choice of compiler
'\-f77=name' command-line argument to override the choice of compiler
and encounter problems, try reconfiguring MPICH with the new compiler
and installing MPICH in a separate location. See the installation manual
for more details.
......@@ -55,21 +55,21 @@
Examples:
To compile a single file 'foo.f', use
.vb
mpif77 -c foo.f
mpif77 \-c foo.f
.ve
To link the output and make an executable, use
.vb
mpif77 -o foo foo.o
mpif77 \-o foo foo.o
.ve
Combining compilation and linking in a single command
.vb
mpif77 -o foo foo.f
mpif77 \-o foo foo.f
.ve
is a convenient way to build simple programs.
Selecting a Profiling Library:
The '-profile=name' argument allows you to specify an MPI profiling
The '\-profile=name' argument allows you to specify an MPI profiling
library to be used. 'name' can have two forms\:
.n A library in the same directory as the MPI library
......@@ -90,12 +90,12 @@ is a convenient way to build simple programs.
you could create the file 'myprof.conf' with the lines
.vb
PROFILE_PRELIB="-L/usr/local/myprof/lib -lmyprof"
PROFILE_INCPATHS="-I/usr/local/myprof/include"
PROFILE_PRELIB="\-L/usr/local/myprof/lib \-lmyprof"
PROFILE_INCPATHS="\-I/usr/local/myprof/include"
.ve
and place it in the sysconfdir directory (this directory is set at
configure time when MPICH is built). Then using the command-line
argument '-profile=myprof' will cause these
argument '\-profile=myprof' will cause these
definitions to be added to the relevant compile commands.
.seealso: mpicc, mpicxx, mpif90, mpiexec
......
......@@ -10,28 +10,28 @@
as it provides the necessary libraries.
Command line arguments:
+ -show - Show the commands that would be used without
+ \-show - Show the commands that would be used without
running them
. -help - Give short help
. -f90=name - Use compiler 'name' instead of the default choice. Use
. \-help - Give short help
. \-f90=name - Use compiler 'name' instead of the default choice. Use
this only if the compiler is compatible with the MPICH
library (see below)
. -config=name - Load a configuration file for a particular compiler.
. \-config=name - Load a configuration file for a particular compiler.
This allows a single 'mpif90' command to be used with
multiple compilers.
. -compile_info - Show the steps for compiling a program. This option
. \-compile_info - Show the steps for compiling a program. This option
can be used to see what options and include paths are
used by mpif90.
. -link_info - Show the steps for linking a program. This optoin
. \-link_info - Show the steps for linking a program. This option
can be used to see what options and libraries are used by
mpif90.
. -profile=name - Use the MPI profiling given by name. See below for
. \-profile=name - Use the MPI profiling given by name. See below for
details
. -echo - Show exactly what this program is doing.
. \-echo - Show exactly what this program is doing.
This option should normally not be used.
- others - are passed to the compiler or linker. For example, '-c'
causes files to be compiled, '-g' selects compilation with
debugging on most systems, and '-o name' causes linking
- others - are passed to the compiler or linker. For example, '\-c'
causes files to be compiled, '\-g' selects compilation with
debugging on most systems, and '\-o name' causes linking
with the output executable given the name 'name'.
Environment Variables:
......@@ -47,7 +47,7 @@
uses compatible run-time libraries. On many systems, the various
compilers are compatible and may be used interchangably. There are
exceptions; if you use the 'MPICH_F90' environment variable or the
'-f90=name' command-line argument to override the choice of compiler
'\-f90=name' command-line argument to override the choice of compiler
and encounter problems, try reconfiguring MPICH with the new compiler
and installing MPICH in a separate location. See the installation manual
for more details.
......@@ -55,21 +55,21 @@
Examples:
To compile a single file 'foo.f', use
.vb
mpif90 -c foo.f
mpif90 \-c foo.f
.ve
To link the output and make an executable, use
.vb
mpif90 -o foo foo.o
mpif90 \-o foo foo.o
.ve
Combining compilation and linking in a single command
.vb
mpif90 -o foo foo.f
mpif90 \-o foo foo.f
.ve
is a convenient way to build simple programs.
Selecting a Profiling Library:
The '-profile=name' argument allows you to specify an MPI profiling
The '\-profile=name' argument allows you to specify an MPI profiling
library to be used. 'name' can have two forms\:
.n A library in the same directory as the MPI library
......@@ -90,12 +90,12 @@ is a convenient way to build simple programs.
you could create the file 'myprof.conf' with the lines
.vb
PROFILE_PRELIB="-L/usr/local/myprof/lib -lmyprof"
PROFILE_INCPATHS="-I/usr/local/myprof/include"
PROFILE_PRELIB="\-L/usr/local/myprof/lib \-lmyprof"
PROFILE_INCPATHS="\-I/usr/local/myprof/include"
.ve
and place it in the sysconfdir directory (this directory is set at
configure time when MPICH is built). Then using the command-line
argument '-profile=myprof' will cause these
argument '\-profile=myprof' will cause these
definitions to be added to the relevant compile commands.
.seealso: mpicc, mpicxx, mpif90, mpiexec
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment