-
-
31 Jan 2016 13:45:11 UTC
- Distribution: Tk-Pod
- Module version: 5.41
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Repository
- Issues (2)
- Testers (3295 / 26 / 0)
- Kwalitee
Bus factor: 1- % Coverage
- License: perl_5
- Activity
24 month- Tools
- Download (75.13KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- File::Spec
- File::Temp
- Pod::Simple
- Tk
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Tk::Pod - Pod browser toplevel widget
SYNOPSIS
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 );
DESCRIPTION
Simple Pod browser with hypertext capabilities in a
Toplevel
widgetOPTIONS
- -tree
-
Set tree view by default on or off. Default is false.
- -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.
Other options are propagated to the embedded Tk::Pod::Text widget.
BUGS
If you set
-file
while creating the Pod widget,$parent->Pod(-tree => 1, -file => $pod);
then the title will not be displayed correctly. This is because the internal setting of
-title
may override the title setting caused by-file
. So it is better to configure-file
separately:$pod = $parent->Pod(-tree => 1); $pod->configure(-file => $pod);
SEE ALSO
Tk::Pod_usage, Tk::Pod::Text, tkpod, perlpod, Gtk2::Ex::PodViewer, Prima::PodView.
AUTHOR
Nick Ing-Simmons <nick@ni-s.u-net.com>
Current maintainer is Slaven Rezic <slaven@rezic.de>.
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.
Module Install Instructions
To install Tk::Pod, copy and paste the appropriate command in to your terminal.
cpanm Tk::Pod
perl -MCPAN -e shell install Tk::Pod
For more information on module installation, please visit the detailed CPAN module installation guide.