[SLE] SuSE 6.2: man pages -- writing them (ug)
Hello SuSEers Up until now I've managed to avoid writing documentation. Now my place of business is expanding and documentation needs to be written. Yay! I'd like to write info and/or man pages, and although I've read a gazillion info/man pages over the course of 6 years, I have no idea how to _write_ them! Which software packages, under 6.2, are required for this sort of grunt work? Cheers, kw /* ** Keith Warno ** Developer & Sys Admin ** http://www.HaggleWare.com/ */ -- To unsubscribe send e-mail to suse-linux-e-unsubscribe@suse.com For additional commands send e-mail to suse-linux-e-help@suse.com Also check the FAQ at http://www.suse.com/Support/Doku/FAQ/
At 23:55 10-04-00, you wrote:
Hello SuSEers
Up until now I've managed to avoid writing documentation. Now my place of business is expanding and documentation needs to be written. Yay!
I'd like to write info and/or man pages, and although I've read a gazillion info/man pages over the course of 6 years, I have no idea how to _write_ them!
Which software packages, under 6.2, are required for this sort of grunt work?
Since noone else has answered yet, I'll just take a shot at it. Not that I know anything about writing documentation, though. I am almost 100% certain emacs has a mode for this. Also, I seem to remember that man-pages are simple textfiles with a few special groff (or is it nroff or troff?) commands embedded, so youmight want to look into these programs as well. Good luck Regards Ole Kofoed Hansen okh@post.cybercity.dk ICQ# 25773325 -- To unsubscribe send e-mail to suse-linux-e-unsubscribe@suse.com For additional commands send e-mail to suse-linux-e-help@suse.com Also check the FAQ at http://www.suse.com/Support/Doku/FAQ/
Hi, On Mon, Apr 10 2000 at 17:55 -0400, Keith Warno wrote:
I'd like to write info and/or man pages, and although I've read a gazillion info/man pages over the course of 6 years, I have no idea how to _write_ them!
There's an info document that describes how to write info files (see `info texinfo'). I don't know anything comparable for writing man pages, but you can guess how do write one if you look at the source of a man page. Hower, it's much more simple to write your documentation in a documenting language like yodl. A manual page in yodl looks like ------------------------------------------------------> manpage(Test) (1) (April 11, 2000) () () manpagename(Test) (A simple manual page) manpagesynopsis() less test.man manpagedescription() My first manpage. em(underlined) bf(bold) manpageoptions() ... manpagefiles() ... manpageseealso() ... manpagediagnostics() ... manpagesection(MYSECTION) ... manpagebugs() None. manpageauthor() Stefan Troeger <------------------------------------------------------ Save that to a file and convert it using `yodl2man file'. With yodl you can also create info, html and other formats. Ciao, Stefan -- To unsubscribe send e-mail to suse-linux-e-unsubscribe@suse.com For additional commands send e-mail to suse-linux-e-help@suse.com Also check the FAQ at http://www.suse.com/Support/Doku/FAQ/
participants (3)
-
k01164@ko.sdu.dk
-
keith@HaggleWare.com
-
stefan.troeger@wirtschaft.tu-chemnitz.de