You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@spamassassin.apache.org by Matt Kettler <mk...@evi-inc.com> on 2005/05/26 21:12:45 UTC

Manpage change suggestion

guenther wrote:
> On Thu, 2005-05-26 at 12:55 -0500, Craig Jackson wrote:
> 
>>Hi,
>>I'd like to change/reset-to-zero the autowhite list value for a sender. 
>>I read the man page (Mail::Spamassassin::Autowhitelist) but don't 
>>comprehend the syntax.
>>
>>Can someone give me a hint?
> 
> 
> Rather than Mail::Spamassassin::Autowhitelist you likely want 'man
> spamassassin'. :)
> 

This points out a rather important point.

For the new user there's no easy way to tell the difference between manpages
that are documenting how to use SA, such as man Mail::SpamAssassin::Conf, and
ones that are documenting how to program SA via perl, such as man
Mail::Spamassassin::Autowhitelist.


Perhaps in the Name or Synopsis section we should indicate that a particular
manpage is perl programing information.

Or, alternatively change things so that all the programming documentation is in
man Mail::SpamAssassin::* and all the user config information is in man
spamassassin.*  (ie: make the current man Mail::SpamAssassin::Conf into man
spamassassin.conf, and make the Mail::SpamAssassin::Conf page document the
functionality implemented by Conf.pm)