diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 7eaf8665..83c9c1c5 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -12,8 +12,8 @@ The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default to comma. The first row of the file must be a header row. -Note: The first 100 rows are read into memory to enable delimiter detection, -then the rest of the rows are loaded lazily. +> Note: The first 100 rows are read into memory to enable delimiter +> detection, then the rest of the rows are loaded lazily. Usage (cli): diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index 0fba185c..97fc6d34 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -5,7 +5,7 @@ jc - JSON Convert `ifconfig` command output parser -Note: No `ifconfig` options are supported. +> Note: No `ifconfig` options are supported. Usage (cli): diff --git a/docs/parsers/iostat.md b/docs/parsers/iostat.md index fcd4df50..e2792155 100644 --- a/docs/parsers/iostat.md +++ b/docs/parsers/iostat.md @@ -5,7 +5,7 @@ jc - JSON Convert `iostat` command output parser -Note: `iostat` version 11 and higher include a JSON output option +> Note: `iostat` version 11 and higher include a JSON output option Usage (cli): diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index 8c913534..b68c26c5 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -9,11 +9,12 @@ Options supported: - `lbaR1` - `--time-style=full-iso` -Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly -parse filenames that include newline characters. Since `ls` does not encode -newlines in filenames when outputting to a pipe it will cause `jc` to see -multiple files instead of a single file if `-1`, `-l`, or `-b` is not used. -Alternatively, `vdir` can be used, which is the same as running `ls -lb`. +> Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly +> parse filenames that include newline characters. Since `ls` does not +> encode newlines in filenames when outputting to a pipe it will cause `jc` +> to see multiple files instead of a single file if `-1`, `-l`, or `-b` is +> not used. Alternatively, `vdir` can be used, which is the same as running +> `ls -lb`. The `epoch` calculated timestamp field is naive. (i.e. based on the local time of the system the parser is run on) diff --git a/docs/parsers/lsusb.md b/docs/parsers/lsusb.md index 04f40f96..84033124 100644 --- a/docs/parsers/lsusb.md +++ b/docs/parsers/lsusb.md @@ -22,9 +22,9 @@ Usage (module): Schema: - Note: object keynames are assigned directly from the lsusb - output. If there are duplicate names in a section, only the - last one is converted. +> Note: object keynames are assigned directly from the lsusb +> output. If there are duplicate names in a section, only the +> last one is converted. [ { diff --git a/docs/parsers/mpstat.md b/docs/parsers/mpstat.md index c16f5ab0..5a1de6ef 100644 --- a/docs/parsers/mpstat.md +++ b/docs/parsers/mpstat.md @@ -5,7 +5,7 @@ jc - JSON Convert `mpstat` command output parser -Note: Latest versions of `mpstat` support JSON output (v11.5.1+) +> Note: Latest versions of `mpstat` support JSON output (v11.5.1+) Usage (cli): diff --git a/docs/parsers/mpstat_s.md b/docs/parsers/mpstat_s.md index 03c81ee5..c3efcef3 100644 --- a/docs/parsers/mpstat_s.md +++ b/docs/parsers/mpstat_s.md @@ -8,7 +8,7 @@ jc - JSON Convert `mpstat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of > Dictionaries (module) -Note: Latest versions of `mpstat` support JSON output (v11.5.1+) +> Note: Latest versions of `mpstat` support JSON output (v11.5.1+) Usage (cli): diff --git a/docs/parsers/ss.md b/docs/parsers/ss.md index 22257d6d..826f54e7 100644 --- a/docs/parsers/ss.md +++ b/docs/parsers/ss.md @@ -5,8 +5,8 @@ jc - JSON Convert `ss` command output parser -Extended information options like -e and -p are not supported and may cause -parsing irregularities. +Extended information options like `-e` and `-p` are not supported and may +cause parsing irregularities. Usage (cli): @@ -23,8 +23,8 @@ Usage (module): Schema: - Information from https://www.cyberciti.biz/files/ss.html used to define - field names +Information from https://www.cyberciti.biz/files/ss.html used to define +field names [ { diff --git a/docs/parsers/sysctl.md b/docs/parsers/sysctl.md index d72754ab..1481e0b1 100644 --- a/docs/parsers/sysctl.md +++ b/docs/parsers/sysctl.md @@ -5,10 +5,10 @@ jc - JSON Convert `sysctl -a` command output parser -Note: Since `sysctl` output is not easily parsable only a very simple - key/value object will be output. An attempt is made to convert obvious - integers and floats. If no conversion is desired, use the `-r` - command-line argument or the `raw=True` argument in `parse()`. +> Note: Since `sysctl` output is not easily parsable only a very simple +> key/value object will be output. An attempt is made to convert obvious +> integers and floats. If no conversion is desired, use the `-r` +> command-line argument or the `raw=True` argument in `parse()`. Usage (cli): diff --git a/docs/parsers/time.md b/docs/parsers/time.md index 6ad20f07..25185ec3 100644 --- a/docs/parsers/time.md +++ b/docs/parsers/time.md @@ -5,14 +5,14 @@ jc - JSON Convert `/usr/bin/time` command output parser -Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be +Output from `/usr/bin/time` is sent to STDERR, so the `-o` option can be used to redirect the output to a file that can be read by `jc`. -Alternatively, the output from `/usr/bin/time` can be redirected to `STDOUT` +Alternatively, the output from `/usr/bin/time` can be redirected to STDOUT so `jc` can receive it. -Note: `/usr/bin/time` is similar but different from the Bash builtin - `time` command. +> Note: `/usr/bin/time` is similar but different from the Bash builtin +> `time` command. Usage (cli): @@ -26,8 +26,8 @@ Usage (module): Schema: - Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage - https://man7.org/linux/man-pages/man1/time.1.html +Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage, +https://man7.org/linux/man-pages/man1/time.1.html { "real_time": float, diff --git a/docs/parsers/top.md b/docs/parsers/top.md index c9017000..51d0cc96 100644 --- a/docs/parsers/top.md +++ b/docs/parsers/top.md @@ -26,7 +26,7 @@ Usage (module): Schema: - All `-` values are converted to `null` +All `-` values are converted to `null` [ { diff --git a/docs/parsers/traceroute.md b/docs/parsers/traceroute.md index 3bf314c8..e88071be 100644 --- a/docs/parsers/traceroute.md +++ b/docs/parsers/traceroute.md @@ -7,12 +7,12 @@ jc - JSON Convert `traceroute` command output parser Supports `traceroute` and `traceroute6` output. -Note: On some operating systems you will need to redirect `STDERR` to - `STDOUT` for destination info since the header line is sent to - `STDERR`. A warning message will be printed to `STDERR` if the - header row is not found. - - e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` +> Note: On some operating systems you will need to redirect `STDERR` to +> `STDOUT` for destination info since the header line is sent to +> `STDERR`. A warning message will be printed to `STDERR` if the +> header row is not found. +> +> e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` Usage (cli): diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index fba8c10a..c01eeb59 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -5,7 +5,7 @@ jc - JSON Convert `uname -a` command output parser -Note: Must use `uname -a` +> Note: Must use `uname -a` Usage (cli): diff --git a/docs/parsers/yaml.md b/docs/parsers/yaml.md index bf98d5da..9c807905 100644 --- a/docs/parsers/yaml.md +++ b/docs/parsers/yaml.md @@ -5,7 +5,7 @@ jc - JSON Convert `YAML` file parser -Note: datetime objects will be converted to strings. +> Note: `datetime` objects will be converted to strings. Usage (cli): diff --git a/docs/parsers/zipinfo.md b/docs/parsers/zipinfo.md index 921caf49..781b1cb6 100644 --- a/docs/parsers/zipinfo.md +++ b/docs/parsers/zipinfo.md @@ -5,10 +5,7 @@ jc - JSON Convert `zipinfo` command output parser -Options supported: -- none - -Note: The default listing format. +> Note: No `zipinfo` options are supported. Usage (cli): diff --git a/jc/parsers/csv_s.py b/jc/parsers/csv_s.py index 828935bb..61f470bc 100644 --- a/jc/parsers/csv_s.py +++ b/jc/parsers/csv_s.py @@ -7,8 +7,8 @@ The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default to comma. The first row of the file must be a header row. -Note: The first 100 rows are read into memory to enable delimiter detection, -then the rest of the rows are loaded lazily. +> Note: The first 100 rows are read into memory to enable delimiter +> detection, then the rest of the rows are loaded lazily. Usage (cli): diff --git a/jc/parsers/ifconfig.py b/jc/parsers/ifconfig.py index 7a125a18..65a95893 100644 --- a/jc/parsers/ifconfig.py +++ b/jc/parsers/ifconfig.py @@ -1,6 +1,6 @@ """jc - JSON Convert `ifconfig` command output parser -Note: No `ifconfig` options are supported. +> Note: No `ifconfig` options are supported. Usage (cli): diff --git a/jc/parsers/iostat.py b/jc/parsers/iostat.py index 4eeb2add..8474ca0d 100644 --- a/jc/parsers/iostat.py +++ b/jc/parsers/iostat.py @@ -1,6 +1,6 @@ """jc - JSON Convert `iostat` command output parser -Note: `iostat` version 11 and higher include a JSON output option +> Note: `iostat` version 11 and higher include a JSON output option Usage (cli): diff --git a/jc/parsers/ls.py b/jc/parsers/ls.py index 981f8d5b..92de479d 100644 --- a/jc/parsers/ls.py +++ b/jc/parsers/ls.py @@ -4,11 +4,12 @@ Options supported: - `lbaR1` - `--time-style=full-iso` -Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly -parse filenames that include newline characters. Since `ls` does not encode -newlines in filenames when outputting to a pipe it will cause `jc` to see -multiple files instead of a single file if `-1`, `-l`, or `-b` is not used. -Alternatively, `vdir` can be used, which is the same as running `ls -lb`. +> Note: The `-1`, `-l`, or `-b` option of `ls` should be used to correctly +> parse filenames that include newline characters. Since `ls` does not +> encode newlines in filenames when outputting to a pipe it will cause `jc` +> to see multiple files instead of a single file if `-1`, `-l`, or `-b` is +> not used. Alternatively, `vdir` can be used, which is the same as running +> `ls -lb`. The `epoch` calculated timestamp field is naive. (i.e. based on the local time of the system the parser is run on) diff --git a/jc/parsers/lsusb.py b/jc/parsers/lsusb.py index 397f934e..be175147 100644 --- a/jc/parsers/lsusb.py +++ b/jc/parsers/lsusb.py @@ -17,9 +17,9 @@ Usage (module): Schema: - Note: object keynames are assigned directly from the lsusb - output. If there are duplicate names in a section, only the - last one is converted. +> Note: object keynames are assigned directly from the lsusb +> output. If there are duplicate names in a section, only the +> last one is converted. [ { diff --git a/jc/parsers/mpstat.py b/jc/parsers/mpstat.py index 1e5116e3..896328d1 100644 --- a/jc/parsers/mpstat.py +++ b/jc/parsers/mpstat.py @@ -1,6 +1,6 @@ """jc - JSON Convert `mpstat` command output parser -Note: Latest versions of `mpstat` support JSON output (v11.5.1+) +> Note: Latest versions of `mpstat` support JSON output (v11.5.1+) Usage (cli): diff --git a/jc/parsers/mpstat_s.py b/jc/parsers/mpstat_s.py index 447ad050..4e8e5769 100644 --- a/jc/parsers/mpstat_s.py +++ b/jc/parsers/mpstat_s.py @@ -3,7 +3,7 @@ > This streaming parser outputs JSON Lines (cli) or returns an Iterable of > Dictionaries (module) -Note: Latest versions of `mpstat` support JSON output (v11.5.1+) +> Note: Latest versions of `mpstat` support JSON output (v11.5.1+) Usage (cli): diff --git a/jc/parsers/ss.py b/jc/parsers/ss.py index 5d922c12..4c4b3b45 100644 --- a/jc/parsers/ss.py +++ b/jc/parsers/ss.py @@ -1,7 +1,7 @@ """jc - JSON Convert `ss` command output parser -Extended information options like -e and -p are not supported and may cause -parsing irregularities. +Extended information options like `-e` and `-p` are not supported and may +cause parsing irregularities. Usage (cli): @@ -18,8 +18,8 @@ Usage (module): Schema: - Information from https://www.cyberciti.biz/files/ss.html used to define - field names +Information from https://www.cyberciti.biz/files/ss.html used to define +field names [ { diff --git a/jc/parsers/sysctl.py b/jc/parsers/sysctl.py index abb85fd1..36ac93c0 100644 --- a/jc/parsers/sysctl.py +++ b/jc/parsers/sysctl.py @@ -1,9 +1,9 @@ """jc - JSON Convert `sysctl -a` command output parser -Note: Since `sysctl` output is not easily parsable only a very simple - key/value object will be output. An attempt is made to convert obvious - integers and floats. If no conversion is desired, use the `-r` - command-line argument or the `raw=True` argument in `parse()`. +> Note: Since `sysctl` output is not easily parsable only a very simple +> key/value object will be output. An attempt is made to convert obvious +> integers and floats. If no conversion is desired, use the `-r` +> command-line argument or the `raw=True` argument in `parse()`. Usage (cli): diff --git a/jc/parsers/time.py b/jc/parsers/time.py index a0ad598e..ed2b6dab 100644 --- a/jc/parsers/time.py +++ b/jc/parsers/time.py @@ -1,13 +1,13 @@ """jc - JSON Convert `/usr/bin/time` command output parser -Output from `/usr/bin/time` is sent to `STDERR`, so the `-o` option can be +Output from `/usr/bin/time` is sent to STDERR, so the `-o` option can be used to redirect the output to a file that can be read by `jc`. -Alternatively, the output from `/usr/bin/time` can be redirected to `STDOUT` +Alternatively, the output from `/usr/bin/time` can be redirected to STDOUT so `jc` can receive it. -Note: `/usr/bin/time` is similar but different from the Bash builtin - `time` command. +> Note: `/usr/bin/time` is similar but different from the Bash builtin +> `time` command. Usage (cli): @@ -21,8 +21,8 @@ Usage (module): Schema: - Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage - https://man7.org/linux/man-pages/man1/time.1.html +Source: https://www.freebsd.org/cgi/man.cgi?query=getrusage, +https://man7.org/linux/man-pages/man1/time.1.html { "real_time": float, diff --git a/jc/parsers/top.py b/jc/parsers/top.py index 443a41cb..5ac2e067 100644 --- a/jc/parsers/top.py +++ b/jc/parsers/top.py @@ -21,7 +21,7 @@ Usage (module): Schema: - All `-` values are converted to `null` +All `-` values are converted to `null` [ { diff --git a/jc/parsers/traceroute.py b/jc/parsers/traceroute.py index 913aa34b..f60c3583 100644 --- a/jc/parsers/traceroute.py +++ b/jc/parsers/traceroute.py @@ -2,12 +2,12 @@ Supports `traceroute` and `traceroute6` output. -Note: On some operating systems you will need to redirect `STDERR` to - `STDOUT` for destination info since the header line is sent to - `STDERR`. A warning message will be printed to `STDERR` if the - header row is not found. - - e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` +> Note: On some operating systems you will need to redirect `STDERR` to +> `STDOUT` for destination info since the header line is sent to +> `STDERR`. A warning message will be printed to `STDERR` if the +> header row is not found. +> +> e.g. `$ traceroute 8.8.8.8 2>&1 | jc --traceroute` Usage (cli): diff --git a/jc/parsers/uname.py b/jc/parsers/uname.py index e6d709a6..7be86482 100644 --- a/jc/parsers/uname.py +++ b/jc/parsers/uname.py @@ -1,6 +1,6 @@ """jc - JSON Convert `uname -a` command output parser -Note: Must use `uname -a` +> Note: Must use `uname -a` Usage (cli): diff --git a/jc/parsers/yaml.py b/jc/parsers/yaml.py index 21b84d14..cc962c60 100644 --- a/jc/parsers/yaml.py +++ b/jc/parsers/yaml.py @@ -1,6 +1,6 @@ """jc - JSON Convert `YAML` file parser -Note: datetime objects will be converted to strings. +> Note: `datetime` objects will be converted to strings. Usage (cli): diff --git a/jc/parsers/zipinfo.py b/jc/parsers/zipinfo.py index f52e7baa..33599090 100644 --- a/jc/parsers/zipinfo.py +++ b/jc/parsers/zipinfo.py @@ -1,9 +1,6 @@ """jc - JSON Convert `zipinfo` command output parser -Options supported: -- none - -Note: The default listing format. +> Note: No `zipinfo` options are supported. Usage (cli):