Date: Thu, 9 Jun 2005 18:20:53 +0200 From: Marc Fonvieille <blackend@FreeBSD.org> To: Jeremie Le Hen <jeremie@le-hen.org> Cc: freebsd-doc@FreeBSD.org Subject: Re: Manual pages conventions Message-ID: <20050609162053.GE28366@gothic.blackend.org> In-Reply-To: <20050609161835.GC41050@obiwan.tataz.chchile.org> References: <20050609161835.GC41050@obiwan.tataz.chchile.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--jTMWTj4UTAEmbWeb Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Thu, Jun 09, 2005 at 06:18:35PM +0200, Jeremie Le Hen wrote: > Hi, >=20 > (please include me in replies, I've not subscribed to this list) >=20 > I'm writing a manual page but I can't find any documentation on rules > or conventions that must be applied. First I would simply like to > know where I can find a FreeBSD groff macros reference. For what I > saw on the Net, .Nm, .Xr, and so on are not standards (I'm really not > a groff guru, not even a novice to be honest). >=20 > I had a look at the rc.conf(5) manpage since my project is pretty tied > to the latter. I more or less understood that, for instance, .Xr is > used to reference another manual page, but I don't know when I should > use .Xr (manual page reference) and when .Pa (path) would be better. >=20 > I would be grateful if someone give me some pointers or some > explanations. > mdoc(7) Marc --jTMWTj4UTAEmbWeb Content-Type: application/pgp-signature Content-Disposition: inline -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.0 (FreeBSD) iD8DBQFCqGxkzQ9RwE+OdOgRAmFsAKDCsT2yiqTdjMNUb3Wo+Nb2Z4VdJwCfenrD DuH8/XoHh4HgiK0lSOBuZzw= =Y7NO -----END PGP SIGNATURE----- --jTMWTj4UTAEmbWeb--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20050609162053.GE28366>