README
1Tk::Pod
2
3This is a graphical user interface for viewing and browsing perl's Pod
4documentation.
5
6To install, type
7
8 cpan .
9
10if you have a modern CPAN.pm, otherwise
11
12 perl Makefile.PL (resolve all dependencies)
13 make
14 make test
15 make demo (optional)
16 make install
17
18Windows users should replace "make" with "nmake" if using ActivePerl
19or "dmake" if using Vanilla or Strawberry Perl.
20
21At least perl 5.005 and Tk 800.004 are required.
22
23Features include:
24 o A standalone Tk pod viewer: tkpod
25 o Interface to perlindex full text Pod search
26 (you need to install the perlindex distribution aka
27 Text::English from CPAN and create an index using
28 "perlindex -index").
29 o Supports single or multiple Pod windows.
30 o more/less-like Tk::More widget with '/', 'n', 'N', 'j', 'k'
31 bindings
32 o Tree view of available Pods
33 o links to URLs and man pages are also handled
34 o printing using postscript, RTF or text output
35
36If Tk::ToolBar is installed, then tkpod may use the Tk::ToolBar icons
37for the menus. This works both in Tk804 with native compounds and in
38Tk800 using Tk::Compound.
39
40The original Tk::Pod module was written by Nick Ing-Simmons
41<nik@tiuk.ti.com>. Former maintainer was Achim Bohnet. Current
42maintainer is Slaven Rezic <srezic@cpan.org>. Pod::Simple support is
43by Sean Burke. Please send bug reports, patches and comments to the
44current maintainer.
45
46__END__
47