From ac7c13fcc013d386f34db51d634298fa3e97eccd Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Wed, 8 Dec 2021 08:22:28 -0800 Subject: [PATCH] add -C option to docs --- README.md | 1 + man/jc.1 | 6 +++++- templates/manpage_template | 4 ++++ templates/readme_template | 1 + 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e11519a5..74ba9ad3 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio ### Options - `-a` about `jc`. Prints information about `jc` and the parsers (in JSON, of course!) +- `-C` force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) - `-d` debug mode. Prints trace messages if parsing issues are encountered (use `-dd` for verbose debugging) - `-h` help. Use `jc -h --parser_name` for parser documentation - `-m` monochrome JSON output diff --git a/man/jc.1 b/man/jc.1 index 4c990e69..812da859 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2021-12-02 1.17.3 "JSON CLI output utility" +.TH jc 1 2021-12-08 1.17.3 "JSON CLI output utility" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS @@ -440,6 +440,10 @@ Options: about jc (JSON output) .TP .B +\fB-C\fP +force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) +.TP +.B \fB-d\fP debug - show traceback (use \fB-dd\fP for verbose traceback) .TP diff --git a/templates/manpage_template b/templates/manpage_template index c07b64c1..a35c93d0 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -35,6 +35,10 @@ Options: about jc (JSON output) .TP .B +\fB-C\fP +force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) +.TP +.B \fB-d\fP debug - show traceback (use \fB-dd\fP for verbose traceback) .TP diff --git a/templates/readme_template b/templates/readme_template index ea81e823..c2c151f2 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -110,6 +110,7 @@ The JSON output can be compact (default) or pretty formatted with the `-p` optio ### Options - `-a` about `jc`. Prints information about `jc` and the parsers (in JSON, of course!) +- `-C` force color output even when using pipes (overrides `-m` and the `NO_COLOR` env variable) - `-d` debug mode. Prints trace messages if parsing issues are encountered (use `-dd` for verbose debugging) - `-h` help. Use `jc -h --parser_name` for parser documentation - `-m` monochrome JSON output