Man-page

[leagris]

Add a man-page and TexInfo.
I wish that when installing yq it also setup a proper man-page and optionally a TexInfo documentation, so its usage and short documentation can be read offline with the most common standard Unix/Linux command man.

With pandoc or similar tools into your CI chain
You could automatically transcribe a Markdown documentation into a man-page.
Then have the man page deployed and setup with packaged distributions of yq.

Example with README.md

pandoc --standalone --to man README.md -o yq.1

Automatically create a man page. The README is not the best choice but I cite it as an example:
yq.1.txt

[mikefarah]

This is a neat idea - I've got the man generation just about done, which makes a yq.1 man page file.

Any ideas as to how to distribute this? I'm thinking I'd just gzip as a separate release file...

[gotmax23]

This is a neat idea - I've got the man generation just about done, which makes a yq.1 man page file.

Any ideas as to how to distribute this? I'm thinking I'd just gzip as a separate release file..

Yes, I think that makes sense. I would both offer the yq.1.gz file as a separate file and include it along with the binaries in the .tar.gz archives. You should also instruct users to copy the file to /usr/local/share/man/man1 (software that is not managed by the package manager should be copied to /usr/local as opposed to /usr).

[mikefarah]

Fixed in 4.13.15