From owner-freebsd-doc@FreeBSD.ORG  Thu Jun  9 16:18:54 2005
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
X-Original-To: freebsd-doc@FreeBSD.org
Delivered-To: freebsd-doc@FreeBSD.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 8402C16A41C
	for <freebsd-doc@FreeBSD.org>; Thu,  9 Jun 2005 16:18:54 +0000 (GMT)
	(envelope-from tataz@tataz.chchile.org)
Received: from postfix4-2.free.fr (postfix4-2.free.fr [213.228.0.176])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 418DD43D48
	for <freebsd-doc@FreeBSD.org>; Thu,  9 Jun 2005 16:18:54 +0000 (GMT)
	(envelope-from tataz@tataz.chchile.org)
Received: from tatooine.tataz.chchile.org
	(vol75-8-82-233-239-98.fbx.proxad.net [82.233.239.98])
	by postfix4-2.free.fr (Postfix) with ESMTP id 4D17231DA76
	for <freebsd-doc@FreeBSD.org>; Thu,  9 Jun 2005 18:18:53 +0200 (CEST)
Received: by tatooine.tataz.chchile.org (Postfix, from userid 1000)
	id 09BB84080; Thu,  9 Jun 2005 18:18:35 +0200 (CEST)
Date: Thu, 9 Jun 2005 18:18:35 +0200
From: Jeremie Le Hen <jeremie@le-hen.org>
To: freebsd-doc@FreeBSD.org
Message-ID: <20050609161835.GC41050@obiwan.tataz.chchile.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Mutt/1.5.9i
Cc: 
Subject: Manual pages conventions
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 09 Jun 2005 16:18:54 -0000

Hi,

(please include me in replies, I've not subscribed to this list)

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

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.

I would be grateful if someone give me some pointers or some
explanations.

Thanks.

Regards,
-- 
Jeremie Le Hen
< jeremie at le-hen dot org >< ttz at chchile dot org >