improve documentation, reference man page in the README - json2tsv - JSON to TSV converter
(HTM) git clone git://git.codemadness.org/json2tsv
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 79e73bfa51005f9b760c01117f4decce4435fe29
(DIR) parent 60cdcd6ec005e72e168f0318228371471121ad9b
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sun, 6 Oct 2019 16:31:37 +0200
improve documentation, reference man page in the README
Diffstat:
M README | 10 ++--------
M json2tsv.1 | 13 ++++++++++---
2 files changed, 12 insertions(+), 11 deletions(-)
---
(DIR) diff --git a/README b/README
@@ -21,6 +21,8 @@ false, null, a number) or s (for string).
Then filtering is easy using some awk script on the node "selector".
+See the json2tsv(1) man page for the full documentation.
+
Example
-------
@@ -58,14 +60,6 @@ END {
}'
-Caveats
--------
-
-- Characters in keys that have meaning in the first node field such as a dot or
- brackets are not changed.
-- The maximum depth of objects or arrays is hard-coded to 32 levels deep.
-
-
License
-------
(DIR) diff --git a/json2tsv.1 b/json2tsv.1
@@ -1,4 +1,4 @@
-.Dd October 1, 2019
+.Dd October 6, 2019
.Dt JSON2TSV 1
.Os
.Sh NAME
@@ -31,6 +31,13 @@ true, false, null, a number) or s (for string).
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
.Sh CAVEATS
-Characters in keys that have meaning in the first node field such as a dot or
-brackets are not changed.
+.Bl -item
+.It
+Characters in object keys such as a dot or brackets are not changed, this
+can change the meaning of the nodename field.
+.It
+The JSON parser handles all valid JSON.
+It also handles some invalid JSON like object key strings without quoting (").
+.It
The maximum depth of objects or arrays is hard-coded to 32 levels deep.
+.El