From 6dd661dd57aeacedb8dbda2ed7ab17a20888409a Mon Sep 17 00:00:00 2001 From: Rustin Liu Date: Tue, 10 Oct 2023 11:57:44 -0500 Subject: [PATCH] docs: update outdated main README.md (#470) After upgrading to Clap v4 (#469), the help output of `tokio-console` changed slightly. This change updates the README.md in the root of the repository, which contains the full text of the help text. Signed-off-by: hi-rustin --- README.md | 146 +++++++++++++++++++++++++++++------------------------- 1 file changed, 78 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 058487104..4d89ba5d9 100644 --- a/README.md +++ b/README.md @@ -168,113 +168,123 @@ its behavior. The `help` command will print a list of supported command-line flags and arguments: ```text -USAGE: - tokio-console [OPTIONS] [TARGET_ADDR] [SUBCOMMAND] +Commands: + gen-config + Generate a `console.toml` config file with the default + configuration values, overridden by any provided command-line + arguments + gen-completion + Generate shell completions + help + Print this message or the help of the given subcommand(s) -ARGS: - - The address of a console-enabled process to connect to. +Arguments: + [TARGET_ADDR] + The address of a console-enabled process to connect to. - This may be an IP address and port, or a DNS name. + This may be an IP address and port, or a DNS name. - On Unix platforms, this may also be a URI with the `file` scheme that specifies the path - to a Unix domain socket, as in `file://localhost/path/to/socket`. + On Unix platforms, this may also be a URI with the `file` + scheme that specifies the path to a Unix domain socket, as in + `file://localhost/path/to/socket`. - [default: http://127.0.0.1:6669] + [default: http://127.0.0.1:6669] -OPTIONS: - --ascii-only - Explicitly use only ASCII characters +Options: + --log + Log level filter for the console's internal diagnostics. - --colorterm - Overrides the value of the `COLORTERM` environment variable. + Logs are written to a new file at the path given by the + `--log-dir` argument (or its default value), or to the system + journal if `systemd-journald` support is enabled. - If this is set to `24bit` or `truecolor`, 24-bit RGB color support will be enabled. + If this is set to 'off' or is not set, no logs will be + written. - [env: COLORTERM=truecolor] - [possible values: 24bit, truecolor] + [default: off] - -h, --help - Print help information + [env: RUST_LOG=] - --lang - Overrides the terminal's default language + --log-dir + Path to a directory to write the console's internal logs to. - [env: LANG=] + [default: /tmp/tokio-console/logs] - --log - Log level filter for the console's internal diagnostics. + --lang + Overrides the terminal's default language - Logs are written to a new file at the path given by the `--log-dir` argument (or its - default value), or to the system journal if `systemd-journald` support is enabled. + [env: LANG=en_US.UTF-8] - If this is set to 'off' or is not set, no logs will be written. + --ascii-only + Explicitly use only ASCII characters - [default: off] + [possible values: true, false] - [env: RUST_LOG=] + --no-colors + Disable ANSI colors entirely - --log-dir - Path to a directory to write the console's internal logs to. + --colorterm + Overrides the value of the `COLORTERM` environment variable. - [default: /tmp/tokio-console/logs] + If this is set to `24bit` or `truecolor`, 24-bit RGB color + support will be enabled. - --no-colors - Disable ANSI colors entirely + [env: COLORTERM=truecolor] + [possible values: 24bit, truecolor] - --no-duration-colors - Disable color-coding for duration units + --palette + Explicitly set which color palette to use - --no-terminated-colors - Disable color-coding for terminated tasks + [possible values: 8, 16, 256, all, off] - --palette - Explicitly set which color palette to use + --no-duration-colors + Disable color-coding for duration units - [possible values: 8, 16, 256, all, off] + [possible values: true, false] - --retain-for - How long to continue displaying completed tasks and dropped resources after they have - been closed. + --no-terminated-colors + Disable color-coding for terminated tasks - This accepts either a duration, parsed as a combination of time spans (such as `5days - 2min 2s`), or `none` to disable removing completed tasks and dropped resources. + [possible values: true, false] - Each time span is an integer number followed by a suffix. Supported suffixes are: + --retain-for + How long to continue displaying completed tasks and dropped + resources after they have been closed. - * `nsec`, `ns` -- nanoseconds + This accepts either a duration, parsed as a combination of + time spans (such as `5days 2min 2s`), or `none` to disable + removing completed tasks and dropped resources. - * `usec`, `us` -- microseconds + Each time span is an integer number followed by a suffix. + Supported suffixes are: - * `msec`, `ms` -- milliseconds + * `nsec`, `ns` -- nanoseconds - * `seconds`, `second`, `sec`, `s` + * `usec`, `us` -- microseconds - * `minutes`, `minute`, `min`, `m` + * `msec`, `ms` -- milliseconds - * `hours`, `hour`, `hr`, `h` + * `seconds`, `second`, `sec`, `s` - * `days`, `day`, `d` + * `minutes`, `minute`, `min`, `m` - * `weeks`, `week`, `w` + * `hours`, `hour`, `hr`, `h` - * `months`, `month`, `M` -- defined as 30.44 days + * `days`, `day`, `d` - * `years`, `year`, `y` -- defined as 365.25 days + * `weeks`, `week`, `w` - [default: 6s] + * `months`, `month`, `M` -- defined as 30.44 days - -V, --version - Print version information + * `years`, `year`, `y` -- defined as 365.25 days -SUBCOMMANDS: - gen-completion - Generate shell completions - gen-config - Generate a `console.toml` config file with the default configuration values, overridden - by any provided command-line arguments - help - Print this message or the help of the given subcommand(s) + [default: 6s] + + -h, --help + Print help (see a summary with '-h') + + -V, --version + Print version ``` ## for development