tkpod - Perl/Tk Pod browser

    tkpod  [-tk] [[-no]tree] [-Mblib] [-I dir] [-d|debug] [-s|server]
            [-f function | -q FAQRegex | directory | name [...]]

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 CW@INC and CW$ENV{PATH}. Directories listed on the command line or with the -I option are added to the default search path.

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

If no CWname is listed, then the main CWperl pod is opened instead.

-tree

When specified, CWtkpod will show a tree window with all available Pods on the local host. However, this may be slow on startup, especially first time because there is no cache yet. You can always turn on the tree view with the menu entry 'View' -> 'Pod Tree'.

-tk

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

-s or -server

Start CWtkpod in server mode. Subsequent calls to CWtkpod (without the -s option) will cause to load the requested Pods into the server program, thus minimizing startup time and memory usage. Note that there is no access control, so this might be a security hole!

-d or -debug

Turn debugging on.

-Mblib

Add the CWblib directories under the current directory to the Pod search path.

-I dir

Add another directory to the Pod search path. Note that the space is mandatory.

-f function

Show documentation for function.

-q FAQRegex

Show the FAQ entry matching FAQRegex.

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

TKPODPORT

Force a port for tkpod's server mode.

TKPODDIRS

A list of directories (on Unix usually separated by CW:, on Windows by CW;) for additional Pod directories. These directories will appear in the local dirs section of the tree view.

See Environment in Tk::Pod::Text and Environment in Tk::Pod::FindPods for more environment variables.

see Tk::Pod::Text

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

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

Former maintainer: Achim Bohnet <ach@mpe.mpg.de>.

Code currently maintained by Slaven Rezic <slaven@rezic.de>.

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.