Add man page

[nitrocode]

request

This is a nice tool but could you also add a man page to the tool? I ask because it's so handy to run man viddy to get docs like examples to run quickstart commands and the keymaps would be handy.

references

• https://unix.stackexchange.com/a/6892
• https://en.m.wikipedia.org/wiki/Man_page#Layout

[abhaysp95]

Hmm, few questions I have regarding this:

1. I don't see that much need of man page. viddy --help proves to be sufficient, I think (but that's not the point, right ?)
2. What content exactly do you want to be added in man page. I mean, the tool itself isn't having something complicated which would take multiple lines to explain, right ? So, I can't think of anything which will not be redundant.
3. How should it be generated ? Using some go package dependency like md2man or using n/t/g/roff or any other idea ?

[Nudin]

A few thoughts from me:

• It bugs me that for some commands I have to look into man, for some I have to call -h, for others -? and even others --help – in my opinion it is good UX to provide all of them to spare the users from wasting time.
• A man page is usually a longer documentation than what -h gives (especially sine viddy -h currently only prints very spare information)
• Viddy -h currently does not at all tell what viddy is/does.
• Viddy -h does not provide a link to the website (or github repo) of the project (nor does viddy -v)
• To see the keybindings I have to press h in a running viddy. So the documentation is split across two places and I have to guess that h in viddy might show more information.
• The configuration path and format is only docuemented in the repo. Nowhere else
• Man pages have a normalized formatting and by convention a similar structure. This helps to easily find the right information, even in moments of stress.