From 49cf3b144363ee29b27e9112b37e0778f2377caf Mon Sep 17 00:00:00 2001 From: siddardh Date: Thu, 8 Jun 2023 00:44:31 +0530 Subject: [PATCH] Imporved consistency across the page and mentioned `[To be supplied]` for some descriptions --- docs/Agent/user-guide/man_page.md | 122 ++++++++++++++++-------------- 1 file changed, 65 insertions(+), 57 deletions(-) diff --git a/docs/Agent/user-guide/man_page.md b/docs/Agent/user-guide/man_page.md index f3de5b687a..dec5e86642 100644 --- a/docs/Agent/user-guide/man_page.md +++ b/docs/Agent/user-guide/man_page.md @@ -25,7 +25,7 @@ #### Pbench Server 1.0 -- [pbench-results-move](pbench-results-move) +- [pbench-results-move](#pbench-results-move) ## Commands @@ -45,7 +45,7 @@ This command clears the results directory from `/var/lib/pbench-agent` directory. **OPTIONS** - `-C`, `--config` PATH + `-C`, `--config PATH` Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. @@ -68,17 +68,17 @@ Show this message and exit. Clear all tools which are registered and can filter by name of the group. **OPTIONS** -`-C`, `--config` PATH +`-C`, `--config PATH` Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. -`-n`, `--name`, `--names` STR -Clear only the <`STR`> tool. +`-n`, `--name`, `--names ` +Clear only the `` tool. -`-g`, `--group`, `--groups` STR -Clear the tools in the <`STR`> group. If no group is specified, the `default` group is assumed. +`-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 STR[,STR...]` 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` @@ -94,25 +94,25 @@ Show this message and exit. `pbench-copy-results` - copy result tarball to the 0.69 Pbench Server **SYNOPSIS** -`pbench-copy-results [OPTIONS]` +`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. **OPTIONS** -`--user` +`--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. @@ -144,15 +144,15 @@ Show this message and exit. List tool registrations, optionally filtered by tool name or tool group. **OPTIONS** - `-C`, `--config` PATH + `-C`, `--config PATH` Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. -`-n`, `--name` STR -List the tool groups in which tool <`STR`> is registered. +`-n`, `--name ` +List the tool groups in which tool `` is registered. -`-g`, `--group` STR -List all the tools registered in the <`STR`> group. +`-g`, `--group ` +List all the tools registered in the ``. `-o`, `--with-option` List the options with each tool. @@ -176,12 +176,12 @@ Show this message and exit. This command will list all the registered triggers by `group-name`. **OPTIONS** - `-C`, `--config` PATH + `-C`, `--config PATH` Path to the Pbench Agent configuration file. This option is required if not provided by the `_PBENCH_AGENT_CONFIG` environment variable. -`-g`, `--group`, `--groups` STR -List all the triggers registered in the <`STR`> group. +`-g`, `--group`, `--groups ` +List all the triggers registered in the ``. `--help` Show this message and exit. @@ -202,19 +202,19 @@ Show this message and exit. 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. **OPTIONS** -`--user` +`--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. @@ -240,7 +240,7 @@ Show this message and exit. `pbench-register-tool` - registers the specified tool **SYNOPSIS** -`pbench-register-tool [OPTIONS]` +`pbench-register-tool --name= [OPTIONS] [-- ]` **DESCRIPTION** Register the specified tool. @@ -299,16 +299,22 @@ For a list of tool-specific options, run: > `/opt/pbench-agent/tool-scripts/ --help` **OPTIONS** -`--name` STR -<`STR`> specifies the name of the tool to be registered. +`--name ` +`` specifies the name of the tool to be registered. -`-g`, `--group`, `--groups` STR -Register the tool in <`STR`> group. 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 or the other, so these options are not necessary in those cases, and specifying the wrong one will produce an error.) +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.) -`--remotes` +`--no-install` +[To be supplied] + +`--labels=