| 1 |
IO::Pager & IO::Pager::Perl |
| 2 |
===================== |
| 3 |
|
| 4 |
IO::Pager - Select a pager and pipe text to it if destination is a TTY |
| 5 |
IO::Pager::Perl - A pure perl pager engine |
| 6 |
|
| 7 |
IO::Pager::Perl is used in the IO::Pager::less IO::Pager subclass, |
| 8 |
but is also a free-standing library ready to be incorporated into |
| 9 |
other code. |
| 10 |
|
| 11 |
IO::Pager is lightweight and can be used to locate an available pager |
| 12 |
and set the PAGER environment variable sanely or as a factory for |
| 13 |
creating objects defined elsewhere such as IO::Pager::Buffered, |
| 14 |
IO::Pager::Unbuffered, and IO::Pager::less which provides a pure perl |
| 15 |
pager called tp. |
| 16 |
|
| 17 |
IO::Pager subclasses are designed to programmatically decide whether |
| 18 |
or not to pipe a filehandle's output to a program specified in PAGER. |
| 19 |
Subclasses may inherit from IO::Pager, and implement the IO handle |
| 20 |
methods desired. |
| 21 |
|
| 22 |
|
| 23 |
INSTALLATION |
| 24 |
|
| 25 |
To install this module type the following: |
| 26 |
|
| 27 |
perl Makefile.PL |
| 28 |
make |
| 29 |
# Run non-interactive tests |
| 30 |
make test |
| 31 |
# Run interactive tests |
| 32 |
perl -Mblib test.pl interactive |
| 33 |
make install |
| 34 |
|
| 35 |
DEPENDENCIES |
| 36 |
|
| 37 |
Multiple core modules are used: |
| 38 |
base, Env, File::Spec, File::Which, IO::Handle, PerlIO, SelectSaver, |
| 39 |
Symbol, Text::Wrap, Tie::Handle |
| 40 |
|
| 41 |
Term::ReadKey is also require for IO::Pager::less, IO::Pager::Perl and tp. |
| 42 |
Win32::Console::ANSI, included in some distributions of Win32 perl like |
| 43 |
Strawberry is recommended on Windows for IO::Pager::less et al. to function. |
| 44 |
|
| 45 |
Test::More is used during the installation procedure. |
| 46 |
|
| 47 |
|
| 48 |
PORTABILITY |
| 49 |
|
| 50 |
IO::Pager is intended to be as portable as possible, I've tested it on numerous |
| 51 |
platform and perl version combinations. Most work fine though you may run |
| 52 |
into quirks, it tends to be happiest under perl built with perlio not stdio. |
| 53 |
|
| 54 |
COPYRIGHT AND LICENSE |
| 55 |
|
| 56 |
IO::Pager::Perl - Jerrad Pierce & Jeff Weisberg, Perl Artistic License |
| 57 |
|
| 58 |
All Else - Copyright (C) 2003-2020 Jerrad Pierce: |
| 59 |
|
| 60 |
* Thou shalt not claim ownership of unmodified materials. |
| 61 |
* Thou shalt not claim whole ownership of modified materials. |
| 62 |
* Thou shalt grant the indemnity of the provider of materials. |
| 63 |
* Thou shalt use and dispense freely without other restrictions. |
| 64 |
|
| 65 |
Or, if you prefer: |
| 66 |
|
| 67 |
This library is free software; you can redistribute it and/or modify it |
| 68 |
under the same terms as Perl itself, either Perl version 5.0 or, at your |
| 69 |
option, any later version of Perl 5 you may have available. |