CLI: man pages

[jsimnz]

Generate man pages docs for defra on unix systems

[orpheuslummis]

preliminary search on this yields:

• official Go take on this is to not support man pages doc: manual pages for Go tools golang/go#101 (opened in 2009 and 'decided no' in 2021)
• https://github.com/appliedgocode/goman to implement it perhaps

[orpheuslummis]

https://github.com/spf13/cobra/blob/master/doc/man_docs.md

[shahzadlone]

It's 2021 and there are many other valid forms of documentation.
Not everything has to fit into the man page format, the affection I have for it notwithstanding.
It's safe to say we're not going to take the time to adopt and maintain a solution ourselves here.
Closing this issue.

This comment triggers me :,). You can't paint every project with the same brush. Some programs may need to run somewhere where there is no GUI available and you have to stick to a terminal, man pages can be life savers in those cases and not to mention really quick to learn how to use a program. While I agree that 'not everything has to fit into the man page format`, that doesn't mean that man pages can't be useful to have for certain scenarios.

[shahzadlone]

The cobra approach seemed nice when I went over it, and also seems the easiest to maintain and install. However I haven't tested it myself. Excited to see this implemented :)