NAME¶
Tk::Pod_usage - How to use the perl/Tk Pod browser widget
DESCRIPTION¶
To navigate through the documentation one could use
Hyperlinks¶
A
click on a hyperlink display the corresponding Pod documentation (if
there is any) in the same window. An URL will be displayed in a web browser. A
man page will be displayed in a man viewer (if one is available).
With <Button-2> the documentation is loaded into a new window
(<Shift-Button-1> works also for those with only a 2 button mouse).
Selection¶
A
double click tries to load the documentation for the selected word in
the same window.
If the "Shift" key is simultaneously pressed a new browser window is
opened.
Key bindings¶
The Tk::Pod::Text widget is based on the Tk::More widget inheriting its key
bindings.
Search¶
Pressing <Key-/> lets you search in the displayed documentation.
The Section Menu
The 'Section' menu allows one to directly jump to the start of a section in the
documentation.
If you press the right mouse button you get a popup menu that allows:
- o Back
- in history of displayed documentation
- o Forward
- in history of displayed documentation
- o Reload
- the documentation
- o Edit Pod
- Start editor with source of the displayed document.
The used editor is selected by the first definition of the environment
variables "TKPODEDITOR", "XEDITOR",
"VISUAL", "EDITOR" or as default /usr/bin/vi.
If no terminal is available (or on Windows platforms), the ptked editor
(bundled with Perl/Tk) will be used instead.
See also the menu entries 'File' -> 'Edit' and 'File' -> 'Edit with
ptked'.
- o Search fulltext
- Full text search of the Pod in the perl library directories. (Note: to use
it one has to install the perlindex distribution and build an index for
the perl documentation, see Text::English)
The remaining menu entries are the same as in normal "Text" widgets.
Tree view¶
You can toggle the tree view of all installed modules on or off with the 'View'
-> 'Pod Tree' menu entry. The tree view is organized in three sections:
Perl language (general documentation about Perl), Pragmata, and Modules. The
labels in the tree are colored, where green means "standard module which
comes with the Perl core distribution", red means "locally installed
module, probably from CPAN", and grey means "no module available,
look at the subtree".
The tree data is cached in a temporary directory on a per-perl-version and
per-user basis. A reload can be forced with the
Reload entry in the
action menu of the tree view. With the
Search entry a search in the
tree can be performed. The
Show modules at CPAN entry is highly
experimental - you can download, extract and look at the documentation of all
CPAN modules.
SEE ALSO¶
tkpod, perlpod, pod2man, pod2text, pod2html, Tk::Pod, Tk::Pod::Text,
Tk::Pod::Tree, Tk::More, Text::English.
KEYWORDS¶
pod, browser, tk, hypertext
AUTHOR¶
Achim Bohnet <
ach@mpe.mpg.de>
Current maintainer is Slaven Rezic <
slaven@rezic.de>
Copyright (c) 1997-1998 Achim Bohnet. All rights reserved. This documentation is
free software; you can redistribute it and/or modify it under the same terms
as Perl itself.