man pages
Little Girl
littlergirl at gmail.com
Fri Sep 27 04:09:14 UTC 2013
Hey there,
Nathan Handler wrote:
> If you are serious about this, I would recommend looking at [1]. it
> provides a few notes about how to submit your manpage so the Debian
> package maintainer sees it (submitting it to Debian will be more
> beneficial than submitting it directly in Ubuntu). It also contains
> a list of packages that are missing manpages.
>
> [1] http://qa.debian.org/man-pages.html
I did a bit of research to figure out the structure of a man page. I
think I have a good understanding of it, but wanted to double check
with you (and anyone else who's interested and reading along) to make
sure.
I created a fully commented .t2t source file (using the txt2tags
markup language, from the package manager), an .html file, and a .man
page of each of these:
- an example of the minimum requirements for a man page.
- an example of the maximum options available for a man page.
- a new ktrash man page.
They're in a .zip file on my Box account:
https://app.box.com/s/hr4utykhzbjrk83apehs
I'd appreciate it if you (and any of the interested onlookers) would
look them over and make sure they're solid. If they're not, please
let me know what needs to change. If they're good, then I can submit
the ktrash one immediately and do more man pages like it.
Also, if you (or any of those interested onlookers) could help out in
coming up with generic examples for all of the spots where I put NEED
EXAMPLE HERE, I'd appreciate the assistance.
This is actually quite fun, so if anyone would like to join me in
nibbling away at the missing man pages, go for it. The more, the
merrier. (:
--
Little Girl
There is no spoon.
More information about the ubuntu-doc
mailing list