From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mo4-p00-ob.smtp.rzone.de (mo4-p00-ob.smtp.rzone.de [81.169.146.217]) by krisdoz.my.domain (8.14.5/8.14.5) with ESMTP id sACEpUni017748 for ; Wed, 12 Nov 2014 09:51:31 -0500 (EST) X-RZG-AUTH: :JiIXek6mfvEEUpFQdo7Fj1/zg48CFjWjQv0cW+St/nW/auYssSp3lvXr2GCeWaU= X-RZG-CLASS-ID: mo00 Received: from britannica.bec.de (ip-2-207-134-157.web.vodafone.de [2.207.134.157]) by smtp.strato.de (RZmta 35.11 DYNA|AUTH) with ESMTPSA id j037cfqACEpSXJ3 (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) for ; Wed, 12 Nov 2014 15:51:28 +0100 (CET) Received: by britannica.bec.de (sSMTP sendmail emulation); Wed, 12 Nov 2014 15:51:27 +0100 Date: Wed, 12 Nov 2014 15:51:27 +0100 From: Joerg Sonnenberger To: discuss@mdocml.bsd.lv Subject: Re: Library manpages per-function or per-library? Message-ID: <20141112145127.GA28857@britannica.bec.de> References: <54636E8E.3010007@bsd.lv> X-Mailinglist: mdocml-discuss Reply-To: discuss@mdocml.bsd.lv MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <54636E8E.3010007@bsd.lv> User-Agent: Mutt/1.5.21 (2010-09-15) On Wed, Nov 12, 2014 at 03:28:30PM +0100, Kristaps Dzonsons wrote: > I thought I'd put this question up for future searches, as it > confuses me and no doubt confuses others, as well. In short, when > writing a library, does one document each function in a separate > mdoc(7) page, or all functions in one big one? Or perhaps, grouped > by utility? Or grouped by header file? One man page documenting the general API design and one man page per function group. Joerg -- To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv