From d2c7316e00b9aaf19231c05351821041458baf98 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Thu, 14 Nov 2019 13:43:07 -0800 Subject: [PATCH] update command options info --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 47088828..165edfa5 100755 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ The `jc` parsers can also be used as python modules. In this case the output wil ``` Two representations of the data are possible. The default representation uses a strict schema per parser and converts known numbers to int/float JSON values. Certain known values of None are converted to JSON Null, known boolean values are converted, and, in some cases, additional semantic context fields are added. -To access the raw, pre-processed JSON, use the `-r` or `raw=True` options. +To access the raw, pre-processed JSON, use the `-r` cli option or the `raw=True` function parameter in `parse()`. Schemas for each parser can be found in the `docs/parsers` folder. @@ -1222,7 +1222,7 @@ Future parsers: Feel free to add/improve code or parsers! You can use the `jc/parsers/foo.py` parser as a template and submit your parser with a pull request. ## Compatibility -Some parsers like `ls`, `ps`, `dig`, etc. will work on any platform. Other parsers that are platform-specific will generate a warning message if they are used on an unsupported platform. You may still use a parser on an unsupported platform - for example, you may want to parse a file with linux `lsof` output on an OSX laptop. In that case you can suppress the warning message with the `-q` or `quiet=True` options: +Some parsers like `ls`, `ps`, `dig`, etc. will work on any platform. Other parsers that are platform-specific will generate a warning message if they are used on an unsupported platform. You may still use a parser on an unsupported platform - for example, you may want to parse a file with linux `lsof` output on an OSX laptop. In that case you can suppress the warning message with the `-q` cli option or the `quiet=True` function parameter in `parse()`: ``` $ cat lsof.out | jc --lsof -q