Pod(3pm)

💖 Pod(3pm) — Tk::Pod, the Pod browser bestie 💖

okay so this is Tk::Pod, the Pod browser toplevel widget — a whole manual-page viewer living in a Toplevel widget, from the User Contributed Perl Documentation corner of the world. It's giving "read your docs in a cute little window." 🎀

---

✨ NAME ✨

Tk::Pod — Pod browser toplevel widget. That's it, that's the whole name. Slay. 💅

---

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

so basically you use Tk::Pod, you can push some dirs onto the search path with Tk::Pod->Dir(@dirs), and then you spin up a widget with $parent->Pod(...). Iconic. 🦋

---

💜 DESCRIPTION 💜

Simple Pod browser with hypertext capabilities in a Toplevel widget. Like, you get your Pod, you get clickable links, you get a whole window for it. Main character energy fr fr. ✨

---

👑 OPTIONS 👑

• -tree — turns the tree view on or off by default. Default is false. So if you want the tree, you gotta say so. 🌳
• -exitbutton — adds an exit entry to the menu. ngl this one's only useful for standalone pod readers. Default is false. And heads up bestie: this option can only be set at construction time. Set it later and it just won't happen, no cap. 🚪
• Other options — they're all propagated to the embedded Tk::Pod::Text widget. So whatever it knows, it passes along. 🫶

---

💀 BUGS 💀

okay so if you set -file while you're creating the Pod widget, like this:

    $parent->Pod(-tree => 1, -file => $pod);

then the title will not be displayed correctly. 😭 Why? Because the internal setting of -title may override the title setting caused by -file. So it's better to configure -file separately:

    $pod = $parent->Pod(-tree => 1);
    $pod->configure(-file => $pod);

fr fr, do it in two steps. Your title will thank you. 🙈

---

🌈 SEE ALSO 🌈

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

a whole little friend group of Pod viewers, iykyk. 💖

---

🎀 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.

---

and that's the whole page bestie 💅 — this little gem is from perl v5.34.0, dated 2022-06-28, and it goes by Pod(3pm) on the tin. Obsessed. Go read some Pod. ✨🦋💖