The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
IO-Pager-0.16
River stage two • 6 direct dependents • 35 total dependents
7 ++
/ IO::Pager::Buffered

NAME

IO::Pager::Buffered - Pipe deferred output to a pager if destination is to a TTY

SYNOPSIS

  use IO::Pager::Buffered;
  {
    #local $STDOUT =     IO::Pager::Buffered::open *STDOUT;
    local  $STDOUT = new IO::Pager::Buffered       *STDOUT;
    print <<"  HEREDOC" ;
    ...
    A bunch of text later
    HEREDOC
  }

DESCRIPTION

IO::Pager is designed to programmatically decide whether or not to point the STDOUT file handle into a pipe to program specified in the PAGER environment variable or one of a standard list of pagers.

This subclass buffers all output for display upon exiting the current scope. If this is not what you want look at another subclass such as IO::Pager::Unbuffered. While probably not common, this may be useful in some cases,such as buffering all output to STDOUT while the process occurs, showing only warnings on STDERR, then displaying the output to STDOUT after. Or alternately letting output to STDOUT slide by and defer warnings for later perusal.

new( [FILEHANDLE] )

Instantiate a new IO::Pager to paginate FILEHANDLE if necessary. Assign the return value to a scoped variable. Output does not occur until all references to this variable are destroyed eg; upon leaving the current scope. See "DESCRIPTION".

FILEHANDLE

Defaults to currently select()-ed FILEHANDLE.

open( [FILEHANDLE] )

An alias for new.

close( FILEHANDLE )

Explicitly close the filehandle, this stops collecting and displays the output, executing a pager if necessary. Normally you would just wait for the object to pass out of scope.

This does not default to the current filehandle.

tell( FILEHANDLE )

Returns the size of the buffer in bytes.

CAVEATS

If you mix buffered and unbuffered operations the output order is unspecified, and will probably differ for a TTY vs. a file. See perlfunc.

$, is used see perlvar.

SEE ALSO

IO::Pager, IO::Pager::Unbuffered, IO::Pager::Page,

AUTHOR

Jerrad Pierce <jpierce@cpan.org>

Florent Angly <florent.angly@gmail.com>

This module was inspired by Monte Mitzelfelt's IO::Page 0.02

COPYRIGHT AND LICENSE

Copyright (C) 2003-2012 Jerrad Pierce

  • Thou shalt not claim ownership of unmodified materials.

  • Thou shalt not claim whole ownership of modified materials.

  • Thou shalt grant the indemnity of the provider of materials.

  • Thou shalt use and dispense freely without other restrictions.

Or, if you prefer:

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.0 or, at your option, any later version of Perl 5 you may have available.