.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Select 3pm" .TH Select 3pm "2011-05-28" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" podselect \- function to extract selected sections of pod documentation .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 5 \& use PDL::Pod::Select; \& podselect (@filelist); \& podselect ({OUTPUT => "tmp.out"}, @filelist): \& podselect ({SELECT => ["NAME|SYNOPSIS", "OPTIONS"]}, @filelist): \& podselect ({OUTPUT => ">&STDERR", SELECT => ["DESCRIPTION"]}, "\-"); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fB\f(BIpodselect()\fB\fR is a function which will extract specified sections of pod documentation from an input stream. This ability is already provided in the \fBPDL::Pod::Parser\fR module. Subclasses of \fBPDL::Pod::Parser\fR that wish to take advantage of this feature do \fInot\fR need to derive from \&\fBPDL::Pod::Select\fR. \fBPDL::Pod::Select\fR merely provides a single function named \&\fB\f(BIpodselect()\fB\fR which provides this capability in function form (as opposed to object form) for extracting the raw pod docs. .ie n .SS "podselect(\e%options, @filelist)" .el .SS "podselect(\e%options, \f(CW@filelist\fP)" .IX Subsection "podselect(%options, @filelist)" \&\fBpodselect\fR will print the raw (untranslated) pod documentation of all pod sections in the given input files specified by \f(CW@filelist\fR according to the given options. .PP If any argument to \fBpodselect\fR is a reference to a hash (associative array) then the values with the following keys are processed as follows: .ie n .IP """OUTPUT""" 4 .el .IP "\f(CWOUTPUT\fR" 4 .IX Item "OUTPUT" A string corresponding to the desired output file (or \*(L">&STDOUT\*(R" or \*(L">&STDERR\*(R"). The default is to use standard output. .ie n .IP """SELECT""" 4 .el .IP "\f(CWSELECT\fR" 4 .IX Item "SELECT" A reference to an array of sections specifications (as described in \&\*(L"\s-1SECTION\s0 \s-1SPECIFICATIONS\s0\*(R" in PDL::Pod::Parser) which indicate the desired set of pod sections and subsections to be selected from input. If no section specifications are given, then all sections of pod documentation are used. .PP All other arguments should correspond to the names of input files containing pod documentation. A file name of \*(L"\-\*(R" or \*(L"<&STDIN\*(R" will be interpeted to mean standard input (which is the default if no filenames are given). .SH "SEE ALSO" .IX Header "SEE ALSO" PDL::Pod::Parser .SH "AUTHOR" .IX Header "AUTHOR" Brad Appleton .PP Based on code for \fBpod2text\fR written by Tom Christiansen