.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Module::Extract::VERSION 3pm"
.TH Module::Extract::VERSION 3pm "2022-10-30" "perl v5.36.0" "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"
Module::Extract::VERSION \- Extract a module version safely
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use Module::Extract::VERSION;
\&
\&        my $version   # just the version
\&                = Module::Extract::VERSION\->parse_version_safely( $file );
\&
\&        my @version_info # extra info
\&                = Module::Extract::VERSION\->parse_version_safely( $file );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module lets you pull out of module source code the version number
for the module. It assumes that there is only one \f(CW$VERSION\fR
in the file and the entire \f(CW$VERSION\fR statement is on the same line.
.SS "Class methods"
.IX Subsection "Class methods"
.ie n .IP "$class\->parse_version_safely( \s-1FILE\s0 );" 4
.el .IP "\f(CW$class\fR\->parse_version_safely( \s-1FILE\s0 );" 4
.IX Item "$class->parse_version_safely( FILE );"
Given a module file, return the module version. This works just like
\&\f(CW\*(C`mldistwatch\*(C'\fR in \s-1PAUSE.\s0 It looks for the single line that has the
\&\f(CW$VERSION\fR statement, extracts it, evals it in a Safe compartment,
and returns the result.
.Sp
In scalar context, it returns just the version as a string. In list
context, it returns the list of:
.Sp
.Vb 5
\&        sigil
\&        fully\-qualified variable name
\&        version value
\&        file name
\&        line number of $VERSION
.Ve
.SH "SOURCE AVAILABILITY"
.IX Header "SOURCE AVAILABILITY"
This code is in Github:
.PP
.Vb 1
\&        https://github.com/briandfoy/module\-extract\-version.git
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
brian d foy, \f(CW\*(C`<bdfoy@cpan.org>\*(C'\fR
.PP
I stole the some of this code from \f(CW\*(C`mldistwatch\*(C'\fR in the \s-1PAUSE\s0
code by Andreas König, but I've moved most of it around.
.PP
Andrey Starodubtsev added code to handle the v5.12 and v5.14
\&\f(CW\*(C`package\*(C'\fR syntax.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright © 2008\-2022, brian d foy \f(CW\*(C`<bdfoy@cpan.org>\*(C'\fR. All rights reserved.
.PP
You may redistribute this under the Artistic License 2.0.