Bug 6602

Summary:	Fix spamc man page to indicate spamd man page is in section 8, not section 1 - Debian patch
Product:	Spamassassin	Reporter:	Darxus <Darxus>
Component:	Documentation	Assignee:	SpamAssassin Developer Mailing List <dev>
Status:	RESOLVED WONTFIX
Severity:	normal	CC:	Darxus, kmcgrail
Priority:	P2
Version:	SVN Trunk (Latest Devel Version)
Target Milestone:	Undefined
Hardware:	PC
OS:	Linux
Whiteboard:
Attachments:	Debian patch. Patch to remove Debian patch from trunk Patch to remove Debian patch from trunk, including updating MANIFEST

Description Darxus 2011-05-25 21:29:24 UTC

Created attachment 4901 [details]
Debian patch.

Extremely minor patch correcting the spamc man page, from Debian packaging.

Comment 1 Darxus 2011-05-25 21:30:53 UTC

Created attachment 4902 [details]
Patch to remove Debian patch from trunk

Comment 2 Kevin A. McGrail 2011-05-25 21:33:27 UTC

Darcus,

For me, spamd is in (1) not (8)

i.e., I have /usr/local/man/man1/spamd.1
  
Is this something Debian specific that spamd ends up in (8)?

Comment 3 Darxus 2011-05-25 21:34:08 UTC

Created attachment 4903 [details]
Patch to remove Debian patch from trunk, including updating MANIFEST

Comment 4 Darxus 2011-05-25 21:36:38 UTC

(In reply to comment #2)
> Is this something Debian specific that spamd ends up in (8)?

I assumed it was not because I don't see anything in the patches that would change what section the spamd man page is in.  Not sure what's causing the difference.

Comment 5 Darxus 2011-05-25 22:09:52 UTC

Yep, it's Debian specific, found the change in debian/rules:
  sed 's#SPAMD 1#SPAMD 8#' \
   debian/spamassassin/usr/share/man/man1/spamd.1p \
   > debian/spamassassin/usr/share/man/man8/spamd.8p

Although judging from man(1), it looks like the spamd man page *should* be in section 8:

       1   Executable programs or shell commands
       2   System calls (functions provided by the kernel)
       3   Library calls (functions within program libraries)
       4   Special files (usually found in /dev)
       5   File formats and conventions eg /etc/passwd
       6   Games
       7   Miscellaneous  (including  macro  packages and conven‐
           tions), e.g. man(7), groff(7)
       8   System administration commands (usually only for root)
       9   Kernel routines [Non standard]

How is the man page getting created when installed from a tarball?  Or is it?

Comment 6 Kevin A. McGrail 2011-05-25 22:15:09 UTC

(In reply to comment #5)
> Yep, it's Debian specific, found the change in debian/rules:
>   sed 's#SPAMD 1#SPAMD 8#' \
>    debian/spamassassin/usr/share/man/man1/spamd.1p \
>    > debian/spamassassin/usr/share/man/man8/spamd.8p
> 
> Although judging from man(1), it looks like the spamd man page *should* be in
> section 8:
> 
>        1   Executable programs or shell commands
>        2   System calls (functions provided by the kernel)
>        3   Library calls (functions within program libraries)
>        4   Special files (usually found in /dev)
>        5   File formats and conventions eg /etc/passwd
>        6   Games
>        7   Miscellaneous  (including  macro  packages and conven‐
>            tions), e.g. man(7), groff(7)
>        8   System administration commands (usually only for root)
>        9   Kernel routines [Non standard]
> 
> How is the man page getting created when installed from a tarball?  Or is it?

Hmm, interesting debate.  Since a user can run spamassassin and spamc. They can even run spamd on an alternate port.  So I'll leave it at (1) because I don't feel strongly enough to move to (8) and mark this bug as wontfix because it's going to be considered a package-specific change.