I've been thinking about bug 3635.

One idea:

   rename "spamassassin" to "sa-check"
   make "spamassassin" a meta document that execs sa-check for backwards
      compatibility

Another idea:

   make "spamassassin" a meta document that execs sa-check for backwards
      compatibility
   move spamassassin pod to "spamassassinrun" document

Here's a cut at the first idea, which I favor.  Check it out, read it,
tell me what you think.

Daniel

------- start of cut text --------------
#!/usr/bin/perl -w

# <@LICENSE>
# Copyright 2004 Apache Software Foundation
# 
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# 
#     http://www.apache.org/licenses/LICENSE-2.0
# 
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# </@LICENSE>

use strict;
use warnings;

exec 'sa-check', @ARGV;

=head1 NAME

spamassassin - extensible email filter which is used to identify spam

=head1 SYNOPSIS

For backwards compatibility, running "spamassassin" calls the "sa-check"
program.  You should be able to view the "sa-check" documentation with
your man(1) program or perldoc(1).

=head1 DESCRIPTION

SpamAssassin is an intelligent email filter which uses a diverse range of
tests to identify unsolicited bulk email, more commonly known as "Spam".
These tests are applied to email headers and content to classify email
using advanced statistical methods.  In addition, SpamAssassin has a
modular architecture that allows other technologies to be quickly wielded
against spam and is designed for easy integration into virtually any email
system.

=head1 SYNOPSIS

For ease of access, the SpamAssassin manual has been split up into several
sections:

    spamassassin              SpamAssassin overview (this section)
    Mail::SpamAssassin::Conf  SpamAssassin configuration files
    sa-check                  SpamAssassin script to do checking, etc.
    sa-learn                  train SpamAssassin's Bayesian classifier
    spamc                     client for spamd (faster than sa-check)
    spamd                     spamassassin server (faster than sa-check)

(If you're intending to read these straight through for the first time,
the suggested order will tend to reduce the number of forward references.)

Extensive additional documentation for SpamAssassin is available,
primarily on the SpamAssassin web site and wiki.

You should be able to view SpamAssassin's documentation with your man(1)
program or perldoc(1).

=head1 WEB SITES

    SpamAssassin web site     http://spamassassin.apache.org/
    SpamAssassin wiki         http://wiki.apache.org/spamassassin/

=head1 USER MAILING LIST

A users mailing list exists where other experienced users are often able
to help and provide tips and advice.  Subscription instructions are
located on the SpamAssassin web site.

=head1 DEVELOPER DOCUMENTATION

    Mail::SpamAssassin
        Spam detector and markup engine

    Mail::SpamAssassin::ArchiveIterator
        find and process messages one at a time

    Mail::SpamAssassin::AutoWhitelist
        auto-whitelist handler for SpamAssassin

    Mail::SpamAssassin::Bayes
        determine spammishness using a Bayesian classifier

    Mail::SpamAssassin::BayesStore
        Bayesian Storage Module

    Mail::SpamAssassin::BayesStore::SQL
        SQL Bayesian Storage Module Implementation

    Mail::SpamAssassin::Conf::LDAP
        load SpamAssassin scores from LDAP database

    Mail::SpamAssassin::Conf::Parser
        parse SpamAssassin configuration

    Mail::SpamAssassin::Conf::SQL
        load SpamAssassin scores from SQL database

    Mail::SpamAssassin::Message
        decode, render, and hold an RFC-2822 message

    Mail::SpamAssassin::Message::Metadata
        extract metadata from a message

    Mail::SpamAssassin::Message::Node
        decode, render, and make available MIME message parts

    Mail::SpamAssassin::PerMsgLearner
        per-message status (spam or not-spam)

    Mail::SpamAssassin::PerMsgStatus
        per-message status (spam or not-spam)

    Mail::SpamAssassin::PersistentAddrList
        persistent address list base class

    Mail::SpamAssassin::Plugin
        SpamAssassin plugin base class

    Mail::SpamAssassin::Plugin::Hashcash
        perform hashcash verification tests

    Mail::SpamAssassin::Plugin::RelayCountry
        add message metadata indicating the country code of each relay

    Mail::SpamAssassin::Plugin::SPF
        perform SPF verification tests

    Mail::SpamAssassin::Plugin::URIDNSBL
        look up URLs against DNS blocklists

    Mail::SpamAssassin::SQLBasedAddrList
        SpamAssassin SQL Based Auto Whitelist

=head1 BUGS

See <http://bugzilla.spamassassin.org/>

=head1 AUTHORS

The SpamAssassin(tm) Project <http://spamassassin.apache.org/>

=head1 COPYRIGHT

SpamAssassin is distributed under the Apache License, Version 2.0, as
described in the file C<LICENSE> included with the distribution.

=cut
------- end ----------------------------

-- 
Daniel Quinlan
http://www.pathname.com/~quinlan/

Reply via email to