From owner-freebsd-questions@freebsd.org  Thu Oct 12 09:17:33 2017
Return-Path: <owner-freebsd-questions@freebsd.org>
Delivered-To: freebsd-questions@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 24D44E49269
 for <freebsd-questions@mailman.ysv.freebsd.org>;
 Thu, 12 Oct 2017 09:17:33 +0000 (UTC)
 (envelope-from freebsd@edvax.de)
Received: from mailrelay12.qsc.de (mailrelay12.qsc.de [212.99.163.153])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client CN "*.antispameurope.com",
 Issuer "TeleSec ServerPass DE-2" (verified OK))
 by mx1.freebsd.org (Postfix) with ESMTPS id 925C66E213
 for <freebsd-questions@freebsd.org>; Thu, 12 Oct 2017 09:17:31 +0000 (UTC)
 (envelope-from freebsd@edvax.de)
Received: from mx01.qsc.de ([213.148.129.14]) by mailrelay12.qsc.de;
 Thu, 12 Oct 2017 11:17:22 +0200
Received: from r56.edvax.de (port-92-195-127-141.dynamic.qsc.de
 [92.195.127.141])
 (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by mx01.qsc.de (Postfix) with ESMTPS id 233853CBF9;
 Thu, 12 Oct 2017 11:17:21 +0200 (CEST)
Received: from r56.edvax.de (localhost [127.0.0.1])
 by r56.edvax.de (8.14.5/8.14.5) with SMTP id v9C9HLW0002941;
 Thu, 12 Oct 2017 11:17:21 +0200 (CEST)
 (envelope-from freebsd@edvax.de)
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>
Reply-To: Polytropon <freebsd@edvax.de>
Organization: EDVAX
X-Mailer: Sylpheed 3.1.1 (GTK+ 2.24.5; i386-portbld-freebsd8.2)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
X-cloud-security-sender: freebsd@edvax.de
X-cloud-security-recipient: freebsd-questions@freebsd.org
X-cloud-security-Virusscan: CLEAN
X-cloud-security-disclaimer: This E-Mail was scanned by E-Mailservice on
 mailrelay12.qsc.de with 72D596A4EF3
X-cloud-security-connect: mx01.qsc.de[213.148.129.14], TLS=1, IP=213.148.129.14
X-cloud-security: scantime:.1352
X-BeenThere: freebsd-questions@freebsd.org
X-Mailman-Version: 2.1.23
Precedence: list
List-Id: User questions <freebsd-questions.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/freebsd-questions>, 
 <mailto:freebsd-questions-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-questions/>
List-Post: <mailto:freebsd-questions@freebsd.org>
List-Help: <mailto:freebsd-questions-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/freebsd-questions>, 
 <mailto:freebsd-questions-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 12 Oct 2017 09:17:33 -0000

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, ...