Date: Thu, 12 Oct 2017 11:17:21 +0200 From: Polytropon <freebsd@edvax.de> To: "Sijmen J. Mulder" <ik@sjmulder.nl> Cc: freebsd-questions@freebsd.org Subject: Re: Should I use mdoc for user programs? Message-ID: <20171012111721.509a17b5.freebsd@edvax.de> In-Reply-To: <cd1d3215-bfcd-57bf-89ec-c78981c60381@sjmulder.nl> References: <cd1d3215-bfcd-57bf-89ec-c78981c60381@sjmulder.nl>
next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, 12 Oct 2017 11:02:49 +0200, Sijmen J. Mulder wrote: > Is it considered bad form to use mdoc, rather than some other man > format, for documenting non-system programs? No, many programs from the ports collection provide a manpage in the standard format (for example "man opera" which is far from being a system program). > I noticed that the required .Os macro (man 7 mdoc) outputs "FreeBSD > General Commands Manual" which does not seem appropriate. If I remember correctly, you can easily redefine them: .Dd <date> .Ot <name> <section> "<title of manual page>" .Os <OS> This will generate the following layout: <name>(<section>) <title of manual page> <name>(<section>) ... your manual page text here ... <OS> <date> <OS> If you simply use .Os, the page title will be derived from the 2nd parameter to .Dt, i. e., the section number. -- Polytropon Magdeburg, Germany Happy FreeBSD user since 4.0 Andra moi ennepe, Mousa, ...
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20171012111721.509a17b5.freebsd>