OS Manuals

/usr/bin/pctrl

Reference Implementation of the Process Management Interface Exascale (PMIx) standard

From openpmix 6.1.0-r8 (os), captured 2026-11-05 by running pctrl --help (exit 0). permalink

pctrl (PMIx) 6.1.0

Usage: pctrl [OPTION]...
PMIx Job control tool


/*****      General Options      *****/

-h|--help                            This help message
-h|--help <arg0>                     Help for the specified option
-v|--verbose                         Enable typical debug options
-V|--version                         Print version and exit
--pmixmca <arg0> <arg1>           Set MCA parameter value

--uri <arg0>                      Specify the URI of the server to which we are to connect, or
the name of the file (specified as file:filename) that contains that info
--namespace <arg0>                Namespace of the daemon to which we should connect
--nspace <arg0>                   Synonym for "namespace"
--pid <arg0>                      PID of the daemon to which we should connect (int => PID or file:<file>
for file containing the PID
--system-server-first             First look for a system server and connect to it if found
--system-server-only              Connect only to a system-level server
--tmpdir <arg0>                   Set the root for the session directory tree
--wait-to-connect <arg0>          Delay specified number of seconds before trying to connect
--num-connect-retries <arg0>      Max number of times to try to connect

--request-id <arg0>               String identifier for this job control request
--pause                           Pause the specified processes
--resume                          "Un-pause" the specified processes
--cancel <arg0>                   Cancel the specified request ID ("all" => cancel all requests from this requestor)
--kill                            Force terminate the specified processes
--terminate                       Politely terminate the specified processes
--signal <arg0>                   Provide the specified processes with the given signal
--restart <arg0>                  Restart the specified processes using the given checkpoint ID
--checkpoint <arg0>               Checkpoint the specified processes and assign the given ID to it
--pset <arg0>                     Define a new pset (with the given name) whose membership is
comprised of the specified processes
--targets <arg0>                  Comma-delimited list of target processes for the requested
job-control operation

Report bugs to https://github.com/openpmix/openpmix
Options (21)
OptionDescriptionSource
--pmixmca arg0Set MCA parameter valuehelp
--uri arg0Specify the URI of the server to which we are to connect, orhelp
--namespace arg0Namespace of the daemon to which we should connecthelp
--nspace arg0Synonym for "namespace"help
--pid arg0PID of the daemon to which we should connect (int => PID or file:<file>help
--system-server-firstFirst look for a system server and connect to it if foundhelp
--system-server-onlyConnect only to a system-level serverhelp
--tmpdir arg0Set the root for the session directory treehelp
--wait-to-connect arg0Delay specified number of seconds before trying to connecthelp
--num-connect-retries arg0Max number of times to try to connecthelp
--request-id arg0String identifier for this job control requesthelp
--pausePause the specified processeshelp
--resume"Un-pause" the specified processeshelp
--cancel arg0Cancel the specified request ID ("all" => cancel all requests from this requestor)help
--killForce terminate the specified processeshelp
--terminatePolitely terminate the specified processeshelp
--signal arg0Provide the specified processes with the given signalhelp
--restart arg0Restart the specified processes using the given checkpoint IDhelp
--checkpoint arg0Checkpoint the specified processes and assign the given ID to ithelp
--pset arg0Define a new pset (with the given name) whose membership ishelp
--targets arg0Comma-delimited list of target processes for the requestedhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.