Unix/Linux Go Back    

RedHat 9 (Linux i386) - man page for pdl::pod::select (redhat section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)

Select(3)		       User Contributed Perl Documentation			Select(3)

       podselect - function to extract selected sections of pod documentation

	   use PDL::Pod::Select;
	   podselect (@filelist);
	   podselect ({OUTPUT => "tmp.out"}, @filelist):
	   podselect ({SELECT => ["NAME|SYNOPSIS", "OPTIONS"]}, @filelist):
	   podselect ({OUTPUT => ">&STDERR", SELECT => ["DESCRIPTION"]}, "-");

       podselect() is a function which will extract specified sections of pod documentation from
       an input stream. This ability is already provided in the PDL::Pod::Parser module. Sub-
       classes of PDL::Pod::Parser that wish to take advantage of this feature do not need to
       derive from PDL::Pod::Select. PDL::Pod::Select merely provides a single function named
       podselect() which provides this capability in function form (as opposed to object form)
       for extracting the raw pod docs.

       podselect(\%options, @filelist)

       podselect will print the raw (untranslated) pod documentation of all pod sections in the
       given input files specified by @filelist according to the given options.

       If any argument to podselect is a reference to a hash (associative array) then the values
       with the following keys are processed as follows:

	   A string corresponding to the desired output file (or ">&STDOUT" or ">&STDERR"). The
	   default is to use standard output.

	   A reference to an array of sections specifications (as described in "SECTION SPECIFI-
	   CATIONS" in PDL::Pod::Parser) which indicate the desired set of pod sections and sub-
	   sections to be selected from input. If no section specifications are given, then all
	   sections of pod documentation are used.

       All other arguments should correspond to the names of input files containing pod documen-
       tation. A file name of "-" or "<&STDIN" will be interpeted to mean standard input (which
       is the default if no filenames are given).


       Brad Appleton <Brad_Appleton-GBDA001@email.mot.com>

       Based on code for pod2text written by Tom Christiansen <tchrist@mox.perl.com>

perl v5.8.0				    1999-12-09					Select(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums

All times are GMT -4. The time now is 03:50 PM.