Manual Pages
August 15th, 2009
The day has come, and I’ve started writing documentation, but this time Linux style. In other words, I’ve just created the manual pages for my Newbie-projects, “ogc” and “go“.
Some important points I’ve learned from the Linux Man Page Howto:
Manual pages are written in the “groff” (GNU troff) markup language. Just start from another program’s man page, it’ll be easy.
Manual pages of user-commands shall be installed into “/usr/share/man/man1″
The manual page of user-program “foo” shall be called either “foo.1″ or “foo.1.gz” (gzipped).
To read foo’s manual page, type
man foo
It’s that easy.
