1
0
mirror of https://github.com/kellyjonbrazil/jc.git synced 2025-06-17 00:07:37 +02:00

simplify streaming docs

This commit is contained in:
Kelly Brazil
2022-04-28 13:38:24 -07:00
parent 5c749fe26f
commit 3e7f284df5
19 changed files with 38 additions and 38 deletions

View File

@ -5,8 +5,8 @@
jc - JSON Convert `csv` file streaming parser jc - JSON Convert `csv` file streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
The `csv` streaming parser will attempt to automatically detect the The `csv` streaming parser will attempt to automatically detect the
delimiter character. If the delimiter cannot be detected it will default delimiter character. If the delimiter cannot be detected it will default

View File

@ -5,8 +5,8 @@
jc - JSON Convert `iostat` command output streaming parser jc - JSON Convert `iostat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator 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

View File

@ -5,8 +5,8 @@
jc - JSON Convert `ls` and `vdir` command output streaming parser jc - JSON Convert `ls` and `vdir` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Requires the `-l` option to be used on `ls`. If there are newline characters 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`. in the filename, then make sure to use the `-b` option on `ls`.

View File

@ -5,8 +5,8 @@
jc - JSON Convert `mpstat` command output streaming parser jc - JSON Convert `mpstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Note: Latest versions of `mpstat` support JSON output (v11.5.1+) Note: Latest versions of `mpstat` support JSON output (v11.5.1+)

View File

@ -5,8 +5,8 @@
jc - JSON Convert `pidstat` command output streaming parser jc - JSON Convert `pidstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Must use the `-h` option in `pidstat`. All other `pidstat` options are Must use the `-h` option in `pidstat`. All other `pidstat` options are
supported in combination with `-h`. supported in combination with `-h`.

View File

@ -5,8 +5,8 @@
jc - JSON Convert `ping` command output streaming parser jc - JSON Convert `ping` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Supports `ping` and `ping6` output. Supports `ping` and `ping6` output.

View File

@ -5,8 +5,8 @@
jc - JSON Convert `rsync` command output streaming parser jc - JSON Convert `rsync` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Supports the `-i` or `--itemize-changes` options with all levels of Supports the `-i` or `--itemize-changes` options with all levels of
verbosity. This parser will process the STDOUT output or a log file verbosity. This parser will process the STDOUT output or a log file

View File

@ -5,8 +5,8 @@
jc - JSON Convert `stat` command output streaming parser jc - JSON Convert `stat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the
local time of the system the parser is run on). local time of the system the parser is run on).

View File

@ -5,8 +5,8 @@
jc - JSON Convert `vmstat` command output streaming parser jc - JSON Convert `vmstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Options supported: `-a`, `-w`, `-d`, `-t` Options supported: `-a`, `-w`, `-d`, `-t`

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `csv` file streaming parser """jc - JSON Convert `csv` file streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
The `csv` streaming parser will attempt to automatically detect the The `csv` streaming parser will attempt to automatically detect the
delimiter character. If the delimiter cannot be detected it will default delimiter character. If the delimiter cannot be detected it will default

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `foo` command output streaming parser """jc - JSON Convert `foo` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
<<Short foo description and caveats>> <<Short foo description and caveats>>

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `iostat` command output streaming parser """jc - JSON Convert `iostat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator 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

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `ls` and `vdir` command output streaming parser """jc - JSON Convert `ls` and `vdir` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Requires the `-l` option to be used on `ls`. If there are newline characters 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`. in the filename, then make sure to use the `-b` option on `ls`.

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `mpstat` command output streaming parser """jc - JSON Convert `mpstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Note: Latest versions of `mpstat` support JSON output (v11.5.1+) Note: Latest versions of `mpstat` support JSON output (v11.5.1+)

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `pidstat` command output streaming parser """jc - JSON Convert `pidstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Must use the `-h` option in `pidstat`. All other `pidstat` options are Must use the `-h` option in `pidstat`. All other `pidstat` options are
supported in combination with `-h`. supported in combination with `-h`.

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `ping` command output streaming parser """jc - JSON Convert `ping` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Supports `ping` and `ping6` output. Supports `ping` and `ping6` output.

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `rsync` command output streaming parser """jc - JSON Convert `rsync` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Supports the `-i` or `--itemize-changes` options with all levels of Supports the `-i` or `--itemize-changes` options with all levels of
verbosity. This parser will process the STDOUT output or a log file verbosity. This parser will process the STDOUT output or a log file

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `stat` command output streaming parser """jc - JSON Convert `stat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the The `xxx_epoch` calculated timestamp fields are naive. (i.e. based on the
local time of the system the parser is run on). local time of the system the parser is run on).

View File

@ -1,7 +1,7 @@
"""jc - JSON Convert `vmstat` command output streaming parser """jc - JSON Convert `vmstat` command output streaming parser
> This streaming parser outputs JSON Lines (cli) or returns a Generator > This streaming parser outputs JSON Lines (cli) or returns an Iterable of
iterator of Dictionaries (module) Dictionaries (module)
Options supported: `-a`, `-w`, `-d`, `-t` Options supported: `-a`, `-w`, `-d`, `-t`