.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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" '' . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Pod::MinimumVersion 3pm" .TH Pod::MinimumVersion 3pm "2018-05-30" "perl v5.26.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" Pod::MinimumVersion \- Perl version for POD directives used .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 4 \& use Pod::MinimumVersion; \& my $pmv = Pod::MinimumVersion\->new (filename => \*(Aq/some/foo.pl\*(Aq); \& print $pmv\->minimum_version,"\en"; \& print $pmv\->reports; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Pod::MinimumVersion\*(C'\fR parses the \s-1POD\s0 in a Perl script, module, or document, and reports what version of Perl is required to process the directives in it with \f(CW\*(C`pod2man\*(C'\fR etc. .SH "CHECKS" .IX Header "CHECKS" The following \s-1POD\s0 features are identified. .IP "\(bu" 4 5.004: new \f(CW\*(C`=for\*(C'\fR, \f(CW\*(C`=begin\*(C'\fR and \f(CW\*(C`=end\*(C'\fR .IP "\(bu" 4 5.005: new L style display part .IP "\(bu" 4 5.6.0: new C<< foo >> etc double-angles .IP "\(bu" 4 5.8.0: new \f(CW\*(C`=head3\*(C'\fR and \f(CW\*(C`=head4\*(C'\fR .IP "\(bu" 4 5.8.0: new L URLs. (Before 5.8 the \*(L"/\*(R" is a \&\*(L"section\*(R" separator, giving very poor output.) .IP "\(bu" 4 5.8.0: new E, E, E chars. (Documented in 5.6.0, but pod2man doesn't recognise them until 5.8.) .IP "\(bu" 4 5.10.0: new \f(CW\*(C`=encoding\*(C'\fR command. (Documented in 5.8.0, but \f(CW\*(C`pod2man\*(C'\fR doesn't recognise it until 5.10.) .IP "\(bu" 4 5.12.0: new L \s-1URL\s0 with text. (Before 5.12 the combination of display part and \s-1URL\s0 was explicitly disallowed by perlpodspec.) .PP \&\s-1POD\s0 syntax errors are quietly ignored currently. The intention is only to check what \f(CW\*(C`pod2man\*(C'\fR would act on but it's probably a good idea to use \&\f(CW\*(C`Pod::Checker\*(C'\fR first. .PP \&\f(CW\*(C`J<< >>\*(C'\fR for \f(CW\*(C`Pod::MultiLang\*(C'\fR is recognised and is allowed for any Perl, including with double-angles. The assumption is that if you're writing that then you'll first crunch with the \f(CW\*(C`Pod::MultiLang\*(C'\fR tools, so it's not important what \f(CW\*(C`pod2man\*(C'\fR thinks of it. .SH "FUNCTIONS" .IX Header "FUNCTIONS" .ie n .IP """$pmv = Pod::MinimumVersion\->new (key => value, ...)""" 4 .el .IP "\f(CW$pmv = Pod::MinimumVersion\->new (key => value, ...)\fR" 4 .IX Item "$pmv = Pod::MinimumVersion->new (key => value, ...)" Create and return a new \f(CW\*(C`Pod::MinimumVersion\*(C'\fR object which will analyze a document. The document is supplied as one of .Sp .Vb 3 \& filehandle => $fh, \& string => \*(Aqsomething\*(Aq, \& filename => \*(Aq/my/dir/foo.pod\*(Aq, .Ve .Sp For \f(CW\*(C`filehandle\*(C'\fR and \f(CW\*(C`string\*(C'\fR, a \f(CW\*(C`filename\*(C'\fR can be supplied too to give a name in the reports. The handle or string is what's actually read. .Sp The \f(CW\*(C`above_version\*(C'\fR option lets you set a Perl version of you have or are targeting, so reports are only about features above that level. .Sp .Vb 1 \& above_version => \*(Aq5.006\*(Aq, .Ve .ie n .IP """$version = $pmv\->minimum_version ()""" 4 .el .IP "\f(CW$version = $pmv\->minimum_version ()\fR" 4 .IX Item "$version = $pmv->minimum_version ()" .PD 0 .ie n .IP """$report = $pmv\->minimum_report ()""" 4 .el .IP "\f(CW$report = $pmv\->minimum_report ()\fR" 4 .IX Item "$report = $pmv->minimum_report ()" .PD Return the minimum Perl required for the document in \f(CW$pmv\fR. .Sp \&\f(CW\*(C`minimum_version\*(C'\fR returns a \f(CW\*(C`version\*(C'\fR number object (see version). \&\f(CW\*(C`minimum_report\*(C'\fR returns a \f(CW\*(C`Pod::MinimumVersion::Report\*(C'\fR object (see \&\*(L"\s-1REPORT OBJECTS\*(R"\s0 below). .ie n .IP """@reports = $pmv\->reports ()""" 4 .el .IP "\f(CW@reports = $pmv\->reports ()\fR" 4 .IX Item "@reports = $pmv->reports ()" Return a list of \f(CW\*(C`Pod::MinimumVersion::Report\*(C'\fR objects concerning the document in \f(CW$pmv\fR. .Sp These multiple reports let you identify multiple places that a particular Perl is required. With the \f(CW\*(C`above_version\*(C'\fR option the reports are only about things higher than that. .Sp \&\f(CW\*(C`minimum_version\*(C'\fR and \f(CW\*(C`minimum_report\*(C'\fR are simply the highest Perl among these multiple reports. .SH "REPORT OBJECTS" .IX Header "REPORT OBJECTS" A \f(CW\*(C`Pod::MinimumVersion::Report\*(C'\fR object holds a location within a document and a reason that a particular Perl is needed at that point. The hash fields are .PP .Vb 4 \& filename string \& linenum integer, with 1 for the first line \& version version.pm object \& why string .Ve .ie n .IP """$str = $report\->as_string""" 4 .el .IP "\f(CW$str = $report\->as_string\fR" 4 .IX Item "$str = $report->as_string" Return a formatted string for the report. Currently this is in \s-1GNU\s0 file:line style, simply .Sp .Vb 1 \& :: due to .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" version, Pod::MultiLang, Perl::Critic::Policy::Compatibility::PodMinimumVersion .PP Perl::MinimumVersion, Perl::Critic::Policy::Modules::PerlMinimumVersion, Perl::Critic::Policy::Compatibility::PerlMinimumVersionAndWhy .SH "HOME PAGE" .IX Header "HOME PAGE" http://user42.tuxfamily.org/pod\-minimumversion/index.html .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2009, 2010, 2011 Kevin Ryde .PP Pod-MinimumVersion is free software; you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation; either version 3, or (at your option) any later version. .PP Pod-MinimumVersion is distributed in the hope that it will be useful, but \&\s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of \s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0 See the \s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with Pod-MinimumVersion. If not, see .