Mail::SpamAssassin::Util::Progress man page

Section 3 - openSUSE 10.2 Man Pages

Other operating system man pages available here

Hopefully, this page is exactly what you are looking for, but if not, you can always find further assistance on Unix/Linux Forum!

Mail::SpamAssassin::UtUserPContributed PeMail::SpamAssassin::Util::Progress(3)



NAME
         Mail::SpamAssassin::Util::Progress - Progress bar support for SpamAssassin

SYNOPSIS
         my $progress = Mail::SpamAssassin::Util::Progress->new({total => 100});

         $msgcount = 0;
         foreach my $message (@messages) {
           # do something here
           $msgcount++;
           $progress->update($msgcount);
         }

         $progress->final();

DESCRIPTION
       This module implements a progress bar for use in SpamAssassin scripts
       and modules.  It allows you to create the progress bar, update it and
       print out the final results of a particular run.

       new

       public class (Mail::SpamAssassin::Util::Progress) new (\% $args)

       Description: Creates a new Mail::SpamAssassin::Util::Progress object,
       valid values for the $args hashref are:

       total (required)
           The total number of messages expected to be processed.  This item
           is required.

       fh [optional]
           An optional filehandle may be passed in, otherwise STDERR will be
           used by default.

       term [optional]
           The module will attempt to determine if a valid terminal exists on
           the filehandle.  This item allows you to override that value.

       init_bar

       public instance () init_bar()

       Description: This method creates the initial progress bar and is called
       automatically from new.  In addition you can call init_bar on an exist-
       ing object to reset the bar to it's original state.

       update

       public instance () update ([Integer $num_done])

       Description: This method is what gets called to update the progress
       bar.  You may optionally pass in an integer value that indicates how
       many messages have been processed.  If you do not pass anything in then
       the num_done value will be incremented by one.

       final

       public instance () final ([Integer $num_done])

       Description: This method should be called once all processing has fin-
       ished.  It will print out the final msgs per sec calculation and the
       total time taken.  You can optionally pass in a num_done value, other-
       wise it will use the value calculated from the last call to update.



perl v5.8.8                       2006-08Mail::SpamAssassin::Util::Progress(3)

Your favourite pages:

No pages logged yet.
Trying to save cookie...

Top 10 most popular pages:

svn man page (6162 hits)
(FreeBSD 6.2)

sqlite3 man page (5598 hits)
(openSUSE 10.2)

adv_cap_autoneg man page (5045 hits)
(Solaris 10 11_06)

CPAN man page (4791 hits)
(Suse Linux 10.1)

ssh man page (4439 hits)
(Suse Linux 10.1)

ssh-socks5-proxy-connect man page (3525 hits)
(Solaris 10 11_06)

signal man page (3395 hits)
(Suse Linux 10.1)

netcat man page (3377 hits)
(Suse Linux 10.1)

pprosetup man page (2886 hits)
(Solaris 10 11_06)

startproc man page (2738 hits)
(Suse Linux 10.1)