diff --git a/ompi/mpi/man/man3/MPI_Comm_spawn.3in b/ompi/mpi/man/man3/MPI_Comm_spawn.3in index 4d6cb9272d..b005c19ee7 100644 --- a/ompi/mpi/man/man3/MPI_Comm_spawn.3in +++ b/ompi/mpi/man/man3/MPI_Comm_spawn.3in @@ -111,64 +111,79 @@ For the SPAWN calls, \fIinfo\fP provides additional, implementation-dependent in The following keys for \fIinfo\fP are recognized in Open MPI. (The reserved values mentioned in Section 5.3.4 of the MPI-2 standard are not implemented.) .sp .nf -Key Type Description ---- ---- ----------- +Key Type Description +--- ---- ----------- -host char * Host on which the process should be spawned. - See the \fIorte_host\fP man page for an - explanation of how this will be used. -hostfile char * Hostfile containing the hosts on which - the processes are to be spawned. See - the \fIorte_hostfile\fP man page for an - explanation of how this will be used. -add-host char * Add the specified host to the list of - hosts known to this job and use it - for the associated process. This will - be used similarly to the -host option. -add-hostfile char * Hostfile containing hosts to be added - to the list of hosts known to this job and - use it for the associated process. This will - be used similarly to the -hostfile option. -wdir char * Directory where the executable is located. If - files are to be pre-positioned, then this - location is the desired working directory - at time of execution - if not specified, - then it will automatically be set to - \fIompi_preload_files_dest_dir\fP. -ompi_prefix char * Same as the --prefix command line argument - to mpirun. -ompi_local_slave bool If set to true, launch the specified process - as a local \fIslave\fP to the calling process. - The new process will only be known to the caller, - and will only be able to communicate with the caller. -ompi_preload_binary bool If set to true, pre-position the specified - executable onto the remote host. A destination - directory must also be provided. -ompi_preload_files_dest_dir char * Target directory where pre-positioned files - are to be placed. -ompi_preload_files char * A comma-separated list of files that are to - be pre-positioned in addition to the executable. - Note that this option does not depend upon - \fIompi_preload_binary\fP - files can be moved - to the target even if an executable is not moved. -ompi_preload_files_src_dir char * Source directory where files and executables - that are to be pre-positioned can be found. If - not specified, the current working directory - will be used. -ompi_non_mpi bool If set to true, launching a non-MPI - application; the returned communicator - will be MPI_COMM_NULL. Failure to set - this flag when launching a non-MPI - application will cause both the child - and parent jobs to "hang". -ompi_param char * Pass an OMPI MCA parameter to the child job. - If that parameter already exists in the - environment, the value will be overwritten - by the provided value. -map_bynode bool If set to true, the processes are mapped bynode. - If set to false, the processes are mapped byslot. - By default, mapping is determined by the default - mapping policy set when the job was started. +host char * Host on which the process should be + spawned. See the \fIorte_host\fP man + page for an explanation of how this + will be used. +hostfile char * Hostfile containing the hosts on which + the processes are to be spawned. See + the \fIorte_hostfile\fP man page for + an explanation of how this will be + used. +add-host char * Add the specified host to the list of + hosts known to this job and use it for + the associated process. This will be + used similarly to the -host option. +add-hostfile char * Hostfile containing hosts to be added + to the list of hosts known to this job + and use it for the associated + process. This will be used similarly + to the -hostfile option. +wdir char * Directory where the executable is + located. If files are to be + pre-positioned, then this location is + the desired working directory at time + of execution - if not specified, then + it will automatically be set to + \fIompi_preload_files_dest_dir\fP. +ompi_prefix char * Same as the --prefix command line + argument to mpirun. +ompi_local_slave bool If set to true, launch the specified + process as a local \fIslave\fP to the + calling process. The new process will + only be known to the caller, and will + only be able to communicate with the + caller. +ompi_preload_binary bool If set to true, pre-position the + specified executable onto the remote + host. A destination directory must + also be provided. +ompi_preload_files_dest_dir + char * Target directory where pre-positioned + files are to be placed. +ompi_preload_files char * A comma-separated list of files that + are to be pre-positioned in addition + to the executable. Note that this + option does not depend upon + \fIompi_preload_binary\fP - files can + be moved to the target even if an + executable is not moved. +ompi_preload_files_src_dir + char * Source directory where files and + executables that are to be + pre-positioned can be found. If not + specified, the current working + directory will be used. +ompi_non_mpi bool If set to true, launching a non-MPI + application; the returned communicator + will be MPI_COMM_NULL. Failure to set + this flag when launching a non-MPI + application will cause both the child + and parent jobs to "hang". +ompi_param char * Pass an OMPI MCA parameter to the + child job. If that parameter already + exists in the environment, the value + will be overwritten by the provided + value. +map_bynode bool If set to true, the processes are + mapped bynode. If set to false, the + processes are mapped byslot. By + default, mapping is determined by the + default mapping policy set when the + job was started. .fi \fIbool\fP info keys are actually strings but are evaluated as diff --git a/ompi/mpi/man/man3/MPI_Comm_spawn_multiple.3in b/ompi/mpi/man/man3/MPI_Comm_spawn_multiple.3in index 6b7d0585e0..0fb0084d9f 100644 --- a/ompi/mpi/man/man3/MPI_Comm_spawn_multiple.3in +++ b/ompi/mpi/man/man3/MPI_Comm_spawn_multiple.3in @@ -119,64 +119,79 @@ The following keys for \fIinfo\fP are recognized in "#PACKAGE_NAME#". (The reser .sp .sp .nf -Key Type Description ---- ---- ----------- +Key Type Description +--- ---- ----------- -host char * Host on which the process should be spawned. - See the \fIorte_host\fP man page for an - explanation of how this will be used. -hostfile char * Hostfile containing the hosts on which - the processes are to be spawned. See - the \fIorte_hostfile\fP man page for an - explanation of how this will be used. -add-host char * Add the specified host to the list of - hosts known to this job and use it - for the associated processes. This will - be used similarly to the -host option. -add-hostfile char * Hostfile containing hosts to be added - to the list of hosts known to this job and - use it for the associated processes. This will - be used similarly to the -hostfile option. -wdir char * Directory where the executable is located. If - files are to be pre-positioned, then this - location is the desired working directory - at time of execution - if not specified, - then it will automatically be set to - \fIompi_preload_files_dest_dir\fP. -ompi_prefix char * Same as the --prefix command line argument - to mpirun. -ompi_local_slave bool If set to true, launch the specified process - as a local \fIslave\fP to the calling process. - The new process will only be known to the caller, - and will only be able to communicate with the caller. -ompi_preload_binary bool If set to true, pre-position the specified - executable onto the remote host. A destination - directory must also be provided. -ompi_preload_files_dest_dir char * Target directory where pre-positioned files - are to be placed. -ompi_preload_files char * A comma-separated list of files that are to - be pre-positioned in addition to the executable. - Note that this option does not depend upon - \fIompi_preload_binary\fP - files can be moved - to the target even if an executable is not moved. -ompi_preload_files_src_dir char * Source directory where files and executables - that are to be pre-positioned can be found. If - not specified, the current working directory - will be used. -ompi_non_mpi bool If set to true, launching a non-MPI - application; the returned communicator - will be MPI_COMM_NULL. Failure to set - this flag when launching a non-MPI - application will cause both the child - and parent jobs to "hang". -ompi_param char * Pass an OMPI MCA parameter to the child job. - If that parameter already exists in the - environment, the value will be overwritten - by the provided value. -map_bynode bool If set to true, the processes are mapped bynode. - If set to false, the processes are mapped byslot. - By default, mapping is determined by the default - mapping policy set when the job was started. +host char * Host on which the process should be + spawned. See the \fIorte_host\fP man + page for an explanation of how this + will be used. +hostfile char * Hostfile containing the hosts on which + the processes are to be spawned. See + the \fIorte_hostfile\fP man page for + an explanation of how this will be + used. +add-host char * Add the specified host to the list of + hosts known to this job and use it for + the associated process. This will be + used similarly to the -host option. +add-hostfile char * Hostfile containing hosts to be added + to the list of hosts known to this job + and use it for the associated + process. This will be used similarly + to the -hostfile option. +wdir char * Directory where the executable is + located. If files are to be + pre-positioned, then this location is + the desired working directory at time + of execution - if not specified, then + it will automatically be set to + \fIompi_preload_files_dest_dir\fP. +ompi_prefix char * Same as the --prefix command line + argument to mpirun. +ompi_local_slave bool If set to true, launch the specified + process as a local \fIslave\fP to the + calling process. The new process will + only be known to the caller, and will + only be able to communicate with the + caller. +ompi_preload_binary bool If set to true, pre-position the + specified executable onto the remote + host. A destination directory must + also be provided. +ompi_preload_files_dest_dir + char * Target directory where pre-positioned + files are to be placed. +ompi_preload_files char * A comma-separated list of files that + are to be pre-positioned in addition + to the executable. Note that this + option does not depend upon + \fIompi_preload_binary\fP - files can + be moved to the target even if an + executable is not moved. +ompi_preload_files_src_dir + char * Source directory where files and + executables that are to be + pre-positioned can be found. If not + specified, the current working + directory will be used. +ompi_non_mpi bool If set to true, launching a non-MPI + application; the returned communicator + will be MPI_COMM_NULL. Failure to set + this flag when launching a non-MPI + application will cause both the child + and parent jobs to "hang". +ompi_param char * Pass an OMPI MCA parameter to the + child job. If that parameter already + exists in the environment, the value + will be overwritten by the provided + value. +map_bynode bool If set to true, the processes are + mapped bynode. If set to false, the + processes are mapped byslot. By + default, mapping is determined by the + default mapping policy set when the + job was started. .fi .sp