Should I use mdoc for user programs?
yuripv at gmx.com
Thu Oct 12 18:40:00 UTC 2017
On Thu, 12 Oct 2017 20:09:41 +0200, Polytropon wrote:
> On Thu, 12 Oct 2017 16:18:28 +0300, Yuri Pankov wrote:
>> On Thu, 12 Oct 2017 11:02:49 +0200, Sijmen J. Mulder wrote:
>>> 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).
> According to "man mdoc", it's easy to redefine .Dt at the beginning
> of the document (just like .Dt or Dd).
Indeed, my answer was more about that output shouldn't stop the OP from
using mdoc. And redefining the section name rarely serves any purpose;
if you absolutely need it, go with a new section (yes, I know it's bad).
More information about the freebsd-questions