.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Term::ProgressBar::IO 3pm"
.TH Term::ProgressBar::IO 3pm "2022-10-09" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Term::ProgressBar::IO \-\- Display a progress bar while reading from a seekable filehandle
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $pb = Term::ProgressBar::IO\->new($fh);
\&
\&  while (<$fh>) {
\&      # do something
\&      $pb\->update();
\&  }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Displays a progress bar using Term::ProgressBar which corresponds
to reading from a filehandle.
.PP
This module inherits from Term::ProgressBar and has all of its
options.
.SH "BUGS"
.IX Header "BUGS"
None known.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Create and return a new Term::ProgressBar::IO instance.
.IP "\s-1ARGUMENTS\s0" 4
.IX Item "ARGUMENTS"
.RS 4
.PD 0
.IP "count" 4
.IX Item "count"
.PD
A valid filehandle or item count. IO::Uncompress filehandles are
also properly handled.
.IP "\s-1OTHER ARGUMENTS\s0" 4
.IX Item "OTHER ARGUMENTS"
All other arguments are documented in Term::ProgressBar
.RE
.RS 4
.RE
.SS "update"
.IX Subsection "update"
Automatically update the progress bar based on the position of the
filehandle given at construction time.
.IP "\s-1ARGUMENTS\s0" 4
.IX Item "ARGUMENTS"
.RS 4
.PD 0
.IP "so_far" 4
.IX Item "so_far"
.PD
Current progress point; this defaults to the current position of the
filehandle. [You probably don't actually want to ever give this.]
.RE
.RS 4
.RE