diff --git a/docs/parsers/asciitable_m.md b/docs/parsers/asciitable_m.md index 8bcf4663..eabc2da0 100644 --- a/docs/parsers/asciitable_m.md +++ b/docs/parsers/asciitable_m.md @@ -30,9 +30,9 @@ headers are joined with an underscore. All values are returned as strings, except empty strings, which are converted to None/null. > Note: table column separator characters (e.g. `|`) cannot be present - inside the cell data. If detected, a warning message will be printed to - STDERR and the line will be skipped. The warning message can be suppressed - by using the `-q` command option or by setting `quiet=True` in `parse()`. +> inside the cell data. If detected, a warning message will be printed to +> STDERR and the line will be skipped. The warning message can be suppressed +> by using the `-q` command option or by setting `quiet=True` in `parse()`. Usage (cli): diff --git a/docs/parsers/csv_s.md b/docs/parsers/csv_s.md index 2b2454b7..7eaf8665 100644 --- a/docs/parsers/csv_s.md +++ b/docs/parsers/csv_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `csv` file streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default diff --git a/docs/parsers/git_log_s.md b/docs/parsers/git_log_s.md index 11c2f6a2..676fd7a8 100644 --- a/docs/parsers/git_log_s.md +++ b/docs/parsers/git_log_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `git log` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Can be used with the following format options: - `oneline` diff --git a/docs/parsers/ini.md b/docs/parsers/ini.md index b0336362..bf1caccc 100644 --- a/docs/parsers/ini.md +++ b/docs/parsers/ini.md @@ -12,8 +12,8 @@ Parses standard `INI` files and files containing simple key/value pairs. - If duplicate keys are found, only the last value will be used. > Note: Values starting and ending with quotation marks will have the marks - removed. If you would like to keep the quotation marks, use the `-r` - command-line argument or the `raw=True` argument in `parse()`. +> removed. If you would like to keep the quotation marks, use the `-r` +> command-line argument or the `raw=True` argument in `parse()`. Usage (cli): diff --git a/docs/parsers/iostat_s.md b/docs/parsers/iostat_s.md index ce678e2f..caced997 100644 --- a/docs/parsers/iostat_s.md +++ b/docs/parsers/iostat_s.md @@ -6,20 +6,20 @@ jc - JSON Convert `iostat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) -Note: `iostat` version 11 and higher include a JSON output option +> Note: `iostat` version 11 and higher include a JSON output option Usage (cli): $ iostat | jc --iostat-s > Note: When piping `jc` converted `iostat` output to other processes it may - appear the output is hanging due to the OS pipe buffers. This is because - `iostat` output is too small to quickly fill up the buffer. Use the `-u` - option to unbuffer the `jc` output if you would like immediate output. See - the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> appear the output is hanging due to the OS pipe buffers. This is because +> `iostat` output is too small to quickly fill up the buffer. Use the `-u` +> option to unbuffer the `jc` output if you would like immediate output. See +> the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module): diff --git a/docs/parsers/kv.md b/docs/parsers/kv.md index 65e8dcdc..2742ae01 100644 --- a/docs/parsers/kv.md +++ b/docs/parsers/kv.md @@ -12,8 +12,8 @@ Supports files containing simple key/value pairs. - If duplicate keys are found, only the last value will be used. > Note: Values starting and ending with quotation marks will have the marks - removed. If you would like to keep the quotation marks, use the `-r` - command-line argument or the `raw=True` argument in `parse()`. +> removed. If you would like to keep the quotation marks, use the `-r` +> command-line argument or the `raw=True` argument in `parse()`. Usage (cli): diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index 511e61fb..a07acf68 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `ls` and `vdir` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`. diff --git a/docs/parsers/mpstat_s.md b/docs/parsers/mpstat_s.md index 3676138a..03c81ee5 100644 --- a/docs/parsers/mpstat_s.md +++ b/docs/parsers/mpstat_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `mpstat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Note: Latest versions of `mpstat` support JSON output (v11.5.1+) diff --git a/docs/parsers/pidstat_s.md b/docs/parsers/pidstat_s.md index b0915e3f..91b46798 100644 --- a/docs/parsers/pidstat_s.md +++ b/docs/parsers/pidstat_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `pidstat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. @@ -16,11 +16,11 @@ Usage (cli): $ pidstat | jc --pidstat-s > Note: When piping `jc` converted `pidstat` output to other processes it - may appear the output is hanging due to the OS pipe buffers. This is - because `pidstat` output is too small to quickly fill up the buffer. Use - the `-u` option to unbuffer the `jc` output if you would like immediate - output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> may appear the output is hanging due to the OS pipe buffers. This is +> because `pidstat` output is too small to quickly fill up the buffer. Use +> the `-u` option to unbuffer the `jc` output if you would like immediate +> output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module): diff --git a/docs/parsers/ping_s.md b/docs/parsers/ping_s.md index 176aa00d..87b9d178 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `ping` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Supports `ping` and `ping6` output. @@ -15,11 +15,11 @@ Usage (cli): $ ping 1.2.3.4 | jc --ping-s > Note: When piping `jc` converted `ping` output to other processes it may - appear the output is hanging due to the OS pipe buffers. This is because - `ping` output is too small to quickly fill up the buffer. Use the `-u` - option to unbuffer the `jc` output if you would like immediate output. - See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> appear the output is hanging due to the OS pipe buffers. This is because +> `ping` output is too small to quickly fill up the buffer. Use the `-u` +> option to unbuffer the `jc` output if you would like immediate output. +> See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module): diff --git a/docs/parsers/rsync_s.md b/docs/parsers/rsync_s.md index 88a04d88..4e62068e 100644 --- a/docs/parsers/rsync_s.md +++ b/docs/parsers/rsync_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `rsync` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Supports the `-i` or `--itemize-changes` options with all levels of verbosity. This parser will process the STDOUT output or a log file diff --git a/docs/parsers/stat_s.md b/docs/parsers/stat_s.md index 569e1a1e..5b4fe7be 100644 --- a/docs/parsers/stat_s.md +++ b/docs/parsers/stat_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `stat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on). diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index de7c11e4..ab794fbd 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -6,7 +6,7 @@ jc - JSON Convert `vmstat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Options supported: `-a`, `-w`, `-d`, `-t` @@ -21,11 +21,11 @@ Usage (cli): $ vmstat | jc --vmstat-s > Note: When piping `jc` converted `vmstat` output to other processes it may - appear the output is hanging due to the OS pipe buffers. This is because - `vmstat` output is too small to quickly fill up the buffer. Use the `-u` - option to unbuffer the `jc` output if you would like immediate output. See - the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> appear the output is hanging due to the OS pipe buffers. This is because +> `vmstat` output is too small to quickly fill up the buffer. Use the `-u` +> option to unbuffer the `jc` output if you would like immediate output. See +> the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module): diff --git a/jc/parsers/asciitable_m.py b/jc/parsers/asciitable_m.py index ed9edba8..7485cdd2 100644 --- a/jc/parsers/asciitable_m.py +++ b/jc/parsers/asciitable_m.py @@ -25,9 +25,9 @@ headers are joined with an underscore. All values are returned as strings, except empty strings, which are converted to None/null. > Note: table column separator characters (e.g. `|`) cannot be present - inside the cell data. If detected, a warning message will be printed to - STDERR and the line will be skipped. The warning message can be suppressed - by using the `-q` command option or by setting `quiet=True` in `parse()`. +> inside the cell data. If detected, a warning message will be printed to +> STDERR and the line will be skipped. The warning message can be suppressed +> by using the `-q` command option or by setting `quiet=True` in `parse()`. Usage (cli): diff --git a/jc/parsers/csv_s.py b/jc/parsers/csv_s.py index 7671c019..828935bb 100644 --- a/jc/parsers/csv_s.py +++ b/jc/parsers/csv_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `csv` file streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) The `csv` streaming parser will attempt to automatically detect the delimiter character. If the delimiter cannot be detected it will default diff --git a/jc/parsers/foo_s.py b/jc/parsers/foo_s.py index ad819830..e1815a13 100644 --- a/jc/parsers/foo_s.py +++ b/jc/parsers/foo_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `foo` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) <> diff --git a/jc/parsers/git_log_s.py b/jc/parsers/git_log_s.py index 66fa2d4f..abd6199c 100644 --- a/jc/parsers/git_log_s.py +++ b/jc/parsers/git_log_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `git log` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Can be used with the following format options: - `oneline` diff --git a/jc/parsers/ini.py b/jc/parsers/ini.py index 8e771a9c..2172c349 100644 --- a/jc/parsers/ini.py +++ b/jc/parsers/ini.py @@ -7,8 +7,8 @@ Parses standard `INI` files and files containing simple key/value pairs. - If duplicate keys are found, only the last value will be used. > Note: Values starting and ending with quotation marks will have the marks - removed. If you would like to keep the quotation marks, use the `-r` - command-line argument or the `raw=True` argument in `parse()`. +> removed. If you would like to keep the quotation marks, use the `-r` +> command-line argument or the `raw=True` argument in `parse()`. Usage (cli): diff --git a/jc/parsers/iostat_s.py b/jc/parsers/iostat_s.py index 161c723f..eb3a72c6 100644 --- a/jc/parsers/iostat_s.py +++ b/jc/parsers/iostat_s.py @@ -1,20 +1,20 @@ """jc - JSON Convert `iostat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) -Note: `iostat` version 11 and higher include a JSON output option +> Note: `iostat` version 11 and higher include a JSON output option Usage (cli): $ iostat | jc --iostat-s > Note: When piping `jc` converted `iostat` output to other processes it may - appear the output is hanging due to the OS pipe buffers. This is because - `iostat` output is too small to quickly fill up the buffer. Use the `-u` - option to unbuffer the `jc` output if you would like immediate output. See - the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> appear the output is hanging due to the OS pipe buffers. This is because +> `iostat` output is too small to quickly fill up the buffer. Use the `-u` +> option to unbuffer the `jc` output if you would like immediate output. See +> the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module): diff --git a/jc/parsers/kv.py b/jc/parsers/kv.py index 9706cfbd..a03b9576 100644 --- a/jc/parsers/kv.py +++ b/jc/parsers/kv.py @@ -7,8 +7,8 @@ Supports files containing simple key/value pairs. - If duplicate keys are found, only the last value will be used. > Note: Values starting and ending with quotation marks will have the marks - removed. If you would like to keep the quotation marks, use the `-r` - command-line argument or the `raw=True` argument in `parse()`. +> removed. If you would like to keep the quotation marks, use the `-r` +> command-line argument or the `raw=True` argument in `parse()`. Usage (cli): diff --git a/jc/parsers/ls_s.py b/jc/parsers/ls_s.py index e727998d..650e30fc 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `ls` and `vdir` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Requires the `-l` option to be used on `ls`. If there are newline characters in the filename, then make sure to use the `-b` option on `ls`. diff --git a/jc/parsers/mpstat_s.py b/jc/parsers/mpstat_s.py index 09aaae09..447ad050 100644 --- a/jc/parsers/mpstat_s.py +++ b/jc/parsers/mpstat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `mpstat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Note: Latest versions of `mpstat` support JSON output (v11.5.1+) diff --git a/jc/parsers/pidstat_s.py b/jc/parsers/pidstat_s.py index 1eba0db5..9dac8b6d 100644 --- a/jc/parsers/pidstat_s.py +++ b/jc/parsers/pidstat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `pidstat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Must use the `-h` option in `pidstat`. All other `pidstat` options are supported in combination with `-h`. @@ -11,11 +11,11 @@ Usage (cli): $ pidstat | jc --pidstat-s > Note: When piping `jc` converted `pidstat` output to other processes it - may appear the output is hanging due to the OS pipe buffers. This is - because `pidstat` output is too small to quickly fill up the buffer. Use - the `-u` option to unbuffer the `jc` output if you would like immediate - output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> may appear the output is hanging due to the OS pipe buffers. This is +> because `pidstat` output is too small to quickly fill up the buffer. Use +> the `-u` option to unbuffer the `jc` output if you would like immediate +> output. See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module): diff --git a/jc/parsers/ping_s.py b/jc/parsers/ping_s.py index 8a57476b..8cb9beb0 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `ping` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Supports `ping` and `ping6` output. @@ -10,11 +10,11 @@ Usage (cli): $ ping 1.2.3.4 | jc --ping-s > Note: When piping `jc` converted `ping` output to other processes it may - appear the output is hanging due to the OS pipe buffers. This is because - `ping` output is too small to quickly fill up the buffer. Use the `-u` - option to unbuffer the `jc` output if you would like immediate output. - See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> appear the output is hanging due to the OS pipe buffers. This is because +> `ping` output is too small to quickly fill up the buffer. Use the `-u` +> option to unbuffer the `jc` output if you would like immediate output. +> See the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module): diff --git a/jc/parsers/rsync_s.py b/jc/parsers/rsync_s.py index 9085aedd..508cce87 100644 --- a/jc/parsers/rsync_s.py +++ b/jc/parsers/rsync_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `rsync` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Supports the `-i` or `--itemize-changes` options with all levels of verbosity. This parser will process the STDOUT output or a log file diff --git a/jc/parsers/stat_s.py b/jc/parsers/stat_s.py index fb19cda6..0c73241b 100644 --- a/jc/parsers/stat_s.py +++ b/jc/parsers/stat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `stat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the local time of the system the parser is run on). diff --git a/jc/parsers/vmstat_s.py b/jc/parsers/vmstat_s.py index f165abc0..638f924b 100644 --- a/jc/parsers/vmstat_s.py +++ b/jc/parsers/vmstat_s.py @@ -1,7 +1,7 @@ """jc - JSON Convert `vmstat` command output streaming parser > This streaming parser outputs JSON Lines (cli) or returns an Iterable of - Dictionaries (module) +> Dictionaries (module) Options supported: `-a`, `-w`, `-d`, `-t` @@ -16,11 +16,11 @@ Usage (cli): $ vmstat | jc --vmstat-s > Note: When piping `jc` converted `vmstat` output to other processes it may - appear the output is hanging due to the OS pipe buffers. This is because - `vmstat` output is too small to quickly fill up the buffer. Use the `-u` - option to unbuffer the `jc` output if you would like immediate output. See - the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) - for more information. +> appear the output is hanging due to the OS pipe buffers. This is because +> `vmstat` output is too small to quickly fill up the buffer. Use the `-u` +> option to unbuffer the `jc` output if you would like immediate output. See +> the [readme](https://github.com/kellyjonbrazil/jc/tree/master#unbuffering-output) +> for more information. Usage (module):