* Integrate man pages contributed by Dirk Eddelbuettel
* Make orted.1 man page be non-descriptive because it's really an internal command. * Re-work the opal_wrapper man page logic a bit so that we can have a real opal_wrapper.1 installed that says "don't look here -- look at mpicc (etc.)" This commit was SVN r15264.
Этот коммит содержится в:
родитель
610d7a0d2c
Коммит
c796d84d61
@ -9,7 +9,7 @@
|
|||||||
# University of Stuttgart. All rights reserved.
|
# University of Stuttgart. All rights reserved.
|
||||||
# Copyright (c) 2004-2005 The Regents of the University of California.
|
# Copyright (c) 2004-2005 The Regents of the University of California.
|
||||||
# All rights reserved.
|
# All rights reserved.
|
||||||
# Copyright (c) 2006 Cisco Systems, Inc. All rights reserved.
|
# Copyright (c) 2006-2007 Cisco Systems, Inc. All rights reserved.
|
||||||
# $COPYRIGHT$
|
# $COPYRIGHT$
|
||||||
#
|
#
|
||||||
# Additional copyrights may follow
|
# Additional copyrights may follow
|
||||||
@ -82,22 +82,22 @@ endif # OMPI_INSTALL_BINARIES
|
|||||||
maintainer-clean-local:
|
maintainer-clean-local:
|
||||||
rm -f mpicc.1 mpic++.1 mpicxx.1 mpif77.1 mpif90.1
|
rm -f mpicc.1 mpic++.1 mpicxx.1 mpif77.1 mpif90.1
|
||||||
|
|
||||||
mpicc.1: $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1
|
mpicc.1: $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1
|
||||||
rm -f mpicc.1
|
rm -f mpicc.1
|
||||||
sed -e 's/@COMMAND@/mpicc/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/C/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > mpicc.1
|
sed -e 's/@COMMAND@/mpicc/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/C/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > mpicc.1
|
||||||
|
|
||||||
mpic++.1: $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1
|
mpic++.1: $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1
|
||||||
rm -f mpic++.1
|
rm -f mpic++.1
|
||||||
sed -e 's/@COMMAND@/mpic++/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > mpic++.1
|
sed -e 's/@COMMAND@/mpic++/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > mpic++.1
|
||||||
|
|
||||||
mpicxx.1: $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1
|
mpicxx.1: $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1
|
||||||
rm -f mpicxx.1
|
rm -f mpicxx.1
|
||||||
sed -e 's/@COMMAND@/mpicxx/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > mpicxx.1
|
sed -e 's/@COMMAND@/mpicxx/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > mpicxx.1
|
||||||
|
|
||||||
mpif77.1: $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1
|
mpif77.1: $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1
|
||||||
rm -f mpif77.1
|
rm -f mpif77.1
|
||||||
sed -e 's/@COMMAND@/mpif77/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/Fortran 77/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > mpif77.1
|
sed -e 's/@COMMAND@/mpif77/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/Fortran 77/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > mpif77.1
|
||||||
|
|
||||||
mpif90.1: $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1
|
mpif90.1: $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1
|
||||||
rm -f mpif90.1
|
rm -f mpif90.1
|
||||||
sed -e 's/@COMMAND@/mpif90/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/Fortran 90/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > mpif90.1
|
sed -e 's/@COMMAND@/mpif90/g' -e 's/@PROJECT@/Open MPI/g' -e 's/@PROJECT_SHORT@/OMPI/g' -e 's/@LANGUAGE@/Fortran 90/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > mpif90.1
|
||||||
|
@ -9,7 +9,7 @@
|
|||||||
# University of Stuttgart. All rights reserved.
|
# University of Stuttgart. All rights reserved.
|
||||||
# Copyright (c) 2004-2005 The Regents of the University of California.
|
# Copyright (c) 2004-2005 The Regents of the University of California.
|
||||||
# All rights reserved.
|
# All rights reserved.
|
||||||
# Copyright (c) 2006 Cisco Systems, Inc. All rights reserved.
|
# Copyright (c) 2006-2007 Cisco Systems, Inc. All rights reserved.
|
||||||
# $COPYRIGHT$
|
# $COPYRIGHT$
|
||||||
#
|
#
|
||||||
# Additional copyrights may follow
|
# Additional copyrights may follow
|
||||||
@ -20,10 +20,13 @@
|
|||||||
DEFS="-DEXEEXT=\"$(EXEEXT)\""
|
DEFS="-DEXEEXT=\"$(EXEEXT)\""
|
||||||
|
|
||||||
EXTRA_DIST = \
|
EXTRA_DIST = \
|
||||||
|
generic_wrapper.1 \
|
||||||
opal_wrapper.1 \
|
opal_wrapper.1 \
|
||||||
opalcc.1 \
|
opalcc.1 \
|
||||||
opalc++.1
|
opalc++.1
|
||||||
|
|
||||||
|
man_MANS = opal_wrapper.1
|
||||||
|
|
||||||
if OMPI_INSTALL_BINARIES
|
if OMPI_INSTALL_BINARIES
|
||||||
|
|
||||||
# install even if we don't want the headers / opalcc, as we need it
|
# install even if we don't want the headers / opalcc, as we need it
|
||||||
@ -55,7 +58,7 @@ if OMPI_INSTALL_BINARIES
|
|||||||
|
|
||||||
# List all man pages that will be installed
|
# List all man pages that will be installed
|
||||||
|
|
||||||
man_MANS = \
|
man_MANS += \
|
||||||
opalcc.1 \
|
opalcc.1 \
|
||||||
opalc++.1
|
opalc++.1
|
||||||
|
|
||||||
@ -74,10 +77,10 @@ endif # WANT_INSTALL_HEADERS
|
|||||||
maintainer-clean-local:
|
maintainer-clean-local:
|
||||||
rm -f opalcc.1 opalc++.1
|
rm -f opalcc.1 opalc++.1
|
||||||
|
|
||||||
opalcc.1: opal_wrapper.1
|
opalcc.1: generic_wrapper.1
|
||||||
rm -f opalcc.1
|
rm -f opalcc.1
|
||||||
sed -e 's/@COMMAND@/opalcc/g' -e 's/@PROJECT@/Open PAL/g' -e 's/@PROJECT_SHORT@/OPAL/g' -e 's/@LANGUAGE@/C/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > opalcc.1
|
sed -e 's/@COMMAND@/opalcc/g' -e 's/@PROJECT@/Open PAL/g' -e 's/@PROJECT_SHORT@/OPAL/g' -e 's/@LANGUAGE@/C/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > opalcc.1
|
||||||
|
|
||||||
opalc++.1: opal_wrapper.1
|
opalc++.1: generic_wrapper.1
|
||||||
rm -f opalc++.1
|
rm -f opalc++.1
|
||||||
sed -e 's/@COMMAND@/opalc++/g' -e 's/@PROJECT@/Open PAL/g' -e 's/@PROJECT_SHORT@/OPAL/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > opalc++.1
|
sed -e 's/@COMMAND@/opalc++/g' -e 's/@PROJECT@/Open PAL/g' -e 's/@PROJECT_SHORT@/OPAL/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > opalc++.1
|
||||||
|
208
opal/tools/wrappers/generic_wrapper.1
Обычный файл
208
opal/tools/wrappers/generic_wrapper.1
Обычный файл
@ -0,0 +1,208 @@
|
|||||||
|
.TH @COMMAND@ 1 "@PROJECT@" "@PROJECT_SHORT@" "@PROJECT@"
|
||||||
|
.
|
||||||
|
.SH NAME
|
||||||
|
@COMMAND@ -- @PROJECT@ @LANGUAGE@ wrapper compiler
|
||||||
|
.
|
||||||
|
.SH SYNTAX
|
||||||
|
@COMMAND@ [-showme|-showme:compile|-showme:link] ...
|
||||||
|
.
|
||||||
|
.SH OPTIONS
|
||||||
|
.TP
|
||||||
|
-showme
|
||||||
|
Do not invoke the underlying compiler. Instead, show the command line
|
||||||
|
that would be executed to compile the program. \fBNOTE:\fR If a
|
||||||
|
non-filename argument is passed on the command line, the \fI-showme\fR
|
||||||
|
option will \fInot\fR display any additional flags. For example, both
|
||||||
|
"@COMMAND@ --showme" and "@COMMAND@ --showme my_source.c" will show all the
|
||||||
|
wrapper-supplied flags. But "@COMMAND@ -showme -v" will only show the
|
||||||
|
underlying compiler name and "-v".
|
||||||
|
.TP
|
||||||
|
-showme:compile
|
||||||
|
Do not invoke the underlying @LANGUAGE@ compiler. Instead, show the
|
||||||
|
compiler flags that would be supplied to the @LANGUAGE@ compiler.
|
||||||
|
.TP
|
||||||
|
-showme:link
|
||||||
|
Do not invoke the underlying @LANGUAGE@ compiler. Instead, show the linker
|
||||||
|
flags that would be supplied to the @LANGUAGE@ compiler.
|
||||||
|
.PP
|
||||||
|
See the man page for your underlying compiler for other options that
|
||||||
|
can be passed through @COMMAND@
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.PP
|
||||||
|
Conceptually, the role of these commands is quite simple:
|
||||||
|
transparently add relevant compiler and linker flags to the user's
|
||||||
|
command line that are necessary to compile / link @PROJECT@
|
||||||
|
programs, and then invoke the underlying compiler to actually perform
|
||||||
|
the command.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
As such, these commands are frequently referred to as "wrapper"
|
||||||
|
compilers because they do not actually compile or link applications
|
||||||
|
themselves; they only add in command line flags and invoke the
|
||||||
|
back-end compiler.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SS Background
|
||||||
|
Open MPI is comprised of three software layers: OPAL (Open Portable
|
||||||
|
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
||||||
|
There are wrapper compilers for each layer; each layer's wrapper only
|
||||||
|
links in the libraries relevant for that layer. Specifically, each
|
||||||
|
layer provides the following wrapper compilers:
|
||||||
|
.
|
||||||
|
.TP 4
|
||||||
|
OPAL
|
||||||
|
\fIopalcc\fR and \fIopalc++\fR
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
ORTE
|
||||||
|
\fIortecc\fR and \fIortec++\fR
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
OMPI
|
||||||
|
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
||||||
|
case-senstive file systems), \fImpif77\fR, and \fImpif90\fR. Note
|
||||||
|
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
||||||
|
underlying C++ compiler with the same options. All are provided as
|
||||||
|
compatibility with other MPI implementations.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
The Fortran wrapper compilers for MPI (\fImpif77\fR and \fImpif90\fR)
|
||||||
|
will be inoperative and will return an error on use if Fortran 77 /
|
||||||
|
Fortran 90 support was not built into the MPI layer.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SS Overview
|
||||||
|
\fI@COMMAND@\fR is a convenience wrappers for the underlying
|
||||||
|
@LANGUAGE@ compiler. Translation of an @PROJECT@ program requires the
|
||||||
|
linkage of the @PROJECT@-specific libraries which may not reside in
|
||||||
|
one of the standard search directories of ld(1). It also often
|
||||||
|
requires the inclusion of header files what may also not be found in a
|
||||||
|
standard location.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
\fI@COMMAND@\fR passes its arguments to the underlying @LANGUAGE@
|
||||||
|
compiler along with the -I, -L and -l options required by @PROJECT@
|
||||||
|
programs.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
The @PROJECT@ Team \fIstrongly\fR encourages using the wrapper
|
||||||
|
compilers instead of attempting to link to the @PROJECT@ libraries
|
||||||
|
manually. This allows the specific implementation of @PROJECT@ to
|
||||||
|
change without forcing changes to linker directives in users'
|
||||||
|
Makefiles. Indeed, the specific set of flags and libraries used by
|
||||||
|
the wrapper compilers depends on how @PROJECT@ was configured and
|
||||||
|
built; the values can change between different installations of the
|
||||||
|
same version of @PROJECT@.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Indeed, since the wrappers are simply thin shells on top of an
|
||||||
|
underlying compiler, there are very, very few compelling reasons
|
||||||
|
\fInot\fR to use \fI@COMMAND@\fR. When it is not possible to use the
|
||||||
|
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
||||||
|
options should be used to determine what flags the wrappers would have
|
||||||
|
used. For example:
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
shell$ cc -c file1.c `mpicc -showme:compile`
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
shell$ cc -c file2.c `mpicc -showme:compile`
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH NOTES
|
||||||
|
.PP
|
||||||
|
It is possible to make the wrapper compilers multi-lib aware. That
|
||||||
|
is, the libraries and includes specified may differ based on the
|
||||||
|
compiler flags specified (for example, with the GNU compilers on
|
||||||
|
Linux, a different library path may be used if -m32 is seen versus
|
||||||
|
-m64 being seen). This is not the default behavior in a standard
|
||||||
|
build, but can be activated (for example, in a binary package
|
||||||
|
providing both 32 and 64 bit support). More information can be found
|
||||||
|
at:
|
||||||
|
.PP
|
||||||
|
https://svn.open-mpi.org/trac/ompi/wiki/compilerwrapper3264
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH FILES
|
||||||
|
.PP
|
||||||
|
The string that the wrapper compilers insert into the command line
|
||||||
|
before invoking the underlying compiler are stored in a text file
|
||||||
|
created by @PROJECT@ and installed to
|
||||||
|
\fI$pkgdata/@COMMAND@-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
||||||
|
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
||||||
|
installation directory of @PROJECT@.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
It is rarely necessary to edit this file, but it can be examined to
|
||||||
|
gain insight into what flags the wrappers are placing on the command
|
||||||
|
line.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.SH ENVIRONMENT VARIABLES
|
||||||
|
.PP
|
||||||
|
By default, the wrappers use the compilers that were selected when
|
||||||
|
@PROJECT@ was configured. These compilers were either found
|
||||||
|
automatically by Open MPI's "configure" script, or were selected by
|
||||||
|
the user in the CC, CXX, F77, and/or FC environment variables
|
||||||
|
before "configure" was invoked. Additionally, other arguments
|
||||||
|
specific to the compiler may have been selected by configure.
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
These values can be selectively overridden by either editing the text
|
||||||
|
files containing this configuration information (see the \fBFILES\fR
|
||||||
|
section), or by setting selected environment variables of the
|
||||||
|
form "@PROJECT_SHORT@_value".
|
||||||
|
.
|
||||||
|
.PP
|
||||||
|
Valid value names are:
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
CPPFLAGS
|
||||||
|
Flags added when invoking the preprocessor (C or C++)
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
LDFLAGS
|
||||||
|
Flags added when invoking the linker (C, C++, or Fortran)
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
LIBS
|
||||||
|
Libraries added when invoking the linker (C, C++, or Fortran)
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
CC
|
||||||
|
C compiler
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
CFLAGS
|
||||||
|
C compiler flags
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
CXX
|
||||||
|
C++ compiler
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
CXXFLAGS
|
||||||
|
C++ compiler flags
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
F77
|
||||||
|
Fortran 77 compiler
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
FFLAGS
|
||||||
|
Fortran 77 compiler flags
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
FC
|
||||||
|
Fortran 90 compiler
|
||||||
|
.
|
||||||
|
.TP
|
||||||
|
FCFLAGS
|
||||||
|
Fortran 90 compiler flags
|
@ -1,208 +1,73 @@
|
|||||||
.TH @COMMAND@ 1 "@PROJECT@" "@PROJECT_SHORT@" "@PROJECT@"
|
.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
|
||||||
.
|
.\" and released under the BSD license
|
||||||
|
.TH OPAL_WRAPPER 1 "July 2006" "Open MPI" "OPEN MPI COMMANDS"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
@COMMAND@ -- @PROJECT@ @LANGUAGE@ wrapper compiler
|
opal_wrapper - Back-end Open MPI wrapper command
|
||||||
.
|
.SH SYNOPSIS
|
||||||
.SH SYNTAX
|
.B opal_wrapper [options]
|
||||||
@COMMAND@ [-showme|-showme:compile|-showme:link] ...
|
|
||||||
.
|
|
||||||
.SH OPTIONS
|
|
||||||
.TP
|
|
||||||
-showme
|
|
||||||
Do not invoke the underlying compiler. Instead, show the command line
|
|
||||||
that would be executed to compile the program. \fBNOTE:\fR If a
|
|
||||||
non-filename argument is passed on the command line, the \fI-showme\fR
|
|
||||||
option will \fInot\fR display any additional flags. For example, both
|
|
||||||
"@COMMAND@ --showme" and "@COMMAND@ --showme my_source.c" will show all the
|
|
||||||
wrapper-supplied flags. But "@COMMAND@ -showme -v" will only show the
|
|
||||||
underlying compiler name and "-v".
|
|
||||||
.TP
|
|
||||||
-showme:compile
|
|
||||||
Do not invoke the underlying @LANGUAGE@ compiler. Instead, show the
|
|
||||||
compiler flags that would be supplied to the @LANGUAGE@ compiler.
|
|
||||||
.TP
|
|
||||||
-showme:link
|
|
||||||
Do not invoke the underlying @LANGUAGE@ compiler. Instead, show the linker
|
|
||||||
flags that would be supplied to the @LANGUAGE@ compiler.
|
|
||||||
.PP
|
|
||||||
See the man page for your underlying compiler for other options that
|
|
||||||
can be passed through @COMMAND@
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
.PP
|
.PP
|
||||||
Conceptually, the role of these commands is quite simple:
|
.B opal_wrapper
|
||||||
transparently add relevant compiler and linker flags to the user's
|
is not meant to be called directly by end users. It is automatically
|
||||||
command line that are necessary to compile / link @PROJECT@
|
invoked as the back-end by the Open MPI wrapper commands such as:
|
||||||
programs, and then invoke the underlying compiler to actually perform
|
.BR mpicc ,
|
||||||
the command.
|
.BR mpiCC ,
|
||||||
.
|
.BR mpic++ ,
|
||||||
|
.BR mpif77 ,
|
||||||
|
and
|
||||||
|
.BR mpif90 .
|
||||||
.PP
|
.PP
|
||||||
As such, these commands are frequently referred to as "wrapper"
|
Some Open MPI installations may have additional wrapper commands,
|
||||||
compilers because they do not actually compile or link applications
|
and/or have renamed the wrapper compilers listed above to avoid
|
||||||
themselves; they only add in command line flags and invoke the
|
executable name conflicts with other MPI implementations. Hence, you
|
||||||
back-end compiler.
|
may also have wrapper compilers installed including the following
|
||||||
|
names:
|
||||||
|
.BR mpif90.openmpi ,
|
||||||
|
.BR mpif77.openmpi ,
|
||||||
|
.BR mpicxx.openmpi ,
|
||||||
|
.BR mpiCC.openmpi ,
|
||||||
|
.BR mpicc.openmpi ,
|
||||||
|
.BR mpic++.openmpi ,
|
||||||
|
.BR opalcc ,
|
||||||
|
.BR opalc++ ,
|
||||||
|
.BR ortecc ,
|
||||||
|
and
|
||||||
|
.BR ortec++ ,
|
||||||
.
|
.
|
||||||
.
|
.
|
||||||
.SS Background
|
.\" **************************
|
||||||
Open MPI is comprised of three software layers: OPAL (Open Portable
|
.\" See Also Section
|
||||||
Access Layer), ORTE (Open Run-Time Environment), and OMPI (Open MPI).
|
.\" **************************
|
||||||
There are wrapper compilers for each layer; each layer's wrapper only
|
.SH SEE ALSO
|
||||||
links in the libraries relevant for that layer. Specifically, each
|
The following may exist depending on your particular Open MPI
|
||||||
layer provides the following wrapper compilers:
|
installation:
|
||||||
|
.BR mpicc (1),
|
||||||
|
.BR mpiCC (1),
|
||||||
|
.BR mpic++ (1),
|
||||||
|
.BR mpif77 (1),
|
||||||
|
.BR mpif90 (1),
|
||||||
|
.BR mpif90.openmpi (1),
|
||||||
|
.BR mpif77.openmpi (1),
|
||||||
|
.BR mpicxx.openmpi (1),
|
||||||
|
.BR mpiCC.openmpi (1),
|
||||||
|
.BR mpicc.openmpi (1),
|
||||||
|
.BR mpic++.openmpi (1),
|
||||||
|
.BR ortecc (1),
|
||||||
|
.BR ortec++ (1),
|
||||||
|
.BR opalccc (1),
|
||||||
|
and the website at
|
||||||
|
.IR http://www.openmpi.org/ .
|
||||||
.
|
.
|
||||||
.TP 4
|
|
||||||
OPAL
|
|
||||||
\fIopalcc\fR and \fIopalc++\fR
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
ORTE
|
|
||||||
\fIortecc\fR and \fIortec++\fR
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
OMPI
|
|
||||||
\fImpicc\fR, \fImpic++\fR, \fImpicxx\fR, \fImpiCC\fR (only on systems with
|
|
||||||
case-senstive file systems), \fImpif77\fR, and \fImpif90\fR. Note
|
|
||||||
that \fImpic++\fR, \fImpicxx\fR, and \fImpiCC\fR all invoke the same
|
|
||||||
underlying C++ compiler with the same options. All are provided as
|
|
||||||
compatibility with other MPI implementations.
|
|
||||||
.
|
.
|
||||||
|
.\" **************************
|
||||||
|
.\" Authors Section
|
||||||
|
.\" **************************
|
||||||
|
.SH AUTHORS
|
||||||
|
The Open MPI maintainers -- see
|
||||||
|
.I http://www.openmpi.org/
|
||||||
|
or the file
|
||||||
|
.IR AUTHORS .
|
||||||
.PP
|
.PP
|
||||||
The Fortran wrapper compilers for MPI (\fImpif77\fR and \fImpif90\fR)
|
This manual page was originally contributed by Dirk Eddelbuettel
|
||||||
will be inoperative and will return an error on use if Fortran 77 /
|
<edd@debian.org>, one of the Debian GNU/Linux maintainers for Open
|
||||||
Fortran 90 support was not built into the MPI layer.
|
MPI, and may be used by others.
|
||||||
.
|
|
||||||
.
|
|
||||||
.SS Overview
|
|
||||||
\fI@COMMAND@\fR is a convenience wrappers for the underlying
|
|
||||||
@LANGUAGE@ compiler. Translation of an @PROJECT@ program requires the
|
|
||||||
linkage of the @PROJECT@-specific libraries which may not reside in
|
|
||||||
one of the standard search directories of ld(1). It also often
|
|
||||||
requires the inclusion of header files what may also not be found in a
|
|
||||||
standard location.
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
\fI@COMMAND@\fR passes its arguments to the underlying @LANGUAGE@
|
|
||||||
compiler along with the -I, -L and -l options required by @PROJECT@
|
|
||||||
programs.
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
The @PROJECT@ Team \fIstrongly\fR encourages using the wrapper
|
|
||||||
compilers instead of attempting to link to the @PROJECT@ libraries
|
|
||||||
manually. This allows the specific implementation of @PROJECT@ to
|
|
||||||
change without forcing changes to linker directives in users'
|
|
||||||
Makefiles. Indeed, the specific set of flags and libraries used by
|
|
||||||
the wrapper compilers depends on how @PROJECT@ was configured and
|
|
||||||
built; the values can change between different installations of the
|
|
||||||
same version of @PROJECT@.
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
Indeed, since the wrappers are simply thin shells on top of an
|
|
||||||
underlying compiler, there are very, very few compelling reasons
|
|
||||||
\fInot\fR to use \fI@COMMAND@\fR. When it is not possible to use the
|
|
||||||
wrappers directly, the \fI-showme:compile\fR and \fI-showme:link\fR
|
|
||||||
options should be used to determine what flags the wrappers would have
|
|
||||||
used. For example:
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
shell$ cc -c file1.c `mpicc -showme:compile`
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
shell$ cc -c file2.c `mpicc -showme:compile`
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
shell$ cc file1.o file2.o `mpicc -showme:link` -o my_mpi_program
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.SH NOTES
|
|
||||||
.PP
|
|
||||||
It is possible to make the wrapper compilers multi-lib aware. That
|
|
||||||
is, the libraries and includes specified may differ based on the
|
|
||||||
compiler flags specified (for example, with the GNU compilers on
|
|
||||||
Linux, a different library path may be used if -m32 is seen versus
|
|
||||||
-m64 being seen). This is not the default behavior in a standard
|
|
||||||
build, but can be activated (for example, in a binary package
|
|
||||||
providing both 32 and 64 bit support). More information can be found
|
|
||||||
at:
|
|
||||||
.PP
|
|
||||||
https://svn.open-mpi.org/trac/ompi/wiki/compilerwrapper3264
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.SH FILES
|
|
||||||
.PP
|
|
||||||
The string that the wrapper compilers insert into the command line
|
|
||||||
before invoking the underlying compiler are stored in a text file
|
|
||||||
created by @PROJECT@ and installed to
|
|
||||||
\fI$pkgdata/@COMMAND@-wrapper-data.txt\fR, where \fI$pkgdata\fR
|
|
||||||
is typically \fI$prefix/share/openmpi\fR, and \fI$prefix\fR is the top
|
|
||||||
installation directory of @PROJECT@.
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
It is rarely necessary to edit this file, but it can be examined to
|
|
||||||
gain insight into what flags the wrappers are placing on the command
|
|
||||||
line.
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.SH ENVIRONMENT VARIABLES
|
|
||||||
.PP
|
|
||||||
By default, the wrappers use the compilers that were selected when
|
|
||||||
@PROJECT@ was configured. These compilers were either found
|
|
||||||
automatically by Open MPI's "configure" script, or were selected by
|
|
||||||
the user in the CC, CXX, F77, and/or FC environment variables
|
|
||||||
before "configure" was invoked. Additionally, other arguments
|
|
||||||
specific to the compiler may have been selected by configure.
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
These values can be selectively overridden by either editing the text
|
|
||||||
files containing this configuration information (see the \fBFILES\fR
|
|
||||||
section), or by setting selected environment variables of the
|
|
||||||
form "@PROJECT_SHORT@_value".
|
|
||||||
.
|
|
||||||
.PP
|
|
||||||
Valid value names are:
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
CPPFLAGS
|
|
||||||
Flags added when invoking the preprocessor (C or C++)
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
LDFLAGS
|
|
||||||
Flags added when invoking the linker (C, C++, or Fortran)
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
LIBS
|
|
||||||
Libraries added when invoking the linker (C, C++, or Fortran)
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
CC
|
|
||||||
C compiler
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
CFLAGS
|
|
||||||
C compiler flags
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
CXX
|
|
||||||
C++ compiler
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
CXXFLAGS
|
|
||||||
C++ compiler flags
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
F77
|
|
||||||
Fortran 77 compiler
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
FFLAGS
|
|
||||||
Fortran 77 compiler flags
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
FC
|
|
||||||
Fortran 90 compiler
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
FCFLAGS
|
|
||||||
Fortran 90 compiler flags
|
|
||||||
|
@ -9,6 +9,7 @@
|
|||||||
# University of Stuttgart. All rights reserved.
|
# University of Stuttgart. All rights reserved.
|
||||||
# Copyright (c) 2004-2005 The Regents of the University of California.
|
# Copyright (c) 2004-2005 The Regents of the University of California.
|
||||||
# All rights reserved.
|
# All rights reserved.
|
||||||
|
# Copyright (c) 2007 Cisco, Inc. All rights reserved.
|
||||||
# $COPYRIGHT$
|
# $COPYRIGHT$
|
||||||
#
|
#
|
||||||
# Additional copyrights may follow
|
# Additional copyrights may follow
|
||||||
@ -30,6 +31,10 @@ libs = \
|
|||||||
headers = \
|
headers = \
|
||||||
orted.h
|
orted.h
|
||||||
|
|
||||||
|
man_MANS = orted.1
|
||||||
|
|
||||||
|
EXTRA_DIST = $(man_MANS)
|
||||||
|
|
||||||
orted_SOURCES = \
|
orted_SOURCES = \
|
||||||
$(headers) \
|
$(headers) \
|
||||||
orted_comm.c \
|
orted_comm.c \
|
||||||
|
45
orte/tools/orted/orted.1
Обычный файл
45
orte/tools/orted/orted.1
Обычный файл
@ -0,0 +1,45 @@
|
|||||||
|
.\" Man page contributed by Dirk Eddelbuettel <edd@debian.org>
|
||||||
|
.\" and released under the BSD license.
|
||||||
|
.TH ORTED 1 "July 2006" "Open MPI" "OPEN MPI COMMANDS"
|
||||||
|
.SH NAME
|
||||||
|
orted - Start an Open RTE User-Level Daemon
|
||||||
|
.SH SYNOPSIS
|
||||||
|
.B orted [options]
|
||||||
|
.SH DESCRIPTION
|
||||||
|
.PP
|
||||||
|
.B orted
|
||||||
|
starts an Open RTE daemon for the Open MPI system.
|
||||||
|
.SH NOTE
|
||||||
|
The
|
||||||
|
.B orted
|
||||||
|
command is
|
||||||
|
.I not intended to be manually invoked by end users.
|
||||||
|
.
|
||||||
|
It is part of the Open MPI architecture and is invoked automatically
|
||||||
|
as necessary. This man page is mainly intended for those adventerous
|
||||||
|
end users and system administrators who have noticed an "orted"
|
||||||
|
process and wondered what it is.
|
||||||
|
.PP
|
||||||
|
As such, the command line options accepted by the
|
||||||
|
.B orted
|
||||||
|
are not listed below because they are considered internal and are
|
||||||
|
therefore subject to change between versions without warning.
|
||||||
|
Running
|
||||||
|
.B orted
|
||||||
|
with the
|
||||||
|
.I --help
|
||||||
|
command line option will show all available options.
|
||||||
|
.
|
||||||
|
.
|
||||||
|
.\" **************************
|
||||||
|
.\" Authors Section
|
||||||
|
.\" **************************
|
||||||
|
.SH AUTHORS
|
||||||
|
The Open MPI maintainers -- see
|
||||||
|
.I http://www.openmpi.org/
|
||||||
|
or the file
|
||||||
|
.IR AUTHORS .
|
||||||
|
.PP
|
||||||
|
This manual page was originally contributed by Dirk Eddelbuettel
|
||||||
|
<edd@debian.org>, one of the Debian GNU/Linux maintainers for Open
|
||||||
|
MPI, and may be used by others.
|
@ -9,7 +9,7 @@
|
|||||||
# University of Stuttgart. All rights reserved.
|
# University of Stuttgart. All rights reserved.
|
||||||
# Copyright (c) 2004-2005 The Regents of the University of California.
|
# Copyright (c) 2004-2005 The Regents of the University of California.
|
||||||
# All rights reserved.
|
# All rights reserved.
|
||||||
# Copyright (c) 2006 Cisco Systems, Inc. All rights reserved.
|
# Copyright (c) 2006-2007 Cisco Systems, Inc. All rights reserved.
|
||||||
# $COPYRIGHT$
|
# $COPYRIGHT$
|
||||||
#
|
#
|
||||||
# Additional copyrights may follow
|
# Additional copyrights may follow
|
||||||
@ -49,10 +49,10 @@ endif # WANT_INSTALL_HEADERS
|
|||||||
maintainer-clean-local:
|
maintainer-clean-local:
|
||||||
rm -f ortecc.1 ortec++.1
|
rm -f ortecc.1 ortec++.1
|
||||||
|
|
||||||
ortecc.1: $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1
|
ortecc.1: $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1
|
||||||
rm -f ortecc.1
|
rm -f ortecc.1
|
||||||
sed -e 's/@COMMAND@/ortecc/g' -e 's/@PROJECT@/OpenRTE/g' -e 's/@PROJECT_SHORT@/ORTE/g' -e 's/@LANGUAGE@/C/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > ortecc.1
|
sed -e 's/@COMMAND@/ortecc/g' -e 's/@PROJECT@/OpenRTE/g' -e 's/@PROJECT_SHORT@/ORTE/g' -e 's/@LANGUAGE@/C/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > ortecc.1
|
||||||
|
|
||||||
ortec++.1: $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1
|
ortec++.1: $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1
|
||||||
rm -f ortec++.1
|
rm -f ortec++.1
|
||||||
sed -e 's/@COMMAND@/ortec++/g' -e 's/@PROJECT@/OpenRTE/g' -e 's/@PROJECT_SHORT@/ORTE/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/opal_wrapper.1 > ortec++.1
|
sed -e 's/@COMMAND@/ortec++/g' -e 's/@PROJECT@/OpenRTE/g' -e 's/@PROJECT_SHORT@/ORTE/g' -e 's/@LANGUAGE@/C++/g' < $(top_srcdir)/opal/tools/wrappers/generic_wrapper.1 > ortec++.1
|
||||||
|
Загрузка…
x
Ссылка в новой задаче
Block a user