Tk::Pod_usage(3pm)

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

NAME

6       Tk::Pod_usage - How to use the perl/Tk Pod browser widget
7

DESCRIPTION

9       To navigate through the documentation one could use
10
11   Hyperlinks
12       A click on a hyperlink display the corresponding Pod documentation (if
13       there is any) in the same window. An URL will be displayed in a web
14       browser. A man page will be displayed in a man viewer (if one is
15       available).
16
17       With <Button-2> the documentation is loaded into a new window
18       (<Shift-Button-1> works also for those with only a 2 button mouse).
19
20   Selection
21       A double click tries to load the documentation for the selected word in
22       the same window.
23
24       If the "Shift" key is simultaneously pressed a new browser window is
25       opened.
26
27   Key bindings
28       The Tk::Pod::Text widget is based on the Tk::More widget inheriting its
29       key bindings.
30
31   Search
32       Pressing <Key-/> lets you search in the displayed documentation.
33
34   Section Menu
35       The Section Menu
36
37       The 'Section' menu allows one to directly jump to the start of a
38       section in the documentation.
39
40   Action Menu
41       If you press the right mouse button you get a popup menu that allows:
42
43       o Back
44           in history of displayed documentation
45
46       o Forward
47           in history of displayed documentation
48
49       o Reload
50           the documentation
51
52       o Edit Pod
53           Start editor with source of the displayed document.
54
55           The used editor is selected by the first definition of the
56           environment variables "TKPODEDITOR", "XEDITOR", "VISUAL", "EDITOR"
57           or as default /usr/bin/vi. If no terminal is available (or on
58           Windows platforms), the ptked editor (bundled with Perl/Tk) will be
59           used instead.
60
61           See also the menu entries 'File' -> 'Edit' and 'File' -> 'Edit with
62           ptked'.
63
64       o Search fulltext
65           Full text search of the Pod in the perl library directories. (Note:
66           to use it one has to install the perlindex distribution and build
67           an index for the perl documentation, see Text::English)
68
69       The remaining menu entries are the same as in normal "Text" widgets.
70
71   Tree view
72       You can toggle the tree view of all installed modules on or off with
73       the 'View' -> 'Pod Tree' menu entry. The tree view is organized in
74       three sections: Perl language (general documentation about Perl),
75       Pragmata, and Modules. The labels in the tree are colored, where green
76       means "standard module which comes with the Perl core distribution",
77       red means "locally installed module, probably from CPAN", and grey
78       means "no module available, look at the subtree".
79
80       The tree data is cached in a temporary directory on a per-perl-version
81       and per-user basis. A reload can be forced with the Reload entry in the
82       action menu of the tree view. With the Search entry a search in the
83       tree can be performed. The Show modules at CPAN entry is highly
84       experimental - you can download, extract and look at the documentation
85       of all CPAN modules.
86

KEYWORDS

92       pod, browser, tk, hypertext
93

AUTHOR

95       Achim Bohnet <ach@mpe.mpg.de>
96
97       Current maintainer is Slaven Rezic <slaven@rezic.de>
98
99       Copyright (c) 1997-1998 Achim Bohnet. All rights reserved.  This
100       documentation is free software; you can redistribute it and/or modify
101       it under the same terms as Perl itself.
102
103
104
105perl v5.34.0                      2022-01-21                      Pod_usage(3)

NAME

DESCRIPTION

SEE ALSO

KEYWORDS

AUTHOR