.\" 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 "Pod 3pm"
.TH Pod 3pm "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"
Tk::Pod \- Pod browser toplevel widget
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Tk::Pod
\&
\&    Tk::Pod\->Dir(@dirs)                 # add dirs to search path for Pod
\&
\&    $pod = $parent\->Pod(
\&                \-file = > $name,        # search and display Pod for name
\&                \-tree = > $bool         # display pod file tree
\&                );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Simple Pod browser with hypertext capabilities in a \f(CW\*(C`Toplevel\*(C'\fR widget
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-tree" 4
.IX Item "-tree"
Set tree view by default on or off. Default is false.
.IP "\-exitbutton" 4
.IX Item "-exitbutton"
Add to the menu an exit entry. This is only useful for standalone pod
readers. Default is false. This option can only be set on construction
time.
.PP
Other options are propagated to the embedded Tk::Pod::Text widget.
.SH "BUGS"
.IX Header "BUGS"
If you set \f(CW\*(C`\-file\*(C'\fR while creating the Pod widget,
.PP
.Vb 1
\&    $parent\->Pod(\-tree => 1, \-file => $pod);
.Ve
.PP
then the title will not be displayed correctly. This is because the
internal setting of \f(CW\*(C`\-title\*(C'\fR may override the title setting caused by
\&\f(CW\*(C`\-file\*(C'\fR. So it is better to configure \f(CW\*(C`\-file\*(C'\fR separately:
.PP
.Vb 2
\&    $pod = $parent\->Pod(\-tree => 1);
\&    $pod\->configure(\-file => $pod);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Tk::Pod_usage, Tk::Pod::Text, tkpod, perlpod,
Gtk2::Ex::PodViewer, Prima::PodView.
.SH "AUTHOR"
.IX Header "AUTHOR"
Nick Ing-Simmons <\fInick@ni\-s.u\-net.com\fR>
.PP
Current maintainer is Slaven Rezic <\fIslaven@rezic.de\fR>.
.PP
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.