NAME

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

SYNOPSIS

use Tk::Pod::FindPods qw/pod_find/;

%pods = 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 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 three categories: perl (for core language documentation), pragmata (for pragma documentation like var or strict) and modules (core or CPAN modules).

If -usecache is specified, then the list of PODs is cached in a temporary directory.

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.

SEE ALSO

Tk::Tree(3).

AUTHOR

Slaven Rezic <slaven.rezic@berlin.de>

Copyright (c) 2001 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.