search

rnpgp / rnp

RNP: high performance C++ OpenPGP library used by Mozilla Thunderbird
https://www.rnpgp.org
Other
201 stars 55 forks source link

missing manpages for `rnp` and `rnpkeys` #1407

Closed dkg closed 3 years ago

dkg commented 3 years ago

Debian encourages shipping manual pages for any binary shipped. I aim to ship /usr/bin/rnp and /usr/bin/rnpkeys in an rnp package, but i don't have any manual pages to ship with them.

Do you have any plans to produce manual pages? Man pages generated from the source code itself might be the best way to ensure that the docs are kept up-to-date, but manpages kept in sync with the code by hand can also be fine. I can try to write some manual pages if that would be useful. And i'd be happy to contribute them back upstream, especially if they'll be adopted! If you want me to work on them, do you have a preferred source format and/or document-production workflow?

Left to my own devices with no additional guidance, the man pages I produce will likely be either hand-crafted troff or pandoc-targeted markdown. If you want me to work on it, please let me know if you prefer one of those choices (or something entirely different).

dkg commented 3 years ago

sorry, I now see the troff manpages already shipping (but not installed), in src/rnp/rnp.1 and src/rnpkeys/rnpkeys.1. I'll go ahead and use them directly.

You might want to try to have the default installation step install them as well.

ni4 commented 3 years ago

This man pages are quite outdated, and still needs to be rewritten. I'll handle this via #506