TKPOD(1)

💅 NAME 💅

okay so this is tkpod — the Perl/Tk Pod browser. that's it, that's the vibe. a cute little browser for Pod docs, bestie 🫶

(this page lives in section 1 of the manual, under "User Contributed Perl Documentation", iykyk)

---

✨ 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 — like, it does the linking thing, it's giving actual browser energy.

so what even is Pod? it's Plain Old Document: a simple, readable markup language that could be mixed with perl code. lowkey icon behavior, honestly.

pods are searched by default in @INC and $ENV{PATH}. any directories you list on the command line, or pass with the -I option, get added to that default search path. slay.

for each name listed on the command line, tkpod tries to find Pod in name, name.pod and name.pm in the search path. and for each name, a shiny new Pod browser window opens up 🌸 — one per name, no sharing, main character energy for each.

and if no name is listed at all? then the main perl pod is opened instead. default queen 👑.

---

💖 OPTIONS 💖

• -tree — when you specify this, tkpod will show a tree window with all the available Pods on the local host. but ngl, this may be slow on startup, especially the first time, because there's no cache yet 😭. no worries though, you can always turn on the tree view later with the menu entry 'View' -> 'Pod Tree'.
• -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 actually found. that's the whole point, fr fr ✨
• -s or -server — starts tkpod in server mode. subsequent calls to tkpod (without the -s option) will cause the requested Pods to load into the server program instead, which minimizes startup time and memory usage. so efficient 💅

⚠️ heads up bestie: there is no access control, so this might be a security hole! take that seriously, okay? 🚨

• -Mblib — adds the blib directories under the current directory to the Pod search path.
• -I dir — adds another directory to the Pod search path. note that the space is mandatory. like, you literally have to put it there. -I dir, not -Idir. 🙈
• -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. mix it up, pick your fave 🎀
• -d or -debug — turn debugging on. the lights come on 💡
• -exit — only for internal testing: exit before entering MainLoop. that's it, that's the whole thing.

---

🌈 USAGE 🌈

how to navigate around with the Pod browser is described in Tk::Pod_usage. it's also accessible via the menu 'Help' -> 'Usage...'. so if you're ever lost, that's where to go, bestie 🫶

---

🍓 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. so organized ✨

see Environment in Tk::Pod::Text and Environment in Tk::Pod::FindPods for more environment variables. there's more where that came from 👀

---

💀 KNOWN BUGS 💀

see Tk::Pod::Text. that's the whole section. go look, i don't make the rules.

---

🔥 SEE ALSO 🔥

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

the whole friend group, all linked, all iconic 🌟

---

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

---

periodt, that's the page 💜 this was perl v5.32.1, dated 2024-09-25, and we ate, no cap 🎀✨