diff --git a/README.md b/README.md index cfb329f6..24bd24c0 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ values are converted, and, in some cases, additional semantic context fields are added. To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` -function parameter in `parse()`. +function parameter in `parse()` when using `jc` as a python library. Schemas for each parser can be found at the documentation link beside each [**Parser**](#parsers) below. @@ -139,11 +139,12 @@ echo STRING | jc [OPTIONS] PARSER ``` Alternatively, the "magic" syntax can be used by prepending `jc` to the command -to be converted. Options can be passed to `jc` immediately before the command is -given. (Note: command aliases and shell builtins are not supported) +to be converted or in front of the absolute path for Proc files. Options can be +passed to `jc` immediately before the command or Proc file path is given. +(Note: command aliases and shell builtins are not supported) ```bash jc [OPTIONS] COMMAND -jc [OPTIONS] /proc/ +jc [OPTIONS] /proc/ ``` The JSON output can be compact (default) or pretty formatted with the `-p` diff --git a/docs/parsers/proc_driver_rtc.md b/docs/parsers/proc_driver_rtc.md index 26c7193f..05ea5972 100644 --- a/docs/parsers/proc_driver_rtc.md +++ b/docs/parsers/proc_driver_rtc.md @@ -29,8 +29,8 @@ or Schema: -"yes" and "no" values are converted to true/false. Integer conversions are -attempted. If you do not want this behavior, then use `--raw` (CLI) or +"yes" and "no" values are converted to `true`/`false`. Integer conversions +are attempted. If you do not want this behavior, then use `--raw` (cli) or `raw=True` (module). { diff --git a/jc/cli.py b/jc/cli.py index 6696651e..9c35ee95 100644 --- a/jc/cli.py +++ b/jc/cli.py @@ -195,7 +195,7 @@ Usage: jc [OPTIONS] COMMAND - jc [OPTIONS] /proc/ + jc [OPTIONS] /proc/ Parsers: {parsers_string} diff --git a/jc/parsers/proc_driver_rtc.py b/jc/parsers/proc_driver_rtc.py index 6b384b42..2bc40f33 100644 --- a/jc/parsers/proc_driver_rtc.py +++ b/jc/parsers/proc_driver_rtc.py @@ -24,8 +24,8 @@ or Schema: -"yes" and "no" values are converted to true/false. Integer conversions are -attempted. If you do not want this behavior, then use `--raw` (CLI) or +"yes" and "no" values are converted to `true`/`false`. Integer conversions +are attempted. If you do not want this behavior, then use `--raw` (cli) or `raw=True` (module). { diff --git a/man/jc.1 b/man/jc.1 index 23069a54..aa896893 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -18,7 +18,7 @@ Magic syntax: .RS \fBjc\fP [OPTIONS] COMMAND -\fBjc\fP [OPTIONS] /proc/ +\fBjc\fP [OPTIONS] /proc/ .RE .SH DESCRIPTION diff --git a/templates/manpage_template b/templates/manpage_template index d6a8cc40..8854f421 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -18,7 +18,7 @@ Magic syntax: .RS \fBjc\fP [OPTIONS] COMMAND -\fBjc\fP [OPTIONS] /proc/ +\fBjc\fP [OPTIONS] /proc/ .RE .SH DESCRIPTION diff --git a/templates/readme_template b/templates/readme_template index 9a5c2c1a..5f25970a 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -70,7 +70,7 @@ values are converted, and, in some cases, additional semantic context fields are added. To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` -function parameter in `parse()`. +function parameter in `parse()` when using `jc` as a python library. Schemas for each parser can be found at the documentation link beside each [**Parser**](#parsers) below. @@ -139,11 +139,12 @@ echo STRING | jc [OPTIONS] PARSER ``` Alternatively, the "magic" syntax can be used by prepending `jc` to the command -to be converted. Options can be passed to `jc` immediately before the command is -given. (Note: command aliases and shell builtins are not supported) +to be converted or in front of the absolute path for Proc files. Options can be +passed to `jc` immediately before the command or Proc file path is given. +(Note: command aliases and shell builtins are not supported) ```bash jc [OPTIONS] COMMAND -jc [OPTIONS] /proc/ +jc [OPTIONS] /proc/ ``` The JSON output can be compact (default) or pretty formatted with the `-p`