Skip to content

Commit 6dd661d

Browse files
authored
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 <[email protected]>
1 parent 2dd3559 commit 6dd661d

File tree

1 file changed

+78
-68
lines changed

1 file changed

+78
-68
lines changed

README.md

+78-68
Original file line numberDiff line numberDiff line change
@@ -168,113 +168,123 @@ its behavior. The `help` command will print a list of supported command-line
168168
flags and arguments:
169169
170170
```text
171-
USAGE:
172-
tokio-console [OPTIONS] [TARGET_ADDR] [SUBCOMMAND]
171+
Commands:
172+
gen-config
173+
Generate a `console.toml` config file with the default
174+
configuration values, overridden by any provided command-line
175+
arguments
176+
gen-completion
177+
Generate shell completions
178+
help
179+
Print this message or the help of the given subcommand(s)
173180
174-
ARGS:
175-
<TARGET_ADDR>
176-
The address of a console-enabled process to connect to.
181+
Arguments:
182+
[TARGET_ADDR]
183+
The address of a console-enabled process to connect to.
177184
178-
This may be an IP address and port, or a DNS name.
185+
This may be an IP address and port, or a DNS name.
179186
180-
On Unix platforms, this may also be a URI with the `file` scheme that specifies the path
181-
to a Unix domain socket, as in `file://localhost/path/to/socket`.
187+
On Unix platforms, this may also be a URI with the `file`
188+
scheme that specifies the path to a Unix domain socket, as in
189+
`file://localhost/path/to/socket`.
182190
183-
[default: http://127.0.0.1:6669]
191+
[default: http://127.0.0.1:6669]
184192
185-
OPTIONS:
186-
--ascii-only <ASCII_ONLY>
187-
Explicitly use only ASCII characters
193+
Options:
194+
--log <LOG_FILTER>
195+
Log level filter for the console's internal diagnostics.
188196
189-
--colorterm <truecolor>
190-
Overrides the value of the `COLORTERM` environment variable.
197+
Logs are written to a new file at the path given by the
198+
`--log-dir` argument (or its default value), or to the system
199+
journal if `systemd-journald` support is enabled.
191200
192-
If this is set to `24bit` or `truecolor`, 24-bit RGB color support will be enabled.
201+
If this is set to 'off' or is not set, no logs will be
202+
written.
193203
194-
[env: COLORTERM=truecolor]
195-
[possible values: 24bit, truecolor]
204+
[default: off]
196205
197-
-h, --help
198-
Print help information
206+
[env: RUST_LOG=]
199207
200-
--lang <LANG>
201-
Overrides the terminal's default language
208+
--log-dir <LOG_DIRECTORY>
209+
Path to a directory to write the console's internal logs to.
202210
203-
[env: LANG=]
211+
[default: /tmp/tokio-console/logs]
204212
205-
--log <ENV_FILTER>
206-
Log level filter for the console's internal diagnostics.
213+
--lang <LANG>
214+
Overrides the terminal's default language
207215
208-
Logs are written to a new file at the path given by the `--log-dir` argument (or its
209-
default value), or to the system journal if `systemd-journald` support is enabled.
216+
[env: LANG=en_US.UTF-8]
210217
211-
If this is set to 'off' or is not set, no logs will be written.
218+
--ascii-only <ASCII_ONLY>
219+
Explicitly use only ASCII characters
212220
213-
[default: off]
221+
[possible values: true, false]
214222
215-
[env: RUST_LOG=]
223+
--no-colors
224+
Disable ANSI colors entirely
216225
217-
--log-dir <LOG_DIRECTORY>
218-
Path to a directory to write the console's internal logs to.
226+
--colorterm <truecolor>
227+
Overrides the value of the `COLORTERM` environment variable.
219228
220-
[default: /tmp/tokio-console/logs]
229+
If this is set to `24bit` or `truecolor`, 24-bit RGB color
230+
support will be enabled.
221231
222-
--no-colors
223-
Disable ANSI colors entirely
232+
[env: COLORTERM=truecolor]
233+
[possible values: 24bit, truecolor]
224234
225-
--no-duration-colors <COLOR_DURATIONS>
226-
Disable color-coding for duration units
235+
--palette <PALETTE>
236+
Explicitly set which color palette to use
227237
228-
--no-terminated-colors <COLOR_TERMINATED>
229-
Disable color-coding for terminated tasks
238+
[possible values: 8, 16, 256, all, off]
230239
231-
--palette <PALETTE>
232-
Explicitly set which color palette to use
240+
--no-duration-colors <COLOR_DURATIONS>
241+
Disable color-coding for duration units
233242
234-
[possible values: 8, 16, 256, all, off]
243+
[possible values: true, false]
235244
236-
--retain-for <RETAIN_FOR>
237-
How long to continue displaying completed tasks and dropped resources after they have
238-
been closed.
245+
--no-terminated-colors <COLOR_TERMINATED>
246+
Disable color-coding for terminated tasks
239247
240-
This accepts either a duration, parsed as a combination of time spans (such as `5days
241-
2min 2s`), or `none` to disable removing completed tasks and dropped resources.
248+
[possible values: true, false]
242249
243-
Each time span is an integer number followed by a suffix. Supported suffixes are:
250+
--retain-for <RETAIN_FOR>
251+
How long to continue displaying completed tasks and dropped
252+
resources after they have been closed.
244253
245-
* `nsec`, `ns` -- nanoseconds
254+
This accepts either a duration, parsed as a combination of
255+
time spans (such as `5days 2min 2s`), or `none` to disable
256+
removing completed tasks and dropped resources.
246257
247-
* `usec`, `us` -- microseconds
258+
Each time span is an integer number followed by a suffix.
259+
Supported suffixes are:
248260
249-
* `msec`, `ms` -- milliseconds
261+
* `nsec`, `ns` -- nanoseconds
250262
251-
* `seconds`, `second`, `sec`, `s`
263+
* `usec`, `us` -- microseconds
252264
253-
* `minutes`, `minute`, `min`, `m`
265+
* `msec`, `ms` -- milliseconds
254266
255-
* `hours`, `hour`, `hr`, `h`
267+
* `seconds`, `second`, `sec`, `s`
256268
257-
* `days`, `day`, `d`
269+
* `minutes`, `minute`, `min`, `m`
258270
259-
* `weeks`, `week`, `w`
271+
* `hours`, `hour`, `hr`, `h`
260272
261-
* `months`, `month`, `M` -- defined as 30.44 days
273+
* `days`, `day`, `d`
262274
263-
* `years`, `year`, `y` -- defined as 365.25 days
275+
* `weeks`, `week`, `w`
264276
265-
[default: 6s]
277+
* `months`, `month`, `M` -- defined as 30.44 days
266278
267-
-V, --version
268-
Print version information
279+
* `years`, `year`, `y` -- defined as 365.25 days
269280
270-
SUBCOMMANDS:
271-
gen-completion
272-
Generate shell completions
273-
gen-config
274-
Generate a `console.toml` config file with the default configuration values, overridden
275-
by any provided command-line arguments
276-
help
277-
Print this message or the help of the given subcommand(s)
281+
[default: 6s]
282+
283+
-h, --help
284+
Print help (see a summary with '-h')
285+
286+
-V, --version
287+
Print version
278288
```
279289
280290
## for development

0 commit comments

Comments
 (0)