Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Term::ProgressBar::IO

Name Term::ProgressBar::IO
Version 2.22
Located at /usr/share/perl5/vendor_perl
File /usr/share/perl5/vendor_perl/Term/ProgressBar/IO.pm
Is Core No
Search CPAN for this module Term::ProgressBar::IO
Documentation Term::ProgressBar::IO
Module Details Term::ProgressBar::IO

NAME

Term::ProgressBar::IO -- Display a progress bar while reading from a seekable filehandle


SYNOPSIS

  my $pb = Term::ProgressBar::IO->new($fh);
  while (<$fh>) {
      # do something
      $pb->update();
  }


DESCRIPTION

Displays a progress bar using the Term::ProgressBar manpage which corresponds to reading from a filehandle.

This module inherits from the Term::ProgressBar manpage and has all of its options.


BUGS

None known.


METHODS

new

Create and return a new Term::ProgressBar::IO instance.

ARGUMENTS
count
A valid filehandle or item count. the IO::Uncompress manpage filehandles are also properly handled.

OTHER ARGUMENTS
All other arguments are documented in the Term::ProgressBar manpage

update

Automatically update the progress bar based on the position of the filehandle given at construction time.

ARGUMENTSARGUMENTS
so_far
Current progress point; this defaults to the current position of the filehandle. [You probably don't actually want to ever give this.]

Perl Diver brought to you by ScriptSolutions.com © 1997- 2025