From owner-freebsd-questions@freebsd.org Thu Oct 12 13:23:49 2017 Return-Path: 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 29095E297F5 for ; Thu, 12 Oct 2017 13:23:49 +0000 (UTC) (envelope-from yuripv@gmx.com) Received: from mout.gmx.net (mout.gmx.net [212.227.15.15]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "mout.gmx.net", Issuer "TeleSec ServerPass DE-2" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 9B25276FC7 for ; Thu, 12 Oct 2017 13:23:47 +0000 (UTC) (envelope-from yuripv@gmx.com) Received: from procyon.local ([5.138.255.62]) by mail.gmx.com (mrgmx002 [212.227.17.184]) with ESMTPSA (Nemesis) id 0MAyZg-1eAIsK3hZM-00A1Hd; Thu, 12 Oct 2017 15:18:29 +0200 Subject: Re: Should I use mdoc for user programs? To: "Sijmen J. Mulder" , freebsd-questions@freebsd.org References: From: Yuri Pankov Message-ID: Date: Thu, 12 Oct 2017 16:18:28 +0300 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:52.0) Gecko/20100101 Thunderbird/52.4.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-Provags-ID: V03:K0:KZwZzjmpuQTrQkOq7HnJ9U20TAt0eDP7xQX3HS0SXEfjdVIFP/v JstgjBqG8kXRz7zJbnUm2JgSEso1KOBXRXiTKw40VvyBZ061QhUfETJIPZ5RNIokRjwCbvX ZN5+IlCwKG4BFZR+jnlhjISJLt2h4DDVYfAMRSh3YHFvEMwFXIg21ts5waVn5YHIMBH6rXH X3XOaS3gIkB77lKK648JQ== X-UI-Out-Filterresults: notjunk:1;V01:K0:D0/WwZCvXW0=:OWCt04wVPgYfuz87GKyChC JBlGJoA3i3w9rKRWX3iT36T5rDSDwa1I73T8HdJ19ZDj6EEO7KN4aWwj7c9gycrJC9Fmg/1qq qbDUTpw36hXQPXfEBUKUkL3reu/NcmjM7pxv3dfW9swdXigxSgzO0q/aWKNBqZA3gTA1Sqqcv GtxYitsnniQltITdJs9Js3HCFTVd5xhwTvuvRiXRPrf3zeTocH3qld7mC5NDYR2FZSy125Zmp d2QBG08CwSks9R+J9MLw3Yt8o8cv2iSpTxc3rL73CEvg2jWn7/jrLTwPntkdeJqBwAPgFaOrc JK9wQdPqIFEKn0l166t5EbDc+coFtloKvOkfH895ZXJeM3TwEI6Mw0U4C5AC/rRu97eY/Lrn9 VtEsF8gtYI3yTpAjiqwo4Fy453Y+0Pw6xBd3C2eAV/YdrpOT7yS27wfOKFnRWOXfw81zWJYxJ Ke9pynX7NaeclpQeEU78m2J63cfAOQVSvA9BNUipG2rTRC05tP5qbhBln1RC5PJJaxl1qD7n6 D4tOiKIyijryFcHPXpkgy7QWp4yxnBgQyI8CrtJJuTk3bERWlaq8pgs1oImGkBKehSESReUgW UDAXJFx5fzJZvhQHIiLEGRfSxYhF6ohLuzn71CgziEEfqdTkYx2K+fQk6iiWso2AEgLgfTax0 B0GkoIiUf9384tPLQATH6L5ylM8Ot+i0AOakcY4v6XXqjaWr0UArmhPhPgmvyrUqzxoo/XRau +dKYtRcWJkLhrryRDvwJox0ZtLUrk4nLMIn141y3tCTutRF1b6RKxH5/g54YU77sXDaOLoRPt ke6drxbCOINLQvwe8EYtUZo/Zr17a99y1S3pZj2x28xcUhGpX8= X-BeenThere: freebsd-questions@freebsd.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: User questions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 12 Oct 2017 13:23:49 -0000 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.