NAME

Term::ProgressBar - Perl extension to display a progress bar

SYNOPSIS

use Term::ProgressBar;
my $num_items = 100;
my $bar = new Term::Progressbar('working magic', $num_items);
foreach (0 .. $num_items-1) {
    # do work for item $_
    update $bar;
}

DESCRIPTION

This module provides a simple progress indicator for command line programs. You initialize a ProgressBar object with a brief description of what is happening and the number of things that need doing, and after each thing is done you call the object's update() method.

At the moment, this is presented to the user (on stderr) as a sequence of 50 hash marks (no matter how many things are being done).

METHODS

new(desc, num_items)

Create and return a new progress bar, which is displayed to the user. Parameters are:

desc - descriptive name of what you're doing (eg 'working magic')

num_items - total number of items which must be completed

update()

Update the progress bar by one 'tick'. You should call this after completing each one of the 'items' included in the counter's total. The progress bar will be updated accordingly (at present, this means more text printed to stderr).

AUTHOR

Ed Avis, epa98@doc.ic.ac.uk

SEE ALSO

perl(1).