1Pod(3)                User Contributed Perl Documentation               Pod(3)
2
3
4

NAME

6       Tk::Pod - Pod browser toplevel widget
7

SYNOPSIS

9           use Tk::Pod
10
11           Tk::Pod->Dir(@dirs)                 # add dirs to search path for Pod
12
13           $pod = $parent->Pod(
14                       -file = > $name,        # search and display Pod for name
15                       -tree = > $bool         # display pod file tree
16                       );
17

DESCRIPTION

19       Simple Pod browser with hypertext capabilities in a "Toplevel" widget
20

OPTIONS

22       -tree
23           Set tree view by default on or off. Default is false.
24
25       -exitbutton
26           Add to the menu an exit entry. This is only useful for standalone
27           pod readers. Default is false. This option can only be set on
28           construction time.
29
30       Other options are propagated to the embedded Tk::Pod::Text widget.
31

BUGS

33       If you set "-file" while creating the Pod widget,
34
35           $parent->Pod(-tree => 1, -file => $pod);
36
37       then the title will not be displayed correctly. This is because the
38       internal setting of "-title" may override the title setting caused by
39       "-file". So it is better to configure "-file" separately:
40
41           $pod = $parent->Pod(-tree => 1);
42           $pod->configure(-file => $pod);
43

SEE ALSO

45       Tk::Pod_usage, Tk::Pod::Text, tkpod, perlpod, Gtk2::Ex::PodViewer,
46       Prima::PodView.
47

AUTHOR

49       Nick Ing-Simmons <nick@ni-s.u-net.com>
50
51       Current maintainer is Slaven Rezic <slaven@rezic.de>.
52
53       Copyright (c) 1997-1998 Nick Ing-Simmons.  All rights reserved.  This
54       program is free software; you can redistribute it and/or modify it
55       under the same terms as Perl itself.
56
57
58
59perl v5.36.0                      2023-01-20                            Pod(3)