NAME

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

SYNOPSIS

    use Tk::Pod::FindPods;

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

DESCRIPTION

pod_find

The pod_find method scans the current system for available Pod documentation. The keys of the returned hash reference are the names of the modules or Pods (:: substituted by / --- this makes it easier for Tk::Pod::Tree, as the separator may only be of one character). The values are the corresponding filenames.

If -categorized is specified, then the returned hash has an extra level with four categories: perl (for core language documentation), pragma (for pragma documentation like var or strict), mod (core or CPAN modules), and 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. This can be overwritten by the -directories option (specify as an array reference).

If -usecache is specified, then the list of Pods is cached in a temporary directory. -usecache is disabled if -categorized is not set or -directories is set.

WriteCache

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

LoadCache()

Load the Pod cache, if possible.

ENVIRONMENT

TKPODCACHE

Path for the cache file. By default, the cache file is written to the temporary directory (/tmp or the OS equivalent). 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 /var/tmp instead of /tmp for the cache file location (on many systems /var/tmp is persistent, unlike /tmp):

        setenv TKPODCACHE /var/tmp/pods_%v_%o_%u

or

        TKPODCACHE=/var/tmp/pods_%v_%o_%u; export TKPODCACHE

depending on your shell.

SEE ALSO

Tk::Tree(3).

AUTHOR

Slaven Rezic <slaven@rezic.de>

Copyright (c) 2001,2003,2004,2005 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.