Manual pages conventions

Jeremie Le Hen jeremie at le-hen.org
Thu Jun 9 16:18:54 UTC 2005


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 >



More information about the freebsd-doc mailing list