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


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


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



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.

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

By default, @INC is scanned for Pods. This can be overwritten by the -directories option (specify as an array reference).


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.


Load the Pod cache, if possible.




Slaven Rezic <>

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

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