The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.


Tk::Pod - Pod browser toplevel widget


    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


Simple Pod browser with hypertext capabilities in a Toplevel widget



Set tree view by default on or off. Default is false.


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.


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);


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


Nick Ing-Simmons <>

Current maintainer is Slaven Rezic <>.

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.