.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TKPOD 1p"
.TH TKPOD 1p "2016-02-14" "perl v5.22.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
tkpod \- Perl/Tk Pod browser
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    tkpod   [\-tk] [[\-no]tree] [\-Mblib] [\-I dir] [\-d|debug] [\-s|server]
\&            [\-filedialog module]
\&            [\-f function | \-q FAQRegex | directory | name [...]]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBtkpod\fR 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.
.PP
Pods are searched by default in \f(CW@INC\fR and \f(CW$ENV{PATH}\fR. Directories
listed on the command line or with the \fB\-I\fR option are added to the
default search path.
.PP
For each \f(CW\*(C`name\*(C'\fR listed on the command line \fBtkpod\fR tries
to find Pod in \f(CW\*(C`name\*(C'\fR, \f(CW\*(C`name.pod\*(C'\fR and \f(CW\*(C`name.pm\*(C'\fR in the search
path.  For each \f(CW\*(C`name\*(C'\fR a new Pod browser window is opened.
.PP
If no \f(CW\*(C`name\*(C'\fR is listed, then the main \f(CW\*(C`perl\*(C'\fR pod is opened instead.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-tree\fR" 4
.IX Item "-tree"
When specified, \f(CW\*(C`tkpod\*(C'\fR 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'.
.IP "\fB\-tk\fR" 4
.IX Item "-tk"
Useful for perl/Tk documentation.  When specified it adds all
\&\f(CW\*(C`Tk\*(C'\fR subdirectories in \f(CW@INC\fR to the Pod search path.   This way
when \f(CW\*(C`Scrolled\*(C'\fR is selected in the browser the \f(CW\*(C`Tk/Scrolled\*(C'\fR
documentation is found.
.IP "\fB\-s\fR or \fB\-server\fR" 4
.IX Item "-s or -server"
Start \f(CW\*(C`tkpod\*(C'\fR in server mode. Subsequent calls to \f(CW\*(C`tkpod\*(C'\fR (without
the \fB\-s\fR 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!
.IP "\fB\-Mblib\fR" 4
.IX Item "-Mblib"
Add the \f(CW\*(C`blib\*(C'\fR directories under the current directory to the Pod
search path.
.IP "\fB\-I\fR \fIdir\fR" 4
.IX Item "-I dir"
Add another directory to the Pod search path. Note that the space is
mandatory.
.IP "\fB\-f\fR \fIfunction\fR" 4
.IX Item "-f function"
Show documentation for \fIfunction\fR.
.IP "\fB\-q\fR \fIFAQRegex\fR" 4
.IX Item "-q FAQRegex"
Show the \s-1FAQ\s0 entry matching \fIFAQRegex\fR.
.IP "\fB\-filedialog\fR \fImodule\fR" 4
.IX Item "-filedialog module"
Use an alternative file dialog module, e.g. Tk::FileSelect,
Tk::FBox or Tk::PathEntry::Dialog.
.IP "\fB\-d\fR or \fB\-debug\fR" 4
.IX Item "-d or -debug"
Turn debugging on.
.IP "\fB\-exit\fR" 4
.IX Item "-exit"
Only for internal testing: exit before entering \f(CW\*(C`MainLoop\*(C'\fR.
.SH "USAGE"
.IX Header "USAGE"
How to navigate with the Pod browser is described in Tk::Pod_usage.
It's also accessible via the menu 'Help' \-> 'Usage...'.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
.IP "\s-1TKPODPORT\s0" 4
.IX Item "TKPODPORT"
Force a port for tkpod's server mode.
.IP "\s-1TKPODDIRS\s0" 4
.IX Item "TKPODDIRS"
A list of directories (on Unix usually separated by \f(CW\*(C`:\*(C'\fR, on Windows
by \f(CW\*(C`;\*(C'\fR) for additional Pod directories. These directories will appear
in the \*(L"local dirs\*(R" section of the tree view.
.PP
See \*(L"Environment\*(R" in Tk::Pod::Text and \*(L"Environment\*(R" in Tk::Pod::FindPods
for more environment variables.
.SH "KNOWN BUGS"
.IX Header "KNOWN BUGS"
see Tk::Pod::Text
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perlpod
pod2man
pod2text
pod2html
Tk::Pod
Tk::Pod::Text
Tk::Pod::Tree
.SH "AUTHOR"
.IX Header "AUTHOR"
Nick Ing-Simmons <\fInick@ni\-s.u\-net.com\fR>
.PP
Former maintainer: Achim Bohnet <\fIach@mpe.mpg.de\fR>.
.PP
Code currently maintained by Slaven Rezic <\fIslaven@rezic.de\fR>.
.PP
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.