@@ -53,11 +53,11 @@ toolkit consists of multiple components:
5353
5454wow! whoa! it's like ` top(1) ` for tasks!
5555
56- ![ task list view] ( https://user-images.githubusercontent.com/2796466/129774465-7bd2ad2f-f1a3-4830-a8fa-f72667028fa1 .png)
56+ ![ task list view] ( assets/readme/top-for-tasks .png)
5757
5858viewing details for a single task:
5959
60- ![ task details view] ( https://user-images.githubusercontent.com/2796466/129774524-288c967b-6066-4f98-973d-099b3e6a2c55 .png)
60+ ![ task details view] ( assets/readme/task-details .png)
6161
6262## on the shoulders of giants
6363
@@ -163,58 +163,75 @@ as an argument to the console (either as an `<IP>:<PORT>` or
163163cargo run -- http://my.great.console.app.local:5555
164164` ` `
165165
166- the console command-line tool supports a number of additional flags to configure
167- its behavior. the ` -h ` or ` -- help` flag will print a list of supported
168- command-line flags and arguments:
166+ The console command-line tool supports a number of additional flags to configure
167+ its behavior. The ` help` command will print a list of supported command-line
168+ flags and arguments:
169169
170170` ` ` text
171171USAGE:
172- tokio-console [FLAGS ] [OPTIONS ] [TARGET_ADDR ]
172+ tokio-console [OPTIONS ] [TARGET_ADDR ] [SUBCOMMAND ]
173173
174174ARGS:
175175 < TARGET_ADDR>
176176 The address of a console-enabled process to connect to.
177177
178- This may be an IP address and port, or a DNS name. [default: http://127.0.0.1:6669]
178+ This may be an IP address and port, or a DNS name.
179179
180- FLAGS:
181- --ascii-only
182- Explicitly use only ASCII characters
183-
184- -h, --help
185- Print help information
186-
187- --no-colors
188- Disable ANSI colors entirely
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` .
189182
190- --no-duration-colors
191- Disable color-coding for duration units
192-
193- --no-terminated-colors
194- Disable color-coding for terminated tasks
195-
196- -V, --version
197- Print version information
183+ [default: http://127.0.0.1:6669]
198184
199185OPTIONS:
186+ --ascii-only < ASCII_ONLY>
187+ Explicitly use only ASCII characters
188+
200189 --colorterm < truecolor>
201190 Overrides the value of the ` COLORTERM` environment variable.
202191
203192 If this is set to ` 24bit` or ` truecolor` , 24-bit RGB color support will be enabled.
204- [env: COLORTERM= truecolor] [possible values: 24bit, truecolor]
193+
194+ [env: COLORTERM= truecolor]
195+ [possible values: 24bit, truecolor]
196+
197+ -h, --help
198+ Print help information
205199
206200 --lang < LANG>
207- Overrides the terminal' s default language [env: LANG=en_US.UTF-8] [default: en_us.UTF-8]
201+ Overrides the terminal' s default language
202+
203+ [env: LANG=]
208204
209205 --log <ENV_FILTER>
210206 Log level filter for the console' s internal diagnostics.
211207
212- The console will log to stderr if a log level filter is provided. Since the console
213- application runs interactively, stderr should generally be redirected to a file to avoid
214- interfering with the console' s text output. [env: RUST_LOG=] [default: off]
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.
210+
211+ If this is set to ' off' or is not set, no logs will be written.
212+
213+ [default: off]
214+
215+ [env: RUST_LOG= ]
216+
217+ --log-dir < LOG_DIRECTORY>
218+ Path to a directory to write the console' s internal logs to.
219+
220+ [default: /tmp/tokio-console/logs]
221+
222+ --no-colors
223+ Disable ANSI colors entirely
224+
225+ --no-duration-colors <COLOR_DURATIONS>
226+ Disable color-coding for duration units
227+
228+ --no-terminated-colors <COLOR_TERMINATED>
229+ Disable color-coding for terminated tasks
215230
216231 --palette <PALETTE>
217- Explicitly set which color palette to use [possible values: 8, 16, 256, all, off]
232+ Explicitly set which color palette to use
233+
234+ [possible values: 8, 16, 256, all, off]
218235
219236 --retain-for <RETAIN_FOR>
220237 How long to continue displaying completed tasks and dropped resources after they have
@@ -243,7 +260,21 @@ OPTIONS:
243260
244261 * `months`, `month`, `M` -- defined as 30.44 days
245262
246- * `years`, `year`, `y` -- defined as 365.25 days [default: 6s]
263+ * `years`, `year`, `y` -- defined as 365.25 days
264+
265+ [default: 6s]
266+
267+ -V, --version
268+ Print version information
269+
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)
247278```
248279
249280## for development
0 commit comments