diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index e90f7a87..85d923cc 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -3,9 +3,11 @@ # jc.parsers.ls_s jc - JSON CLI output utility `ls` and `vdir` command output streaming parser -This streaming parser 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`. +> This streaming parser outputs JSON Lines -The `jc` `-q` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used) +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`. + +The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used) 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/ping_s.md b/docs/parsers/ping_s.md index ea113fc9..352b3ae9 100644 --- a/docs/parsers/ping_s.md +++ b/docs/parsers/ping_s.md @@ -3,6 +3,8 @@ # jc.parsers.ping_s jc - JSON CLI output utility `ping` command output streaming parser +> This streaming parser outputs JSON Lines + Supports `ping` and `ping6` output. Usage (cli): diff --git a/docs/parsers/vmstat_s.md b/docs/parsers/vmstat_s.md index 117ef8de..4cfdc858 100644 --- a/docs/parsers/vmstat_s.md +++ b/docs/parsers/vmstat_s.md @@ -3,6 +3,8 @@ # jc.parsers.vmstat_s jc - JSON CLI output utility `vmstat` command output streaming parser +> This streaming parser outputs JSON Lines + Options supported: `-a`, `-w`, `-d`, `-t` 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/foo_s.py b/jc/parsers/foo_s.py index f3789b7e..4b79dd3f 100644 --- a/jc/parsers/foo_s.py +++ b/jc/parsers/foo_s.py @@ -1,5 +1,7 @@ """jc - JSON CLI output utility `foo` command output streaming parser +> This streaming parser outputs JSON Lines + <> Usage (cli): diff --git a/jc/parsers/ls_s.py b/jc/parsers/ls_s.py index ee009c06..48e80d57 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -1,8 +1,10 @@ """jc - JSON CLI output utility `ls` and `vdir` command output streaming parser -This streaming parser 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`. +> This streaming parser outputs JSON Lines -The `jc` `-q` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used) +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`. + +The `jc` `-qq` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used) 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/ping_s.py b/jc/parsers/ping_s.py index 54819399..1f335c4e 100644 --- a/jc/parsers/ping_s.py +++ b/jc/parsers/ping_s.py @@ -1,5 +1,7 @@ """jc - JSON CLI output utility `ping` command output streaming parser +> This streaming parser outputs JSON Lines + Supports `ping` and `ping6` output. Usage (cli): diff --git a/jc/parsers/vmstat_s.py b/jc/parsers/vmstat_s.py index 81967ae2..6697f082 100644 --- a/jc/parsers/vmstat_s.py +++ b/jc/parsers/vmstat_s.py @@ -1,5 +1,7 @@ """jc - JSON CLI output utility `vmstat` command output streaming parser +> This streaming parser outputs JSON Lines + Options supported: `-a`, `-w`, `-d`, `-t` The `epoch` calculated timestamp field is naive (i.e. based on the local time of the system the parser is run on)