Date: Thu, 9 Sep 1999 09:16:49 +0400 From: Alexey Zelkin <phantom@cris.net> To: Randall Hopper <aa8vb@ipass.net> Cc: doc@FreeBSD.ORG Subject: Re: Simplest man page source format? Message-ID: <19990909091649.A566@scorpion.crimea.ua> In-Reply-To: <19990908214055.A62660@ipass.net> References: <19990908214055.A62660@ipass.net>
next in thread | previous in thread | raw e-mail | index | archive | help
hi, On Wed, Sep 08, 1999 at 09:40:55PM -0400, Randall Hopper wrote: > Hi. I need to write a man page. I've browsed some of the FreeBSD doc > pages, and I have a question that I couldn't quite find the definitive > answer to. What is the simplest supported source format for writing man > pages? Almost all FreeBSD manpages written with nroff's -mdoc macros package. For general information take a look on mdoc(7) and mdoc.samples(7). mdoc(7) is more general description of -mdoc macro package, mdoc.samples(7) is "examples with descriptions". Examples of manpages for few sections present in /usr/share/examples/mdoc. There are few files like example.1 (example of man page for 1st section, example.2 - 2nd section, etc) located in this directory. And latest point -- /usr/share/misc/mdoc.template. You can write you man page using this template. > Is nroff source format (ala man/man*) the best way to go (hope not), or is > there another more-readable and -writable format such as XML (or SGML?) for > which there might be -to-nroff-source conversion support. I know that there much of nroff->sgml conversion tools, but I did not see sgml->nroff one. > Would appreciate any tips to help stear me in the right direction. Enjoy. -- /* Alexey Zelkin && phantom@cris.net */ /* Tavric National University && phantom@crimea.edu */ /* http://www.ccssu.crimea.ua/~phantom && phantom@FreeBSD.org */ To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?19990909091649.A566>