Skip to content

Commit

Permalink
docs(jetsocat): update doctor help message
Browse files Browse the repository at this point in the history
  • Loading branch information
CBenoit committed Oct 2, 2024
1 parent 6ed8591 commit d21b94f
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions jetsocat/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -248,13 +248,20 @@ fn doctor() -> Command {
let usage = format!(
r##"{command} {subcommand}
If the chain is not provided via the --chain flag, a TLS handshake will be
performed with the server using --subject-name and --server-port.
If the chain is not provided via the --chain flag, and if the --network option is set,
a TLS handshake will be performed with the server using --subject-name and --server-port.
Output formats:
- human: human-readable output
- json: print one JSON object per line for each diagnostic
The JSON objects have the following fields:
- "name" (Required): A string for the name of the diagnostic.
- "success" (Required): A boolean set to true when the diagnostic is successful and false otherwise.
- "output" (Optional): The execution trace of the diagnostic.
- "error" (Optional): The error returned by the diagnostic when failed.
- "help" (Optional): A help message suggesting how to fix the issue.
{pipe_formats}
Example: from a chain file on the disk
Expand Down

0 comments on commit d21b94f

Please sign in to comment.