README
1IO::Pager & IO::Pager::Perl
2=====================
3
4IO::Pager - Select a pager and pipe text to it if destination is a TTY
5IO::Pager::Perl - A pure perl pager engine
6
7IO::Pager::Perl is used in the IO::Pager::less IO::Pager subclass,
8but is also a free-standing library ready to be incorporated into
9other code.
10
11IO::Pager is lightweight and can be used to locate an available pager
12and set the PAGER environment variable sanely or as a factory for
13creating objects defined elsewhere such as IO::Pager::Buffered,
14IO::Pager::Unbuffered, and IO::Pager::less which provides a pure perl
15pager called tp.
16
17IO::Pager subclasses are designed to programmatically decide whether
18or not to pipe a filehandle's output to a program specified in PAGER.
19Subclasses may inherit from IO::Pager, and implement the IO handle
20methods desired.
21
22
23INSTALLATION
24
25To 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
35DEPENDENCIES
36
37Multiple core modules are used:
38base, Env, File::Spec, File::Which, IO::Handle, PerlIO, SelectSaver,
39Symbol, Text::Wrap, Tie::Handle
40
41Term::ReadKey is also require for IO::Pager::less, IO::Pager::Perl and tp.
42Win32::Console::ANSI, included in some distributions of Win32 perl like
43Strawberry is recommended on Windows for IO::Pager::less et al. to function.
44
45Test::More is used during the installation procedure.
46
47
48PORTABILITY
49
50IO::Pager is intended to be as portable as possible, I've tested it on numerous
51platform and perl version combinations. Most work fine though you may run
52into quirks, it tends to be happiest under perl built with perlio not stdio.
53
54COPYRIGHT AND LICENSE
55
56IO::Pager::Perl - Jerrad Pierce & Jeff Weisberg, Perl Artistic License
57
58All 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.
70