Re: manpage : documenting /etc/default/foobar
Hello Colin,
On Sun, 2008-01-27 at 00:10 +0000, Colin Watson wrote:
> On Sat, Jan 26, 2008 at 08:06:01PM +0100, Franklin PIAT wrote:
> > I'm writing some manpages, and I wonder what's the current practice for
> > documenting a file like in /etc/default/foobar.
> >
> > On my laptop [1], only /etc/default/rcS seems to have a manpage in the
> > section 5.
>
> As you note, I'm not sure that this is obviously common practice, but
> IMO (speaking as the man-db maintainer) foobar(5) is clearly reasonable.
> If there is another configuration file called 'foobar', it's probably in
> the same package, and you can just document both in the same manual
> page.
>
> If you prefer, you can document it in the manual page for the program
> instead.
Thanks for the advice.
I think i will do it in the appropriate program manpage (just in case
upstream makes a foobar program someday).
Franklin
Reply to: