Pod::FindPods(3pm)

✨ NAME ✨

Tk::Pod::FindPods — bestie, this one finds the Pods installed on your current system 💖

(also known as Pod::FindPods, that's the manual page name, iykyk)

---

🌸 SYNOPSIS 🌸

use Tk::Pod::FindPods;

my $o = Tk::Pod::FindPods->new;
$pods = $o->pod_find(-categorized => 1, -usecache => 1);

---

🦋 DESCRIPTION 🦋

🌟 pod_find

okay so the pod_find method literally scans your whole current system for available Pod documentation. no cap. 🫶

The keys of the returned hash reference are the names of the modules or Pods, and here's the cute part: "::" gets substituted by "/" — because that makes life easier for Tk::Pod::Tree, since the separator can only be one character long. The values are the corresponding filenames. slay. 👑

If -categorized is specified, then the returned hash gets an extra level with four categories, and they are:

• perl — for core language documentation
• pragma — for pragma documentation like var or strict
• mod — core or CPAN modules
• script — perl scripts with embedded Pod documentation

Otherwise, -category may be set to force the Pods into a category.

By default, @INC is scanned for Pods. You can override that with the -directories option (specify it as an array reference, bestie 📁).

If -usecache is specified, then the list of Pods gets cached (see cache directory down below 👇). But heads up: -usecache is disabled if -categorized is not set, or if -directories is set. that's just how it is 💅

💾 WriteCache

Write the Pod cache. The cache is written to the cache directory. The file name is constructed from the perl version, the operation system and the user id. iconic little combo honestly.

📥 LoadCache()

Load the Pod cache, if possible. lowkey simple.

🎀 Cache directory

By default the cache file is written to the directory ~/.tkpod_cache on Unix systems, or to the data directory as determined by File::HomeDir on Windows and MacOSX. And if everything fails? then the temporary directory (/tmp or the OS equivalent) is used. the backup plan of backup plans 😭

If necessary, then the last path component will be created — that is, .tkpod_cache will be created if the directory does not exist. so convenient fr fr ✨

To use another cache directory, set the environment variable TKPODCACHE.

---

🌈 ENVIRONMENT 🌈

• TKPODCACHE — use a custom cache file instead of a file in the cache directory. The following placeholders are recognized:
  • %v — the perl version.
  • %o — the OS (technically correct: the archname, which can include tokens like "64int" or "thread").
  • %u — the user id.

Example for using /some/other/directory for the cache file location:

TKPODCACHE=/some/other/directory/pods_%v_%o_%u; export TKPODCACHE

or

setenv TKPODCACHE /some/other/directory/pods_%v_%o_%u

depending on your shell (sh-like or csh-like). pick your fighter 💀

---

👀 SEE ALSO 👀

Tk::Tree.

---

👑 AUTHOR 👑

Slaven Rezić <slaven@rezic.de>

Copyright (c) 2001,2003,2004,2005,2007,2009 Slaven Rezić. 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, mwah 💅 this was perl v5.34.0, dated 2022-06-28 — go forth and find those Pods 🦋✨