From 8d9ebf5dfa1af97ae14da351b6b2958ad36d01a5 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 29 Jan 2024 09:38:57 -0800 Subject: [PATCH] doc update --- README.md | 34 +++++++++++++++++----------------- man/jc.1 | 4 ++-- templates/manpage_template | 2 +- templates/readme_template | 34 +++++++++++++++++----------------- 4 files changed, 37 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index fbccf6ff..c350df2f 100644 --- a/README.md +++ b/README.md @@ -318,23 +318,23 @@ option. ### Options -| Short | Long | Description | -|-------|-----------------|---------------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation. Use twice to show hidden parsers (e.g. `-hh`) | -| `-m` | `--monochrome` | Monochrome output | -| `-M` | `--meta-out` | Add metadata to output including timestamp, parser name, magic command, magic command exit code, etc. | | -| `-p` | `--pretty` | Pretty format the JSON output | -| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-s` | `--slurp` | Slurp multiple lines into an array. (use `-hhh` to find compatible parsers) | -| `-u` | `--unbuffer` | Unbuffer output | -| `-v` | `--version` | Version information | -| `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | Generate Bash shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | -| `-Z` | `--zsh-comp` | Generate Zsh shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | +| Short | Long | Description | +|-------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation. Use twice to show hidden parsers (e.g. `-hh`). Use thrice to show parser categories (e.g. `-hhh`). | +| `-m` | `--monochrome` | Monochrome output | +| `-M` | `--meta-out` | Add metadata to output including timestamp, parser name, magic command, magic command exit code, etc. | | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-s` | `--slurp` | Slurp multiple lines into an array. (use `-hhh` to find compatible parsers) | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | Generate Bash shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | ### Slice Line slicing is supported using the `START:STOP` syntax similar to Python diff --git a/man/jc.1 b/man/jc.1 index bc90d0f0..65b2df27 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2024-01-26 1.24.1 "JSON Convert" +.TH jc 1 2024-01-29 1.24.1 "JSON Convert" .SH NAME \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools, file-types, and strings @@ -1116,7 +1116,7 @@ Debug - show traceback (use \fB-dd\fP for verbose traceback) .B \fB-h\fP, \fB--help\fP Help (\fB--help --parser_name\fP for parser documentation). Use twice to show -hidden parsers (e.g. \fB-hh\fP) +hidden parsers (e.g. \fB-hh\fP). Use thrice to show parser categories (e.g. \fB-hhh\fP). .TP .B \fB-m\fP, \fB--monochrome\fP diff --git a/templates/manpage_template b/templates/manpage_template index edd48880..096ea08e 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -66,7 +66,7 @@ Debug - show traceback (use \fB-dd\fP for verbose traceback) .B \fB-h\fP, \fB--help\fP Help (\fB--help --parser_name\fP for parser documentation). Use twice to show -hidden parsers (e.g. \fB-hh\fP) +hidden parsers (e.g. \fB-hh\fP). Use thrice to show parser categories (e.g. \fB-hhh\fP). .TP .B \fB-m\fP, \fB--monochrome\fP diff --git a/templates/readme_template b/templates/readme_template index 3e955bc7..73b6e1b8 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -159,23 +159,23 @@ option. ### Options -| Short | Long | Description | -|-------|-----------------|---------------------------------------------------------------------------------------------------------------------| -| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | -| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | -| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | -| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation. Use twice to show hidden parsers (e.g. `-hh`) | -| `-m` | `--monochrome` | Monochrome output | -| `-M` | `--meta-out` | Add metadata to output including timestamp, parser name, magic command, magic command exit code, etc. | | -| `-p` | `--pretty` | Pretty format the JSON output | -| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | -| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | -| `-s` | `--slurp` | Slurp multiple lines into an array. (use `-hhh` to find compatible parsers) | -| `-u` | `--unbuffer` | Unbuffer output | -| `-v` | `--version` | Version information | -| `-y` | `--yaml-out` | YAML output | -| `-B` | `--bash-comp` | Generate Bash shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | -| `-Z` | `--zsh-comp` | Generate Zsh shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | +| Short | Long | Description | +|-------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `-a` | `--about` | About `jc`. Prints information about `jc` and the parsers (in JSON or YAML, of course!) | +| `-C` | `--force-color` | Force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) | +| `-d` | `--debug` | Debug mode. Prints trace messages if parsing issues are encountered (use`-dd` for verbose debugging) | +| `-h` | `--help` | Help. Use `jc -h --parser_name` for parser documentation. Use twice to show hidden parsers (e.g. `-hh`). Use thrice to show parser categories (e.g. `-hhh`). | +| `-m` | `--monochrome` | Monochrome output | +| `-M` | `--meta-out` | Add metadata to output including timestamp, parser name, magic command, magic command exit code, etc. | | +| `-p` | `--pretty` | Pretty format the JSON output | +| `-q` | `--quiet` | Quiet mode. Suppresses parser warning messages (use `-qq` to ignore streaming parser errors) | +| `-r` | `--raw` | Raw output. Provides more literal output, typically with string values and no additional semantic processing | +| `-s` | `--slurp` | Slurp multiple lines into an array. (use `-hhh` to find compatible parsers) | +| `-u` | `--unbuffer` | Unbuffer output | +| `-v` | `--version` | Version information | +| `-y` | `--yaml-out` | YAML output | +| `-B` | `--bash-comp` | Generate Bash shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | +| `-Z` | `--zsh-comp` | Generate Zsh shell completion script ([more info](https://github.com/kellyjonbrazil/jc/wiki/Shell-Completions)) | ### Slice Line slicing is supported using the `START:STOP` syntax similar to Python