The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

tkpod - Perl/Tk POD browser

SYNOPSIS

    tkpod  [-tk]  [directory]|name [...]

DESCRIPTION

tkpod is a simple POD browser with hypertext capabilities. POD (Plain Old Document) is a simple and readable markup language that could be mixed with perl code.

PODs are searched by default in @INC. Directories listed on the command line are added to the default search path.

For each name listed on the command line tkpod tries to to find POD in name, name.pod and name.pm in the search path. For each name a new POD browser window is opened.

OPTIONS

-tk

Useful for perl/Tk documentation. When specified it adds all Tk subdirectories in @INC to the POD search path. This way when Scrolled is selected in the browser the Tk/Scrolled documentation is found.

USAGE

How to navigate with the POD browser is described in Tk::Pod_usage. It's also accessible via the menu 'Help' -> 'Usage...'.

KNOWN BUGS

see Tk::Pod::Text

SEE ALSO

perlpod pod2man pod2text pod2html Tk::Pod Tk::Pod::Text

AUTHOR

Nick Ing-Simmons <nick@ni-s.u-net.com>

Code currently maintained by Achim Bohnet <ach@mpe.mpg.de>. Please send bug reports to <ptk@lists.stanford.edu>.

Copyright (c) 1997-1998 Nick Ing-Simmons. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.