IO::Pager - Select a pager, optionally pipe it output if destination is a TTY
#Select a pager, sets $ENV{PAGER} use IO::Pager; #Optionally pipe output { #local $STDOUT = IO::Pager::open *STDOUT; local $STDOUT = new IO::Pager *STDOUT; print <<" HEREDOC" ; ... A bunch of text later HEREDOC }
IO::Pager is lightweight and can be used to locate an available pager and set $ENV{PAGER} (see "NOTES") or as a factory for creating objects defined elsewhere such as IO::Pager::Buffered and IO::Pager::Unbuffered.
IO::Pager subclasses are designed to programmatically decide whether or not to pipe a filehandle's output to a program specified in $ENV{PAGER}. Subclasses are only required to support filehandle output methods and close, namely
Supports close() of the filehandle.
Supports print() to the filehandle.
Supports printf() to the filehandle.
Supports syswrite() to the filehandle.
For anything else, YMMV.
Instantiate a new IO::Pager to paginate FILEHANDLE if necessary. Assign the return value to a scoped variable.
See the appropriate subclass for implementation specific details.
Defaults to currently select()-ed FILEHANDLE.
An expression which evaluates to the subclass of object to create.
Defaults to IO::Pager::Unbuffered.
An alias for new.
Explicitly close the filehandle, this stops any redirection of output on FILEHANDLE that may have been warranted. Normally you'd just wait for the object to pass out of scope.
This does not default to the current filehandle.
The location of the default pager.
If PAGER does not specify an absolute path for the binary PATH may be used.
See "NOTES" for more information.
IO::Pager may fall back to these binaries in order if $ENV{PAGER} is not executable.
The algorythm for determining which pager is to use as follows:
Use the value of $ENV{PAGER} if it exists unless File::Which is available and the pager in $ENV{PAGER} is determined to be unavailable.
Try the standard, hardcoded paths in "FILES".
If File::Which is available check for less and more.
less
Set $ENV{PAGER} to more
more
Steps 1, 3 and 4 rely upon $ENV{PATH}.
IO::Pager::Buffered, IO::Pager::Unbuffered, IO::Pager::Page
IO::Page, Tool::Less
Jerrad Pierce <jpierce@cpan.org>
This module is forked from IO::Page 0.02 by Monte Mitzelfelt
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.
To install IO::Pager, copy and paste the appropriate command in to your terminal.
cpanm
cpanm IO::Pager
CPAN shell
perl -MCPAN -e shell install IO::Pager
For more information on module installation, please visit the detailed CPAN module installation guide.