diff --git a/README.md b/README.md index f5d3f134..5539453f 100644 --- a/README.md +++ b/README.md @@ -204,8 +204,8 @@ option. | ` --nmcli` | `nmcli` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/nmcli) | | ` --ntpq` | `ntpq -p` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ntpq) | | ` --passwd` | `/etc/passwd` file parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/passwd) | -| ` --pidstat` | `pidstat` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat) | -| ` --pidstat-s` | `pidstat` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat_s) | +| ` --pidstat` | `pidstat -h` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat) | +| ` --pidstat-s` | `pidstat -h` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pidstat_s) | | ` --ping` | `ping` and `ping6` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ping) | | ` --ping-s` | `ping` and `ping6` command streaming parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/ping_s) | | ` --pip-list` | `pip list` command parser | [📃](https://kellyjonbrazil.github.io/jc/docs/parsers/pip_list) | diff --git a/docs/parsers/nmcli.md b/docs/parsers/nmcli.md index f522969c..bdb50fcb 100644 --- a/docs/parsers/nmcli.md +++ b/docs/parsers/nmcli.md @@ -29,14 +29,14 @@ Usage (module): Schema: - Because there are so many options, the schema is not strictly defined. - Integer and Float value conversions are attempted and the original - values are kept if they fail. If you don't want automatic conversion, - then use the -r or raw=True option to disable it. +Because there are so many options, the schema is not strictly defined. +Integer and Float value conversions are attempted and the original +values are kept if they fail. If you don't want automatic conversion, +then use the `-r` or `raw=True` option to disable it. - The structure is flat, for the most part, but there are a couple of - "well-known" keys that are further parsed into objects for convenience. - These are documented below. +The structure is flat, for the most part, but there are a couple of +"well-known" keys that are further parsed into objects for convenience. +These are documented below. [ { diff --git a/docs/parsers/pidstat.md b/docs/parsers/pidstat.md index f8d1937e..bd94a047 100644 --- a/docs/parsers/pidstat.md +++ b/docs/parsers/pidstat.md @@ -3,7 +3,7 @@ # jc.parsers.pidstat -jc - JSON Convert `pidstat` command output parser +jc - JSON Convert `pidstat -h` command output parser Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. diff --git a/docs/parsers/pidstat_s.md b/docs/parsers/pidstat_s.md index 91b46798..8f03d200 100644 --- a/docs/parsers/pidstat_s.md +++ b/docs/parsers/pidstat_s.md @@ -3,7 +3,7 @@ # jc.parsers.pidstat\_s -jc - JSON Convert `pidstat` command output streaming parser +jc - JSON Convert `pidstat -h` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of > Dictionaries (module) diff --git a/docs/parsers/rpm_qi.md b/docs/parsers/rpm_qi.md index b398edfa..01cc871b 100644 --- a/docs/parsers/rpm_qi.md +++ b/docs/parsers/rpm_qi.md @@ -10,7 +10,7 @@ Works with `rpm -qi [package]` or `rpm -qia`. The `..._epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on) -The `..._epoch_utc` calculated timestamp fields are timezone-aware and is +The `..._epoch_utc` calculated timestamp fields are timezone-aware and are only available if the timezone field is UTC. Usage (cli): diff --git a/docs/parsers/xml.md b/docs/parsers/xml.md index e864eaa6..88a69ab3 100644 --- a/docs/parsers/xml.md +++ b/docs/parsers/xml.md @@ -16,8 +16,8 @@ Usage (module): Schema: - XML Document converted to a Dictionary - See https://github.com/martinblech/xmltodict for details +XML Document converted to a Dictionary. See https://github.com/martinblech/xmltodict +for details. { "key1": string/object, diff --git a/jc/parsers/nmcli.py b/jc/parsers/nmcli.py index 78e6f4db..8ac993da 100644 --- a/jc/parsers/nmcli.py +++ b/jc/parsers/nmcli.py @@ -24,14 +24,14 @@ Usage (module): Schema: - Because there are so many options, the schema is not strictly defined. - Integer and Float value conversions are attempted and the original - values are kept if they fail. If you don't want automatic conversion, - then use the -r or raw=True option to disable it. +Because there are so many options, the schema is not strictly defined. +Integer and Float value conversions are attempted and the original +values are kept if they fail. If you don't want automatic conversion, +then use the `-r` or `raw=True` option to disable it. - The structure is flat, for the most part, but there are a couple of - "well-known" keys that are further parsed into objects for convenience. - These are documented below. +The structure is flat, for the most part, but there are a couple of +"well-known" keys that are further parsed into objects for convenience. +These are documented below. [ { diff --git a/jc/parsers/pidstat.py b/jc/parsers/pidstat.py index 7d8efc47..c2cd3806 100644 --- a/jc/parsers/pidstat.py +++ b/jc/parsers/pidstat.py @@ -1,4 +1,4 @@ -"""jc - JSON Convert `pidstat` command output parser +"""jc - JSON Convert `pidstat -h` command output parser Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. @@ -129,7 +129,7 @@ from jc.exceptions import ParseError class info(): """Provides parser metadata (version, author, etc.)""" version = '1.0' - description = '`pidstat` command parser' + description = '`pidstat -h` command parser' author = 'Kelly Brazil' author_email = 'kellyjonbrazil@gmail.com' compatible = ['linux'] diff --git a/jc/parsers/pidstat_s.py b/jc/parsers/pidstat_s.py index 9dac8b6d..ecaa46bb 100644 --- a/jc/parsers/pidstat_s.py +++ b/jc/parsers/pidstat_s.py @@ -1,4 +1,4 @@ -"""jc - JSON Convert `pidstat` command output streaming parser +"""jc - JSON Convert `pidstat -h` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of > Dictionaries (module) @@ -84,7 +84,7 @@ from jc.exceptions import ParseError class info(): """Provides parser metadata (version, author, etc.)""" version = '1.0' - description = '`pidstat` command streaming parser' + description = '`pidstat -h` command streaming parser' author = 'Kelly Brazil' author_email = 'kellyjonbrazil@gmail.com' compatible = ['linux'] diff --git a/jc/parsers/rpm_qi.py b/jc/parsers/rpm_qi.py index fa28f092..612fa31a 100644 --- a/jc/parsers/rpm_qi.py +++ b/jc/parsers/rpm_qi.py @@ -5,7 +5,7 @@ Works with `rpm -qi [package]` or `rpm -qia`. The `..._epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on) -The `..._epoch_utc` calculated timestamp fields are timezone-aware and is +The `..._epoch_utc` calculated timestamp fields are timezone-aware and are only available if the timezone field is UTC. Usage (cli): diff --git a/jc/parsers/xml.py b/jc/parsers/xml.py index e24ae5c9..92f39d8d 100644 --- a/jc/parsers/xml.py +++ b/jc/parsers/xml.py @@ -11,8 +11,8 @@ Usage (module): Schema: - XML Document converted to a Dictionary - See https://github.com/martinblech/xmltodict for details +XML Document converted to a Dictionary. See https://github.com/martinblech/xmltodict +for details. { "key1": string/object, diff --git a/man/jc.1 b/man/jc.1 index 03c331bd..60840f99 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -310,12 +310,12 @@ Key/Value file parser .TP .B \fB--pidstat\fP -`pidstat` command parser +`pidstat -h` command parser .TP .B \fB--pidstat-s\fP -`pidstat` command streaming parser +`pidstat -h` command streaming parser .TP .B