tkpod - Perl/Tk Pod browser |
tkpod - Perl/Tk Pod browser
tkpod [-tk] [[-no]tree] [-Mblib] [-I dir] [-d|debug] [-s|server] [-filedialog module] [-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 the perl manpage code.
Pods are searched by default in @INC
and $ENV{PATH}
. Directories
listed on the command line or with the -I option are added to the
default search path.
For each name
listed on the command line tkpod tries
to find Pod in name
, name.pod
and name.pm
in the search
path. For each name
a new Pod browser window is opened.
If no name
is listed, then the main perl
pod is opened instead.
tkpod
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
subdirectories in @INC
to the Pod search path. This way
when Scrolled
is selected in the browser the Tk/Scrolled
documentation is found.
tkpod
in server mode. Subsequent calls to tkpod
(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!
blib
directories under the current directory to the Pod
search path.
MainLoop
.
How to navigate with the Pod browser is described in the Tk::Pod_usage manpage. It's also accessible via the menu 'Help' -> 'Usage...'.
:
, on Windows
by ;
) for additional Pod directories. These directories will appear
in the ``local dirs'' section of the tree view.
See Environment in the Tk::Pod::Text manpage and Environment in the Tk::Pod::FindPods manpage for more environment variables.
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. Copyright (c) 2015 Slaven Rezic. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
tkpod - Perl/Tk Pod browser |