From e52f0a991b698db28e8712adc4ccebb2efc42d08 Mon Sep 17 00:00:00 2001 From: Liav A Date: Sat, 22 Oct 2022 06:58:09 +0300 Subject: [PATCH] Base: Rename jp(1) manual page to json(1) --- Base/usr/share/man/man1/jp.md | 35 ----------------------------- Base/usr/share/man/man1/json.md | 39 +++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 35 deletions(-) delete mode 100644 Base/usr/share/man/man1/jp.md create mode 100644 Base/usr/share/man/man1/json.md diff --git a/Base/usr/share/man/man1/jp.md b/Base/usr/share/man/man1/jp.md deleted file mode 100644 index 42407c02b6..0000000000 --- a/Base/usr/share/man/man1/jp.md +++ /dev/null @@ -1,35 +0,0 @@ -## Name - -jp - pretty-print a JSON file with syntax-coloring and indentation - -## Synopsis - -```**sh -$ jp [options...] [path...] -``` - -## Description - -`jp` pretty-prints a JSON file with syntax-coloring and indentation. - -If no *path* argument is provided stdin is used. - -## Options - -* `--help`: Display this message -* `-i`, `--indent-size`: Size of indentations in spaces - -## Arguments - -* `path`: file to pretty-print - -## Examples - -```sh -# Pretty-print stdin -$ cat /proc/all | jp -# Pretty-print a file -$ jp json-data.json -# Pretty-print a file with two spaces per indent -$ jp -i 2 json-data.json -``` diff --git a/Base/usr/share/man/man1/json.md b/Base/usr/share/man/man1/json.md new file mode 100644 index 0000000000..d420ad8fdd --- /dev/null +++ b/Base/usr/share/man/man1/json.md @@ -0,0 +1,39 @@ +## Name + +json - pretty-print a JSON file with syntax-coloring and indentation + +## Synopsis + +```**sh +$ json [options...] [path...] +``` + +## Description + +`json` pretty-prints a JSON file with syntax-coloring and indentation. + +If no *path* argument is provided stdin is used. + +## Options + +* `--help`: Display this message +* `-i`, `--indent-size`: Size of indentations in spaces +* `-q`, `--query`: Dotted query key + +## Arguments + +* `path`: file to pretty-print + +## Examples + +```sh +# Pretty-print stdin +$ cat /proc/all | json +# Pretty-print a file +$ json json-data.json +# Pretty-print a file with two spaces per indent +$ json -i 2 json-data.json +# Query data from JSON +$ json -q 1 .config/CommonLocations.json +$ cat /proc/all | json -q processes +```