diff --git a/docs/Agent/user-guide/man_page.md b/docs/Agent/user-guide/man_page.md index dec5e86642..8e33b7ed27 100644 --- a/docs/Agent/user-guide/man_page.md +++ b/docs/Agent/user-guide/man_page.md @@ -35,21 +35,25 @@ --- -**NAME** +**NAME** + `pbench-clear-results` - clears the result directory -**SYNOPSIS** +**SYNOPSIS** + `pbench-clear-results [OPTIONS]` -**DESCRIPTION** -This command clears the results directory from `/var/lib/pbench-agent` directory. +**DESCRIPTION** + +This command clears the results directories from `/var/lib/pbench-agent` directory. + +**OPTIONS** -**OPTIONS** - `-C`, `--config PATH` +[`-C`, `--config`] ``\ Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. -`--help` +`--help`\ Show this message and exit. --- @@ -58,30 +62,34 @@ Show this message and exit. --- -**NAME** +**NAME** + `pbench-clear-tools` - clear registered tools by name or group -**SYNOPSIS** +**SYNOPSIS** + `pbench-clear-tools [OPTIONS]` -**DESCRIPTION** +**DESCRIPTION** + Clear all tools which are registered and can filter by name of the group. -**OPTIONS** -`-C`, `--config PATH` +**OPTIONS** + +[`-C`, `--config`] ``\ Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. -`-n`, `--name`, `--names ` +[`-n`, `--name`, `--names`] ``\ Clear only the `` tool. -`-g`, `--group`, `--groups ` +[`-g`, `--group`, `--groups`] ``\ Clear the tools in the ``. If no group is specified, the `default` group is assumed. -`-r`, `--remote`, `--remotes STR[,STR...]` +[`-r`, `--remote`, `--remotes`] `[,]...`\ Clear the tool(s) only on the specified remote(s). Multiple remotes may be specified as a comma-separated list. If no remote is specified, all remotes are cleared. -`--help` +`--help`\ Show this message and exit. --- @@ -90,42 +98,48 @@ Show this message and exit. --- -**NAME** -`pbench-copy-results` - copy result tarball to the 0.69 Pbench Server +**NAME** + +`pbench-copy-results` - copy result tarball to a 0.69 Pbench Server + +**SYNOPSIS** -**SYNOPSIS** `pbench-copy-results --user= [OPTIONS]` -**DESCRIPTION** -Push the benchmark result to the Pbench Server without removing it from the local host. This command requires `/opt/pbench-agent/id_rsa` file with the private SSH key, when pushing to a 0.69 Pbench Server. +**DESCRIPTION** -**OPTIONS** -`--user ` +Push the benchmark result to a 0.69 Pbench Server without removing it from the +local host. This command requires an `/opt/pbench-agent/id_rsa` file containing +a private SSH key for the 0.69 Pbench Server `pbench` account. + +**OPTIONS** + +`--user `\ This option value is required if not provided by the `PBENCH_USER` environment variable; otherwise, a value provided on the command line will override any value provided by the environment. -`--controller ` +`--controller `\ This option may be used to override the value provided by the `PBENCH_CONTROLLER` environment variable; if neither value is available, the result of `hostname -f` is used. (If no value is available, the command will exit with an error.) -`--prefix ` +`--prefix `\ This option allows the user to specify an optional directory-path hierarchy to be used when displaying the result files on the 0.69 Pbench Server. -`--show-server` +`--show-server`\ This will not move any results but will resolve and then display the pbench server destination for results. -`--xz-single-threaded` +`--xz-single-threaded`\ This will force the use of a single thread for locally compressing the result files. -`--help` +`--help`\ Show this message and exit. --- @@ -134,30 +148,34 @@ Show this message and exit. --- -**NAME** +**NAME** + `pbench-list-tools` - list all the registered tools optionally filtered by name or group -**SYNOPSIS** +**SYNOPSIS** + `pbench-list-tools [OPTIONS]` -**DESCRIPTION** +**DESCRIPTION** + List tool registrations, optionally filtered by tool name or tool group. -**OPTIONS** - `-C`, `--config PATH` +**OPTIONS** + +[`-C`, `--config`] ``\ Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. -`-n`, `--name ` +[`-n`, `--name`] ``\ List the tool groups in which tool `` is registered. -`-g`, `--group ` +[`-g`, `--group`] ``\ List all the tools registered in the ``. -`-o`, `--with-option` +`-o`, `--with-option`\ List the options with each tool. -`--help` +`--help`\ Show this message and exit. --- @@ -166,24 +184,28 @@ Show this message and exit. --- -**NAME** +**NAME** + `pbench-list-triggers` - list the registered triggers by group -**SYNOPSIS** +**SYNOPSIS** + `pbench-list-triggers [OPTIONS]` -**DESCRIPTION** +**DESCRIPTION** + This command will list all the registered triggers by `group-name`. -**OPTIONS** - `-C`, `--config PATH` +**OPTIONS** + +[`-C`, `--config`] ``\ Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. -`-g`, `--group`, `--groups ` +[`-g`, `--group`, `--groups`] ``\ List all the triggers registered in the ``. -`--help` +`--help`\ Show this message and exit. --- @@ -192,42 +214,49 @@ Show this message and exit. --- -**NAME** +**NAME** + `pbench-move-results` - move all results to 0.69 Pbench Server -**SYNOPSIS** +**SYNOPSIS** + `pbench-move-results [OPTIONS]` -**DESCRIPTION** -Push the benchmark result to the 0.69 Pbench Server. Requires a `/opt/pbench-agent/id_rsa` file with the private SSH key of the server's pbench account. On a successful push, this command removes the results from the local host. +**DESCRIPTION** + +Push the benchmark result to a 0.69 Pbench Server. This command requires an +`/opt/pbench-agent/id_rsa` file containing a private SSH key for the 0.69 +Pbench Server `pbench` account. On a successful push, this command removes the +results from the local host. -**OPTIONS** -`--user ` +**OPTIONS** + +`--user `\ This option value is required if not provided by the `PBENCH_USER` environment variable; otherwise, a value provided on the command line will override any value provided by the environment. -`--controller ` +`--controller `\ This option may be used to override the value provided by the `PBENCH_CONTROLLER` environment variable; if neither value is available, the result of `hostname -f` is used. (If no value is available, the command will exit with an error.) -`--prefix ` +`--prefix `\ This option allows the user to specify an optional directory-path hierarchy to be used when displaying the result tar balls on the pbench server. -`--show-server` +`--show-server`\ This will not move any results but will resolve and then display the pbench server destination for results. -`--xz-single-threaded` +`--xz-single-threaded`\ This will force the use of a single thread for locally compressing the result files. -`--help` +`--help`\ Show this message and exit. --- @@ -236,14 +265,17 @@ Show this message and exit. --- -**NAME** +**NAME** + `pbench-register-tool` - registers the specified tool -**SYNOPSIS** +**SYNOPSIS** + `pbench-register-tool --name= [OPTIONS] [-- ]` -**DESCRIPTION** -Register the specified tool. +**DESCRIPTION** + +Register the specified tool. List of available tools: **Transient** @@ -298,26 +330,40 @@ For a list of tool-specific options, run: > `/opt/pbench-agent/tool-scripts/ --help` -**OPTIONS** -`--name ` +**OPTIONS** + +`--name `\ `` specifies the name of the tool to be registered. -`-g`, `--group`, `--groups ` -Register the tool in ``. If no group is specified, the `default` group is assumed. +[`-g`, `--group`, `--groups`] ``\ +Register the tool in ``. If no group is specified, the `default` group +is assumed. -`[--persistent | --transient]` -For tools which can be run as either "transient" (where they are started and stopped on each iteration) or as "persistent" (where they are started before the first iteration and run continuously over all iterations), these options determine how the tool will be run. (Most tools are configured to run as either one the other, so these options are not necessary in those cases, and specifying the wrong one will produce an error.) +`[--persistent | --transient]`\ +For tools which can be run as either "transient" (where they are started and +stopped on each iteration) or as "persistent" (where they are started before +the first iteration and run continuously over all iterations), these options +determine how the tool will be run. -`--no-install` +Most tools can be run only in one mode, so these options are necessary only +when a tool (such as `pcp`) can be run in either mode. Specifying a mode the +tool does not support will produce an error. + +`--no-install`\ [To be supplied] -`--labels=