canonical / mir

The Mir compositor
GNU General Public License v2.0
603 stars 97 forks source link

manpages & help #1610

Open AlanGriffiths opened 3 years ago

AlanGriffiths commented 3 years ago

This came up with 1.8 landing in Debian. From IRC:

https://salsa.debian.org/mir-server-team/mir/-/tree/master/debian/man/man1 the man pages have been writte manually in groff. If you want to keep them that way, that's fine. Other option is help2man, but your --help outputs vary and it was not possible to crank help2man with its options to understand all parts of your --help output of all the scripts. It's a bit of a mess anyway. Our PPA packaging differs from the Ubuntu archive personally, I'd go for standardizing --help output and find good options for help2man. Then the man page problem is gone forever (because you can auto-generate them with every build).
AlanGriffiths commented 3 years ago

When addressing this, also consider #1043