.\" 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 "Regexp::Pattern::Example 3pm"
.TH Regexp::Pattern::Example 3pm "2018-11-04" "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"
Regexp::Pattern::Example \- An example Regexp::Pattern::* module
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.2.8 of Regexp::Pattern::Example (from Perl distribution Regexp-Pattern), released on 2018\-09\-12.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use Regexp::Pattern; # exports re()
\& my $re = re("Example::re1");
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Regexp::Pattern is a convention for organizing reusable regex patterns.
.SH "PATTERNS"
.IX Header "PATTERNS"
.IP "\(bu" 4
re1
.IP "\(bu" 4
re2
.Sp
This is regexp for blah.
.Sp
A longer description.
.Sp
Examples:
.Sp
.Vb 1
\& "123\-456" =~ re("Example::re2");  # matches
\&
\& # Another example that matches
\& "123\-456\-78901" =~ re("Example::re2");  # matches
\&
\& # An example that does not match
\& 123456 =~ re("Example::re2");  # doesn\*(Aqt match
\&
\& # An example that does not get tested
\& 123456 =~ re("Example::re2");  # doesn\*(Aqt match
.Ve
.IP "\(bu" 4
re3
.Sp
This is a regexp for blah blah.
.Sp
\&...
.Sp
This is a dynamic pattern which will be generated on-demand.
.Sp
The following arguments are available to customize the generated pattern:
.RS 4
.IP "\(bu" 4
variant
.Sp
Choose variant.
.RE
.RS 4
.Sp
Examples:
.Sp
.Vb 2
\& # An example that matches
\& "123\-456" =~ re("Example::re3", {variant=>"A"});  # matches
\&
\& # An example that doesn\*(Aqt match
\& "123\-456" =~ re("Example::re3", {variant=>"B"});  # doesn\*(Aqt match
.Ve
.RE
.IP "\(bu" 4
re4
.Sp
This is a regexp that does capturing.
.Sp
Examples:
.Sp
.Vb 1
\& "123\-456" =~ re("Example::re4"); # matches, $1=123, $2=456
\&
\& "foo\-bar" =~ re("Example::re4");  # doesn\*(Aqt match
.Ve
.IP "\(bu" 4
re5
.Sp
This is another regexp that does (named) capturing and anchoring.
.Sp
Examples:
.Sp
.Vb 1
\& "123\-456" =~ re("Example::re5"); # matches, $+{"cap1"}=123, $+{"cap2"}=456
\&
\& "something 123\-456" =~ re("Example::re5");  # doesn\*(Aqt match
.Ve
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Regexp\-Pattern>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Regexp\-Pattern>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Regexp\-Pattern>
.PP
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018, 2016 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.