--- lamssi.7 2012-11-07 20:30:00.785018184 +0000 +++ lamssi.7.new 2012-11-07 20:38:47.129656181 +0000 @@ -1,27 +1,27 @@ .TH lamssi 7 "March, 2006" "LAM 7.1.2" "LAM SSI OVERVIEW" .SH NAME -LAM SSI \- introduction to LAM System Services Interface (SSI) +LAM_SSI \- introduction to LAM System Services Interface (SSI) .SH DESCRIPTION The SSI in LAM/MPI is used to select one (or more) system services -interfaces at run-time. +interfaces at run-time. .SH OVERVIEW .PP LAM SSI instances are uniquely described in terms of "kinds" (also referred to as "types") and "modules". .PP The "kind" refers to which set of system services the SSI instance -will apply to. For example, LAM currently has several +will apply to. For example, LAM currently has several kinds: "boot", "coll", "cr" and "rpi". The "module" refers to a specific SSI instance of a given kind. Each kind has o .PP boot modules are used to start the LAM run-time environment (i.e., they provide the back-end functionality to -.IR lamboot (1)). +.IR lamboot (1)). boot modules are discussed further in the lamssi_boot(7) man page. .PP coll modules provide back-end algorithms and functionality for the MPI collective communications. coll modules are described in -lamssi_coll(7). +lamssi_coll(7). .PP cr modules provide checkpoint/restart functionality for MPI jobs. See lamssi_cr(7) for details. @@ -30,24 +30,24 @@ communications. rpi modules are detailed in lamssi_rpi(7). .SH VERBOSE OPERATION .PP -The user can force SSI modules to be verbose by setting the +The user can force SSI modules to be verbose by setting the .I LAM_SSI_ssi_verbose environment variable before invoking .IR mpirun , or by using the -.I -ssi +.I \-ssi command line switch to .IR mpirun . For example: .TP 4 -mpirun -ssi ssi_verbose 1 C foo +mpirun \-ssi ssi_verbose 1 C foo Tell the SSI modules to be verbose, and default to sending their output to stderr. .PP -The +The .I ssi_verbose kind is a "pseudo-kind" in that it is used to pass parameters to the -main SSI meta-glue itself -- not to any particular kind. It can take +main SSI meta-glue itself \(em not to any particular kind. It can take many different parameters to format where and how the verbose output will be sent (note that at least one parameter must be specified, even if it is an invalid parameter). Any combination of the following @@ -59,18 +59,18 @@ Send the verbose output to the syslog. .TP syslogpri: -Set the syslog output priority to . Using this paramter +Set the syslog output priority to . Using this parameter implies the .I syslog -parameter. The default priority is +parameter. The default priority is .I info (LOG_INFO). -Valid values are: -.I notice -(LOG_NOTICE), +Valid values are: +.I notice +(LOG_NOTICE), .IR info , and -.I debug +.I debug (LOG_DEBUG). .TP syslogid: @@ -103,7 +103,7 @@ modules, generally negative numbers mean no verbose messages, 0 means a minimal set of messages, and positive numbers mean more messages (the greater the positive number, the more output messages will be -generated). If left unspecified any any other +generated). If left unspecified any any other .I ssi_verbose parameters are specified, the default level of 0 is used. .PP @@ -122,13 +122,13 @@ precedence over environment variables. .SH EXAMPLES .TP 4 -mpirun -ssi ssi_verbose 1 C foo +mpirun \-ssi ssi_verbose 1 C foo Since no valid parameters were passed, the verbose output will be sent to stderr. .TP -mpirun -ssi ssi_verbose file:output.txt,syslogpri:notice C foo +mpirun \-ssi ssi_verbose file:output.txt,syslogpri:notice C foo Send the verbose output to both the file lam-output.txt in the LAM user meta directory as well as to the syslog with a priority of -LOG_NOTICE. +LOG_NOTICE. .SH SEE ALSO lamssi_boot(7), lamssi_coll(7), lamssi_cr(7), lamssi_rpi(7), mpirun(1), lamboot(1), recon(1), lamwipe(1), LAM User's Guide