From b724e0969a0d6b22bed0c77eb8d629381179ea3f Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 26 Sep 2021 20:22:16 -0700 Subject: [PATCH 1/2] -qq instead of -q --- docs/parsers/ls_s.md | 2 +- jc/parsers/ls_s.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index e90f7a87..fcb1f889 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -5,7 +5,7 @@ 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`. -The `jc` `-q` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used) +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/ls_s.py b/jc/parsers/ls_s.py index ee009c06..74c53064 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -2,7 +2,7 @@ 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`. -The `jc` `-q` option can be used to ignore parsing errors. (e.g. filenames with newline characters, but `-b` was not used) +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) From 30cff5f28140a5b20a617c8145c13e43b7b6685b Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 27 Sep 2021 10:35:08 -0700 Subject: [PATCH 2/2] add note that the streaming parser outputs JSON Lines --- docs/parsers/ls_s.md | 4 +++- docs/parsers/ping_s.md | 2 ++ docs/parsers/vmstat_s.md | 2 ++ jc/parsers/foo_s.py | 2 ++ jc/parsers/ls_s.py | 4 +++- jc/parsers/ping_s.py | 2 ++ jc/parsers/vmstat_s.py | 2 ++ man/jc.1 | 2 +- 8 files changed, 17 insertions(+), 3 deletions(-) diff --git a/docs/parsers/ls_s.md b/docs/parsers/ls_s.md index fcb1f889..85d923cc 100644 --- a/docs/parsers/ls_s.md +++ b/docs/parsers/ls_s.md @@ -3,7 +3,9 @@ # 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 + +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) 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 74c53064..48e80d57 100644 --- a/jc/parsers/ls_s.py +++ b/jc/parsers/ls_s.py @@ -1,6 +1,8 @@ """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 + +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) 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) diff --git a/man/jc.1 b/man/jc.1 index 405b0143..bb02898a 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2021-09-26 1.17.0 "JSON CLI output utility" +.TH jc 1 2021-09-27 1.17.0 "JSON CLI output utility" .SH NAME jc \- JSONifies the output of many CLI tools and file-types .SH SYNOPSIS