Bläddra i källkod

jp: add man page

Cesar Torres 4 år sedan
förälder
incheckning
6179c9ad25
1 ändrade filer med 35 tillägg och 0 borttagningar
  1. 35 0
      Base/usr/share/man/man1/jp.md

+ 35 - 0
Base/usr/share/man/man1/jp.md

@@ -0,0 +1,35 @@
+## 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
+```