tk::pod::findpods(3pm) [debian man page]

Pod::FindPods(3pm)					User Contributed Perl Documentation					Pod::FindPods(3pm)

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 (see cache directory). "-usecache" is disabled if "-categorized" is not set or
       "-directories" is set.

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

   LoadCache()
       Load the Pod cache, if possible.

   Cache directory
       By default the cache file is written to the directory ~/.tkpod_cache (Unix systems), or the data directory as determined by File::HomeDir
       (Windows, MacOSX). If everything fails, then the temporary directory (/tmp or the OS equivalent) is used.

       If necessary, then the last path component will be created (that is, .tkpod_cache will be created if the directory does not exist).

       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).

SEE ALSO

       Tk::Tree.

AUTHOR

       Slaven ReziX <slaven@rezic.de>

       Copyright (c) 2001,2003,2004,2005,2007,2009 Slaven ReziX. All rights reserved.  This program is free software; you can redistribute it
       and/or modify it under the same terms as Perl itself.

perl v5.14.2							    2012-03-05							Pod::FindPods(3pm)

Check Out this Related Man Page

Pod::Tree::PerlBin(3pm) 				User Contributed Perl Documentation				   Pod::Tree::PerlBin(3pm)

NAME

       Pod::Tree::PerlBin - translate program PODs to HTML

SYNOPSIS

	 $perl_map = new Pod::Tree::PerlMap;
	 $perl_bin = new Pod::Tree::PerlBin $perl_dir, $HTML_dir, $perl_map, %opts;

	 $perl_bin->scan(@path);
	 $perl_bin->index;
	 $perl_bin->translate;

	 $top = $perl_bin->get_top_entry;

DESCRIPTION

       "Pod::Tree::PerlBin" translates program PODs to HTML.

       It searches for programs in a list of directories (typically a PATH), and searches for PODs withing the programs.  Only text (-T) files are
       considered.

       "Pod::Tree::PerlBin" generates a top-level index of all the program PODs, and writes it to HTML_dir"/bin.html".

       "Pod::Tree::PerlBin" generates and uses an index of the PODs that it finds to construct HTML links.  Other modules can also use this index.

METHODS

       $perl_bin = "new" "Pod::Tree::PerlBin" $perl_dir, $HTML_dir, $perl_map, %options
	   Creates and returns a new "Pod::Tree::PerlBin" object.

	   $HTML_dir is the directory where HTML files will be written.

	   $perl_map maps program names to URLs.

	   %options are passed through to "Pod::Tree::HTML".

	   The $perl_dir argument is included for consistency with the other "Pod::Tree::Perl*" modules, but is currently unused.

       $perl_bin->"scan"(@path)
	   Scans all the directories in @path for program PODs.  Only text (-T) files are considered.  The search does not recurse through
	   subdirectories.

	   Each POD that is located is entered into $perl_map.

       $perl_bin->"index"
	   Generates a top-level index of all the program PODs, and writes it to HTML_dir"/bin.html".

       $perl_bin->"translate"
	   Translates each program POD found by "scan" to HTML.  The HTML pages are written to HTML_dir.

       $perl_bin->"get_top_entry"
	   Returns a hash reference of the form

	     { URL	   => $URL,
	       description => $description }

	   "Pod::Tree::PerlTop" uses this to build a top-level index of all the Perl PODs.

LINKING

       "Pod::Tree::PerlBin" expects the second paragraph of the POD to have the form

	   name - description

       and enters name into $perl_map.	To link to a program POD from another POD, write

	   L<name>

REQUIRES

	   5.005
	   File::Find
	   HTML::Stream
	   Pod::Tree
	   Pod::Tree::HTML
	   Pod::Tree::PerlUtil

EXPORTS

       Nothing.

SEE ALSO

       "Pod::Tree::HTML", "Pod::Tree::PerlMap",

AUTHOR

       Steven McDougall, swmcd@world.std.com

COPYRIGHT

       Copyright (c) 2000 by Steven McDougall.	This module is free software; you can redistribute it and/or modify it under the same terms as
       Perl.

perl v5.10.1							    2006-04-17						   Pod::Tree::PerlBin(3pm)

Linux and UNIX Man Pages

tk::pod::findpods(3pm) [debian man page]

Check Out this Related Man Page