Re: man1 or man8?

2006-05-03 Thread Joey Hess
Tyler MacDonald wrote:
> tarballs, but it's in man8, whereas "defoma-reconfigure", which can only be

Ups, I read defoma-reconfigure as dpkg-reconfigure. :-)

-- 
see shy jo


signature.asc
Description: Digital signature


Re: man1 or man8?

2006-05-03 Thread Joey Hess
Tyler MacDonald wrote:
> I can't find a consistent rule for what should go into man1 vs. man8. For
> instance, "apt-get" can be used as an unprivileged user to download source
> tarballs, but it's in man8, whereas "defoma-reconfigure", which can only be
> run as root, is located in man1.

DPKG-RECONFIGURE(8)DebconfDPKG-RECONFIGURE(8)

So, no, it's in 8 where it belongs.

> Under debian, bt_xml2db and bt_db2xml will probably require you to be either
> www-data or root

man 8 probably

-- 
see shy jo


signature.asc
Description: Digital signature


Re: man1 or man8?

2006-05-03 Thread Thijs Kinkhorst
On Wed, 2006-05-03 at 16:53 -0700, Tyler MacDonald wrote:
>   OK, so according to that, defoma-reconfigure being in man1 (and
> /usr/bin) is a bug, because nobody but root can use it?

Yes, from a cursory look I think that's a minor bug. You should file it,
if the maintainer disagrees he/she will let you know :)

>   I should have been more clear I guess. I am upstream in this case,
> and I'm about to start writing documentation. Based on your advice I think I
> will put it in man8, but install the binaries into /usr/bin, since www-data
> should run them for database backup/recovery.

That could be a valid reasoning, yes.


Thijs


signature.asc
Description: This is a digitally signed message part


Re: man1 or man8?

2006-05-03 Thread Tyler MacDonald
Thijs Kinkhorst <[EMAIL PROTECTED]> wrote:
> This isn't 100% clear for every case. Of course, when a package is
> solely useful to the system administrator to do system administrative
> tasks, it should belong in 8, and if it's neither of those it's in 1.
> But there's a lot in between like the examples you mention.

OK, so according to that, defoma-reconfigure being in man1 (and
/usr/bin) is a bug, because nobody but root can use it?

> As far as your upstream question, I wouldn't deviate from upstream
> unless you have a really convincing argument why the man page placement
> is incorrect. And even then, you'd better try to persuade upstream.

I should have been more clear I guess. I am upstream in this case,
and I'm about to start writing documentation. Based on your advice I think I
will put it in man8, but install the binaries into /usr/bin, since www-data
should run them for database backup/recovery.

Thanks,
Tyler


-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]



Re: man1 or man8?

2006-05-03 Thread Thijs Kinkhorst
On Wed, 2006-05-03 at 16:35 -0700, Tyler MacDonald wrote:
> I can't find a consistent rule for what should go into man1 vs. man8. For
> instance, "apt-get" can be used as an unprivileged user to download source
> tarballs, but it's in man8, whereas "defoma-reconfigure", which can only be
> run as root, is located in man1.
> 
> Under debian, bt_xml2db and bt_db2xml will probably require you to be either
> www-data or root to operate on the installed mod_bt tracker database.
> Should documentation for these tools go into man1 or man8? Is this even up
> to debian, or is it an upstream source thing?

This isn't 100% clear for every case. Of course, when a package is
solely useful to the system administrator to do system administrative
tasks, it should belong in 8, and if it's neither of those it's in 1.
But there's a lot in between like the examples you mention.

I think the question is whether the program is mainly, or in principle,
a system administration tool. If that's the case, it should be in man8.
Like apt-get, where the unprivileged operation is just a small part.

As far as your upstream question, I wouldn't deviate from upstream
unless you have a really convincing argument why the man page placement
is incorrect. And even then, you'd better try to persuade upstream.


Thijs


signature.asc
Description: This is a digitally signed message part


man1 or man8?

2006-05-03 Thread Tyler MacDonald
I can't find a consistent rule for what should go into man1 vs. man8. For
instance, "apt-get" can be used as an unprivileged user to download source
tarballs, but it's in man8, whereas "defoma-reconfigure", which can only be
run as root, is located in man1.

Under debian, bt_xml2db and bt_db2xml will probably require you to be either
www-data or root to operate on the installed mod_bt tracker database.
Should documentation for these tools go into man1 or man8? Is this even up
to debian, or is it an upstream source thing?

Thanks,
Tyler


-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]