manuals, sum-down, radix

1 files changed, 44 insertions, 0 deletions

diff --git a/man/man1/yamlbrowser.1 b/man/man1/yamlbrowser.1
new file mode 100644
index 0000000..ebd0a7a
--- /dev/null
+++ b/man/man1/yamlbrowser.1
@@ -0,0 +1,44 @@
+.TH yamlbrowser 1 2022-11-20 utils
+
+.SH NAME
+xmlbrowser \- graphical browser for yaml files
+
+.SH SYNOPSIS
+.B yamlbrowser
+.RI [ file\ ... ]
+
+.SH DESCRIPTION
+.B yamlbrowser
+parses the specified YAML files
+and builds a tree
+from the objects,
+even if the file contains a list.
+
+The tree is displayed in a window for easy browsing.
+
+In theory, YAML should be a strict superset of JSON,
+which should make it possible to also browse JSON files
+with
+.BR yamlbrowser .
+In practice, there is a difference between theory and practice.
+In particular, JSON treats all whitespace outside of keys and string values as equivalent, inclusing tabs, but YAML strictly doesn't allow tabs for indentation, so properly formatted JSON can not be read using
+.BR yamlbrowser .
+It needs to be edited first.
+Fortunately, this can be as simple as
+.B tr
+.IR \et\ \e\  ,
+unless the keys or values themselves contain tabs.
+
+.B yamlbrowser
+is implemented as a
+.BR python (1)
+script using qtpy.
+
+Not implemented are a search function,
+and a way to edit the values.
+
+.SH EXAMPLES
+.B yamlbrowser data.yaml
+
+.SH SEE ALSO
+.BR jq (1),\  xmlbrowser (1)