openmpi/orte/tools/orte-top/help-orte-top.txt

# -*- text -*-
#
# Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
#                         University Research and Technology
#                         Corporation.  All rights reserved.
# Copyright (c) 2004-2005 The University of Tennessee and The University
#                         of Tennessee Research Foundation.  All rights
#                         reserved.
# Copyright (c) 2004-2005 High Performance Computing Center Stuttgart, 
#                         University of Stuttgart.  All rights reserved.
# Copyright (c) 2004-2005 The Regents of the University of California.
#                         All rights reserved.
# $COPYRIGHT$
# 
# Additional copyrights may follow
# 
# $HEADER$
#
# This is the US/English general help file for Open MPI's orte-top tool.
#
[orte-top]
Return statistics on specified process ranks

Usage: %s [OPTIONS]

%s
#
[orte-top:pid-not-found]
We could not find an mpirun matching the provided pid on this machine.

Pid provided: %d

#
[orte-top:pid-required]
This tool requires that you specify contact info for the mpirun executing
the specified rank(s). Please use the --help option for more information.

#
[orte-top:hnp-filename-bad]
We are unable to parse the filename where contact info for the
mpirun to be contacted was to be found. The option we were given was:

--%s %s

This appears to be missing the required ':' following the
keyword "file". Please use the --help option for more information on
the correct format for this command line option.
#
orte-top:hnp-filename-access]
We are unable to access the filename where contact info for the
mpirun to be contacted was to be found. The filename we were given was:

File: %s

Please use the --help option for more information on
the correct format for this command line option.
#
[orte-top:hnp-file-bad]
We are unable to read the mpirun's contact info from the
given filename. The filename we were given was:

FILE: %s

Please use the --help option for more information on
the correct format for this command line option.
#
[orte-top:hnp-uri-bad]
We are unable to correctly parse the mpirun's contact info. The uri we were given was:

URI: %s

Please remember that this is *not* a standard uri, but
a special format used internally by Open MPI for communications. It can
best be generated by simply directing mpirun to put its
uri in a file, and then giving us that filename.
Per the earlier RFC and some discussion at the Dec ORTE design meeting, add the ompi-top tool and all its supporting infrastructure. This includes a new OPAL pstat framework and data type, currently with rather weak support for Mac OSX and pretty complete support for Linux. The Sun team promised to add Solaris support as well. Also, per chat with Jeff, modified the Makefile.am's of a few orte tools so that they were consistent in the way we generate the ompi-equivalent cmds. This commit was SVN r20165. 2008-12-22 23:23:05 +03:00			`# -- text --`
			`#`
			`# Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana`
			`# University Research and Technology`
			`# Corporation. All rights reserved.`
			`# Copyright (c) 2004-2005 The University of Tennessee and The University`
			`# of Tennessee Research Foundation. All rights`
			`# reserved.`
			`# Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,`
			`# University of Stuttgart. All rights reserved.`
			`# Copyright (c) 2004-2005 The Regents of the University of California.`
			`# All rights reserved.`
			`# $COPYRIGHT$`
			`#`
			`# Additional copyrights may follow`
			`#`
			`# $HEADER$`
			`#`
			`# This is the US/English general help file for Open MPI's orte-top tool.`
			`#`
			`[orte-top]`
			`Return statistics on specified process ranks`

			`Usage: %s [OPTIONS]`

			`%s`
			`#`
			`[orte-top:pid-not-found]`
			`We could not find an mpirun matching the provided pid on this machine.`

			`Pid provided: %d`

			`#`
			`[orte-top:pid-required]`
Per request from Aurelien, make orterun report-pid and report-uri functions work the same as that of ompi-server. Since these are used for ompi-server-like functionality, it makes sense that the report options work the same. Make orte-top take the corresponding input the same way too for consistency. The modified cmd line options are: --report-uri x where x is either '-' for stdout, '+' for stderr, or a filename --report-pid x where x is the same as above For orte-top, you can now provide either a pid or a uri (which allows connection to remote mpiruns), specified either directly or with a "file:x" option as per mpirun's ompi-server option. Note: I did not add a report-pid option to ompi-server as it probably wouldn't be useful - the report-uri option works as well, and allows remote access (which is likely the normal way it would be used). This commit was SVN r20168. 2008-12-24 18:27:46 +03:00			`This tool requires that you specify contact info for the mpirun executing`
Per the earlier RFC and some discussion at the Dec ORTE design meeting, add the ompi-top tool and all its supporting infrastructure. This includes a new OPAL pstat framework and data type, currently with rather weak support for Mac OSX and pretty complete support for Linux. The Sun team promised to add Solaris support as well. Also, per chat with Jeff, modified the Makefile.am's of a few orte tools so that they were consistent in the way we generate the ompi-equivalent cmds. This commit was SVN r20165. 2008-12-22 23:23:05 +03:00			`the specified rank(s). Please use the --help option for more information.`

Per request from Aurelien, make orterun report-pid and report-uri functions work the same as that of ompi-server. Since these are used for ompi-server-like functionality, it makes sense that the report options work the same. Make orte-top take the corresponding input the same way too for consistency. The modified cmd line options are: --report-uri x where x is either '-' for stdout, '+' for stderr, or a filename --report-pid x where x is the same as above For orte-top, you can now provide either a pid or a uri (which allows connection to remote mpiruns), specified either directly or with a "file:x" option as per mpirun's ompi-server option. Note: I did not add a report-pid option to ompi-server as it probably wouldn't be useful - the report-uri option works as well, and allows remote access (which is likely the normal way it would be used). This commit was SVN r20168. 2008-12-24 18:27:46 +03:00			`#`
			`[orte-top:hnp-filename-bad]`
			`We are unable to parse the filename where contact info for the`
			`mpirun to be contacted was to be found. The option we were given was:`

			`--%s %s`

			`This appears to be missing the required ':' following the`
			`keyword "file". Please use the --help option for more information on`
			`the correct format for this command line option.`
			`#`
			`orte-top:hnp-filename-access]`
			`We are unable to access the filename where contact info for the`
			`mpirun to be contacted was to be found. The filename we were given was:`

			`File: %s`

			`Please use the --help option for more information on`
			`the correct format for this command line option.`
			`#`
			`[orte-top:hnp-file-bad]`
			`We are unable to read the mpirun's contact info from the`
			`given filename. The filename we were given was:`

			`FILE: %s`

			`Please use the --help option for more information on`
			`the correct format for this command line option.`
			`#`
			`[orte-top:hnp-uri-bad]`
			`We are unable to correctly parse the mpirun's contact info. The uri we were given was:`

			`URI: %s`

			`Please remember that this is not a standard uri, but`
			`a special format used internally by Open MPI for communications. It can`
			`best be generated by simply directing mpirun to put its`
			`uri in a file, and then giving us that filename.`