1Pod::FindPods(3)      User Contributed Perl Documentation     Pod::FindPods(3)
2
3
4

NAME

6       Tk::Pod::FindPods - find Pods installed on the current system
7

SYNOPSIS

9           use Tk::Pod::FindPods;
10
11           my $o = Tk::Pod::FindPods->new;
12           $pods = $o->pod_find(-categorized => 1, -usecache => 1);
13

DESCRIPTION

15   pod_find
16       The pod_find method scans the current system for available Pod
17       documentation. The keys of the returned hash reference are the names of
18       the modules or Pods ("::" substituted by "/" --- this makes it easier
19       for Tk::Pod::Tree, as the separator may only be of one character). The
20       values are the corresponding filenames.
21
22       If "-categorized" is specified, then the returned hash has an extra
23       level with four categories: perl (for core language documentation),
24       pragma (for pragma documentation like var or strict), mod (core or CPAN
25       modules), and script (perl scripts with embedded Pod documentation).
26       Otherwise, "-category" may be set to force the Pods into a category.
27
28       By default, @INC is scanned for Pods. This can be overwritten by the
29       "-directories" option (specify as an array reference).
30
31       If "-usecache" is specified, then the list of Pods is cached (see cache
32       directory). "-usecache" is disabled if "-categorized" is not set or
33       "-directories" is set.
34
35   WriteCache
36       Write the Pod cache. The cache is written to the cache directory. The
37       file name is constructed from the perl version, operation system and
38       user id.
39
40   LoadCache()
41       Load the Pod cache, if possible.
42
43   Cache directory
44       By default the cache file is written to the directory ~/.tkpod_cache
45       (Unix systems), or the data directory as determined by File::HomeDir
46       (Windows, MacOSX). If everything fails, then the temporary directory
47       (/tmp or the OS equivalent) is used.
48
49       If necessary, then the last path component will be created (that is,
50       .tkpod_cache will be created if the directory does not exist).
51
52       To use another cache directory set the environment variable
53       "TKPODCACHE".
54

ENVIRONMENT

56       TKPODCACHE
57           Use a custom cache file instead of a file in the cache directory.
58           The following placeholders are recognized:
59
60           %v  The perl version.
61
62           %o  The OS (technically correct: the archname, which can include
63               tokens like "64int" or "thread").
64
65           %u  The user id.
66
67           Example for using /some/other/directory for the cache file
68           location:
69
70                   TKPODCACHE=/some/other/directory/pods_%v_%o_%u; export TKPODCACHE
71
72           or
73
74                   setenv TKPODCACHE /some/other/directory/pods_%v_%o_%u
75
76           depending on your shell (sh-like or csh-like).
77

SEE ALSO

79       Tk::Tree.
80

AUTHOR

82       Slaven Rezić <slaven@rezic.de>
83
84       Copyright (c) 2001,2003,2004,2005,2007,2009 Slaven Rezić. All rights
85       reserved.  This program is free software; you can redistribute it
86       and/or modify it under the same terms as Perl itself.
87
88
89
90perl v5.34.0                      2021-07-23                  Pod::FindPods(3)
Impressum