Date: Thu, 12 Oct 2017 16:18:28 +0300 From: Yuri Pankov <yuripv@gmx.com> To: "Sijmen J. Mulder" <ik@sjmulder.nl>, freebsd-questions@freebsd.org Subject: Re: Should I use mdoc for user programs? Message-ID: <ad6d583f-db2e-a149-105d-b7c3b8894959@gmx.com> 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: > Hi, Yes, you should. > Is it considered bad form to use mdoc, rather than some other man > format, for documenting non-system programs? No. > I noticed that the required .Os macro (man 7 mdoc) outputs "FreeBSD > General Commands Manual" which does not seem appropriate. It's not about the .Os macro, rather it's man-section-to-name mapping done by the formatter used, i.e. when using mandoc(1), on FreeBSD section 1 man pages would say "FreeBSD General Commands Manual", on illumos exactly the *same* man page would say just "User Commands" (for mandoc this can be customized editing one of the source files currently). .Os macro defines the OS name shown in the footer, and (yet again) for mandoc default value can be set while compiling.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?ad6d583f-db2e-a149-105d-b7c3b8894959>