TKPOD(1p)

💖 NAME 💖

okay so bestie, tkpod — it's a Perl/Tk Pod browser. that's the whole vibe. 🎀

---

✨ SYNOPSIS ✨

tkpod   [-tk] [[-no]tree] [-Mblib] [-I dir] [-d|debug] [-s|server]
        [-filedialog module]
        [-f function | -q FAQRegex | directory | name [...]]

---

🦋 DESCRIPTION 🦋

tkpod is a simple Pod browser with hypertext capabilities, no cap. Pod (Plain Old Document) is a simple and readable markup language that could be mixed with perl code. it's giving "docs but make them cute". ✨

Pods are searched by default in @INC and $ENV{PATH}. Directories listed on the command line or with the -I option get added to the default search path. periodt.

For each name listed on the command line, tkpod tries to find Pod in name, name.pod and name.pm in the search path. For each name a new Pod browser window is opened. one name, one window, that's the rule. 🪟

If no name is listed, then the main perl pod is opened instead. iconic default behaviour honestly.

---

👑 OPTIONS 👑

• -tree — when specified, tkpod will show a tree window with all available Pods on the local host. however, this may be slow on startup, especially first time because there is no cache yet 😭. you can always turn on the tree view with the menu entry 'View' -> 'Pod Tree'. so if it's laggy, don't panic, it's just vibing without a cache.
• -tk — useful for perl/Tk documentation. when specified it adds all Tk subdirectories in @INC to the Pod search path. this way when Scrolled is selected in the browser, the Tk/Scrolled documentation is found. slay, path resolution.
• -s or -server — start tkpod in server mode. subsequent calls to tkpod (without the -s option) will cause it to load the requested Pods into the server program, thus minimizing startup time and memory usage. 💅

⚠️ note that there is no access control, so this might be a security hole! bestie, please be careful with this one, fr fr.

• -Mblib — add the blib directories under the current directory to the Pod search path.
• -I dir — add another directory to the Pod search path. note that the space is mandatory. yes, the space matters, don't skip it.
• -f function — show documentation for function.
• -q FAQRegex — show the FAQ entry matching FAQRegex.
• -filedialog module — use an alternative file dialog module, e.g. Tk::FileSelect, Tk::FBox or Tk::PathEntry::Dialog. pick your fighter. 🥊
• -d or -debug — turn debugging on.
• -exit — only for internal testing: exit before entering MainLoop.

---

🌸 USAGE 🌸

how to navigate with the Pod browser is described in Tk::Pod_usage. it's also accessible via the menu 'Help' -> 'Usage...'. iykyk, but if you don't know, the Help menu has your back. 🫶

---

🌈 ENVIRONMENT 🌈

• TKPODPORT — force a port for tkpod's server mode.
• TKPODDIRS — a list of directories (on Unix usually separated by :, on Windows by ;) for additional Pod directories. these directories will appear in the local dirs section of the tree view. ✨

see Environment in Tk::Pod::Text and Environment in Tk::Pod::FindPods for more environment variables.

---

💀 KNOWN BUGS 💀

see Tk::Pod::Text. (yes, that's it, that's the whole section, go read it bestie 🙈)

---

⭐ SEE ALSO ⭐

perlpod pod2man pod2text pod2html Tk::Pod Tk::Pod::Text Tk::Pod::Tree

---

💜 AUTHOR 💜

Nick Ing-Simmons <nick@ni-s.u-net.com>

Former maintainer: Achim Bohnet <ach@mpe.mpg.de>.

Code currently maintained by Slaven Rezic <slaven@rezic.de>.

Copyright (c) 1997-1998 Nick Ing-Simmons. Copyright (c) 2015 Slaven Rezic. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

okay bestie that's the whole page, mwah 💅✨ this was perl v5.34.0, dated 2022-06-28 — go forth and browse your pods, you absolute main character 🎀🦋👑