FM / pod

/usr/share/perl5/pod

Name	Size	Mode	Actions
a2p.pod	6107	0644	edit dl rm
perl.pod	15748	0644	edit dl rm
perl56delta.pod	107184	0644	edit dl rm
perl58delta.pod	114908	0644	edit dl rm
perl561delta.pod	124697	0644	edit dl rm
perl570delta.pod	21655	0644	edit dl rm
perl571delta.pod	30382	0644	edit dl rm
perl572delta.pod	25551	0644	edit dl rm
perl573delta.pod	4644	0644	edit dl rm
perl581delta.pod	38060	0644	edit dl rm
perl582delta.pod	4470	0644	edit dl rm
perl583delta.pod	6335	0644	edit dl rm
perl584delta.pod	7363	0644	edit dl rm
perl585delta.pod	5889	0644	edit dl rm
perl586delta.pod	4651	0644	edit dl rm
perl587delta.pod	8357	0644	edit dl rm
perl588delta.pod	25267	0644	edit dl rm
perl589delta.pod	53905	0644	edit dl rm
perl590delta.pod	34951	0644	edit dl rm
perl591delta.pod	11173	0644	edit dl rm
perl592delta.pod	10954	0644	edit dl rm
perl593delta.pod	17034	0644	edit dl rm
perl594delta.pod	12661	0644	edit dl rm
perl595delta.pod	18934	0644	edit dl rm
perl5004delta.pod	56240	0644	edit dl rm
perl5005delta.pod	34285	0644	edit dl rm
perl5100delta.pod	53922	0644	edit dl rm
perl5101delta.pod	43877	0644	edit dl rm
perlaix.pod	18128	0644	edit dl rm
perlamiga.pod	7031	0644	edit dl rm
perlapi.pod	169428	0644	edit dl rm
perlapio.pod	19332	0644	edit dl rm
perlapollo.pod	829	0644	edit dl rm
perlartistic.pod	6802	0644	edit dl rm
perlbeos.pod	2939	0644	edit dl rm
perlbook.pod	663	0644	edit dl rm
perlboot.pod	28355	0644	edit dl rm
perlbot.pod	11675	0644	edit dl rm
perlbs2000.pod	7929	0644	edit dl rm
perlcall.pod	55173	0644	edit dl rm
perlce.pod	9257	0644	edit dl rm
perlcheat.pod	4153	0644	edit dl rm
perlclib.pod	7684	0644	edit dl rm
perlcn.pod	4915	0644	edit dl rm
perlcommunity.pod	6398	0644	edit dl rm
perlcompile.pod	9516	0644	edit dl rm
perlcygwin.pod	28183	0644	edit dl rm
perldata.pod	36879	0644	edit dl rm
perldbmfilter.pod	4987	0644	edit dl rm
perldebguts.pod	31887	0644	edit dl rm
perldebtut.pod	21304	0644	edit dl rm
perldebug.pod	37535	0644	edit dl rm
perldelta.pod	43877	0644	edit dl rm
perldgux.pod	2821	0644	edit dl rm
perldiag.pod	183151	0644	edit dl rm
perldoc.pod	7310	0644	edit dl rm
perldos.pod	10853	0644	edit dl rm
perldsc.pod	25447	0644	edit dl rm
perlebcdic.pod	66607	0644	edit dl rm
perlembed.pod	38033	0644	edit dl rm
perlepoc.pod	3779	0644	edit dl rm
perlfaq.pod	24841	0644	edit dl rm
perlfaq1.pod	17762	0644	edit dl rm
perlfaq2.pod	21614	0644	edit dl rm
perlfaq3.pod	38534	0644	edit dl rm
perlfaq4.pod	81412	0644	edit dl rm
perlfaq5.pod	49201	0644	edit dl rm
perlfaq6.pod	38538	0644	edit dl rm
perlfaq7.pod	37588	0644	edit dl rm
perlfaq8.pod	46128	0644	edit dl rm
perlfaq9.pod	24191	0644	edit dl rm
perlfilter.pod	21140	0644	edit dl rm
perlfork.pod	11440	0644	edit dl rm
perlform.pod	16894	0644	edit dl rm
perlfreebsd.pod	1950	0644	edit dl rm
perlfunc.pod	291909	0644	edit dl rm
perlglossary.pod	112139	0644	edit dl rm
perlgpl.pod	18806	0644	edit dl rm
perlguts.pod	105182	0644	edit dl rm
perlhack.pod	121512	0644	edit dl rm
perlhaiku.pod	1504	0644	edit dl rm
perlhist.pod	38766	0644	edit dl rm
perlhpux.pod	28650	0644	edit dl rm
perlhurd.pod	1990	0644	edit dl rm
perlintern.pod	26408	0644	edit dl rm
perlintro.pod	21491	0644	edit dl rm
perliol.pod	33755	0644	edit dl rm
perlipc.pod	67761	0644	edit dl rm
perlirix.pod	4397	0644	edit dl rm
perljp.pod	8070	0644	edit dl rm
perlko.pod	7892	0644	edit dl rm
perllexwarn.pod	14435	0644	edit dl rm
perllinux.pod	1492	0644	edit dl rm
perllocale.pod	41616	0644	edit dl rm
perllol.pod	8252	0644	edit dl rm
perlmachten.pod	4500	0644	edit dl rm
perlmacos.pod	2111	0644	edit dl rm
perlmacosx.pod	11322	0644	edit dl rm
perlmint.pod	9539	0644	edit dl rm
perlmod.pod	24494	0644	edit dl rm
perlmodinstall.pod	13929	0644	edit dl rm
perlmodlib.pod	77333	0644	edit dl rm
perlmodstyle.pod	21114	0644	edit dl rm
perlmpeix.pod	15087	0644	edit dl rm
perlmroapi.pod	2959	0644	edit dl rm
perlnetware.pod	6488	0644	edit dl rm
perlnewmod.pod	11214	0644	edit dl rm
perlnumber.pod	8352	0644	edit dl rm
perlobj.pod	21813	0644	edit dl rm
perlop.pod	96225	0644	edit dl rm
perlopenbsd.pod	1207	0644	edit dl rm
perlopentut.pod	37997	0644	edit dl rm
perlos2.pod	92783	0644	edit dl rm
perlos390.pod	16074	0644	edit dl rm
perlos400.pod	4618	0644	edit dl rm
perlothrtut.pod	40657	0644	edit dl rm
perlpacktut.pod	51047	0644	edit dl rm
perlperf.pod	51328	0644	edit dl rm
perlplan9.pod	5125	0644	edit dl rm
perlpod.pod	21626	0644	edit dl rm
perlpodspec.pod	67792	0644	edit dl rm
perlport.pod	86302	0644	edit dl rm
perlpragma.pod	4320	0644	edit dl rm
perlqnx.pod	4246	0644	edit dl rm
perlre.pod	82798	0644	edit dl rm
perlreapi.pod	25427	0644	edit dl rm
perlrebackslash.pod	20109	0644	edit dl rm
perlrecharclass.pod	21909	0644	edit dl rm
perlref.pod	26465	0644	edit dl rm
perlreftut.pod	18670	0644	edit dl rm
perlreguts.pod	36877	0644	edit dl rm
perlrepository.pod	23453	0644	edit dl rm
perlrequick.pod	17617	0644	edit dl rm
perlreref.pod	11996	0644	edit dl rm
perlretut.pod	115005	0644	edit dl rm
perlriscos.pod	1511	0644	edit dl rm
perlrun.pod	49928	0644	edit dl rm
perlsec.pod	23542	0644	edit dl rm
perlsolaris.pod	29131	0644	edit dl rm
perlstyle.pod	8618	0644	edit dl rm
perlsub.pod	54222	0644	edit dl rm
perlsymbian.pod	16222	0644	edit dl rm
perlsyn.pod	31090	0644	edit dl rm
perlthrtut.pod	46510	0644	edit dl rm
perltie.pod	36665	0644	edit dl rm
perltoc.pod	642987	0644	edit dl rm
perltodo.pod	48360	0644	edit dl rm
perltooc.pod	51425	0644	edit dl rm
perltoot.pod	68625	0644	edit dl rm
perltrap.pod	41151	0644	edit dl rm
perltru64.pod	7736	0644	edit dl rm
perltw.pod	5384	0644	edit dl rm
perlunicode.pod	56169	0644	edit dl rm
perlunifaq.pod	12878	0644	edit dl rm
perluniintro.pod	32973	0644	edit dl rm
perlunitut.pod	7907	0644	edit dl rm
perlutil.pod	9881	0644	edit dl rm
perluts.pod	3180	0644	edit dl rm
perlvar.pod	59133	0644	edit dl rm
perlvmesa.pod	3952	0644	edit dl rm
perlvms.pod	52545	0644	edit dl rm
perlvos.pod	5567	0644	edit dl rm
perlwin32.pod	40809	0644	edit dl rm
perlxs.pod	74194	0644	edit dl rm
perlxstut.pod	49670	0644	edit dl rm

Edit: /usr/share/perl5/pod/perlreref.pod (11996B)

=head1 NAME

perlreref - Perl Regular Expressions Reference

=head1 DESCRIPTION

This is a quick reference to Perl's regular expressions.
For full information see L<perlre> and L<perlop>, as well
as the L</"SEE ALSO"> section in this document.

=head2 OPERATORS

C<=~> determines to which variable the regex is applied.
In its absence, $_ is used.

$var =~ /foo/;

C<!~> determines to which variable the regex is applied,
and negates the result of the match; it returns
false if the match succeeds, and true if it fails.

$var !~ /foo/;

C<m/pattern/msixpogc> searches a string for a pattern match,
applying the given options.

m  Multiline mode - ^ and $ match internal lines
    s  match as a Single line - . matches \n
    i  case-Insensitive
    x  eXtended legibility - free whitespace and comments
    p  Preserve a copy of the matched string -
       ${^PREMATCH}, ${^MATCH}, ${^POSTMATCH} will be defined.
    o  compile pattern Once
    g  Global - all occurrences
    c  don't reset pos on failed matches when using /g

If 'pattern' is an empty string, the last I<successfully> matched
regex is used. Delimiters other than '/' may be used for both this
operator and the following ones. The leading C<m> can be omitted
if the delimiter is '/'.

C<qr/pattern/msixpo> lets you store a regex in a variable,
or pass one around. Modifiers as for C<m//>, and are stored
within the regex.

C<s/pattern/replacement/msixpogce> substitutes matches of
'pattern' with 'replacement'. Modifiers as for C<m//>,
with one addition:

e  Evaluate 'replacement' as an expression

'e' may be specified multiple times. 'replacement' is interpreted
as a double quoted string unless a single-quote (C<'>) is the delimiter.

C<?pattern?> is like C<m/pattern/> but matches only once. No alternate
delimiters can be used.  Must be reset with reset().

=head2 SYNTAX

\       Escapes the character immediately following it
   .       Matches any single character except a newline (unless /s is used)
   ^       Matches at the beginning of the string (or line, if /m is used)
   $       Matches at the end of the string (or line, if /m is used)
   *       Matches the preceding element 0 or more times
   +       Matches the preceding element 1 or more times
   ?       Matches the preceding element 0 or 1 times
   {...}   Specifies a range of occurrences for the element preceding it
   [...]   Matches any one of the characters contained within the brackets
   (...)   Groups subexpressions for capturing to $1, $2...
   (?:...) Groups subexpressions without capturing (cluster)
   |       Matches either the subexpression preceding or following it
   \1, \2, \3 ...           Matches the text from the Nth group
   \g1 or \g{1}, \g2 ...    Matches the text from the Nth group
   \g-1 or \g{-1}, \g-2 ... Matches the text from the Nth previous group
   \g{name}     Named backreference
   \k<name>     Named backreference
   \k'name'     Named backreference
   (?P=name)    Named backreference (python syntax)

=head2 ESCAPE SEQUENCES

These work as in normal strings.

\a       Alarm (beep)
   \e       Escape
   \f       Formfeed
   \n       Newline
   \r       Carriage return
   \t       Tab
   \037     Any octal ASCII value
   \x7f     Any hexadecimal ASCII value
   \x{263a} A wide hexadecimal value
   \cx      Control-x
   \N{name} A named character

\l  Lowercase next character
   \u  Titlecase next character
   \L  Lowercase until \E
   \U  Uppercase until \E
   \Q  Disable pattern metacharacters until \E
   \E  End modification

For Titlecase, see L</Titlecase>.

This one works differently from normal strings:

\b  An assertion, not backspace, except in a character class

=head2 CHARACTER CLASSES

[amy]    Match 'a', 'm' or 'y'
   [f-j]    Dash specifies "range"
   [f-j-]   Dash escaped or at start or end means 'dash'
   [^f-j]   Caret indicates "match any character _except_ these"

The following sequences work within or without a character class.
The first six are locale aware, all are Unicode aware. See L<perllocale>
and L<perlunicode> for details.

\d      A digit
   \D      A nondigit
   \w      A word character
   \W      A non-word character
   \s      A whitespace character
   \S      A non-whitespace character
   \h      An horizontal white space
   \H      A non horizontal white space
   \v      A vertical white space
   \V      A non vertical white space
   \R      A generic newline           (?>\v|\x0D\x0A)

\C      Match a byte (with Unicode, '.' matches a character)
   \pP     Match P-named (Unicode) property
   \p{...} Match Unicode property with long name
   \PP     Match non-P
   \P{...} Match lack of Unicode property with long name
   \X      Match extended Unicode combining character sequence

POSIX character classes and their Unicode and Perl equivalents:

alnum   IsAlnum              Alphanumeric
   alpha   IsAlpha              Alphabetic
   ascii   IsASCII              Any ASCII char
   blank   IsSpace  [ \t]       Horizontal whitespace (GNU extension)
   cntrl   IsCntrl              Control characters
   digit   IsDigit  \d          Digits
   graph   IsGraph              Alphanumeric and punctuation
   lower   IsLower              Lowercase chars (locale and Unicode aware)
   print   IsPrint              Alphanumeric, punct, and space
   punct   IsPunct              Punctuation
   space   IsSpace  [\s\ck]     Whitespace
           IsSpacePerl   \s     Perl's whitespace definition
   upper   IsUpper              Uppercase chars (locale and Unicode aware)
   word    IsWord   \w          Alphanumeric plus _ (Perl extension)
   xdigit  IsXDigit [0-9A-Fa-f] Hexadecimal digit

Within a character class:

POSIX       traditional   Unicode
    [:digit:]       \d        \p{IsDigit}
    [:^digit:]      \D        \P{IsDigit}

=head2 ANCHORS

All are zero-width assertions.

^  Match string start (or line, if /m is used)
   $  Match string end (or line, if /m is used) or before newline
   \b Match word boundary (between \w and \W)
   \B Match except at word boundary (between \w and \w or \W and \W)
   \A Match string start (regardless of /m)
   \Z Match string end (before optional newline)
   \z Match absolute string end
   \G Match where previous m//g left off

\K Keep the stuff left of the \K, don't include it in $&

=head2 QUANTIFIERS

Quantifiers are greedy by default -- match the B<longest> leftmost.

Maximal Minimal Possessive Allowed range
   ------- ------- ---------- -------------
   {n,m}   {n,m}?  {n,m}+     Must occur at least n times
                              but no more than m times
   {n,}    {n,}?   {n,}+      Must occur at least n times
   {n}     {n}?    {n}+       Must occur exactly n times
   *       *?      *+         0 or more times (same as {0,})
   +       +?      ++         1 or more times (same as {1,})
   ?       ??      ?+         0 or 1 time (same as {0,1})

The possessive forms (new in Perl 5.10) prevent backtracking: what gets
matched by a pattern with a possessive quantifier will not be backtracked
into, even if that causes the whole match to fail.

There is no quantifier {,n} -- that gets understood as a literal string.

=head2 EXTENDED CONSTRUCTS

(?#text)          A comment
   (?:...)           Groups subexpressions without capturing (cluster)
   (?pimsx-imsx:...) Enable/disable option (as per m// modifiers)
   (?=...)           Zero-width positive lookahead assertion
   (?!...)           Zero-width negative lookahead assertion
   (?<=...)          Zero-width positive lookbehind assertion
   (?<!...)          Zero-width negative lookbehind assertion
   (?>...)           Grab what we can, prohibit backtracking
   (?|...)           Branch reset
   (?<name>...)      Named capture
   (?'name'...)      Named capture
   (?P<name>...)     Named capture (python syntax)
   (?{ code })       Embedded code, return value becomes $^R
   (??{ code })      Dynamic regex, return value used as regex
   (?N)              Recurse into subpattern number N
   (?-N), (?+N)      Recurse into Nth previous/next subpattern
   (?R), (?0)        Recurse at the beginning of the whole pattern
   (?&name)          Recurse into a named subpattern
   (?P>name)         Recurse into a named subpattern (python syntax)
   (?(cond)yes|no)
   (?(cond)yes)      Conditional expression, where "cond" can be:
                     (N)       subpattern N has matched something
                     (<name>)  named subpattern has matched something
                     ('name')  named subpattern has matched something
                     (?{code}) code condition
                     (R)       true if recursing
                     (RN)      true if recursing into Nth subpattern
                     (R&name)  true if recursing into named subpattern
                     (DEFINE)  always false, no no-pattern allowed

=head2 VARIABLES

$_    Default variable for operators to use

$`    Everything prior to matched string
   $&    Entire matched string
   $'    Everything after to matched string

${^PREMATCH}   Everything prior to matched string
   ${^MATCH}      Entire matched string
   ${^POSTMATCH}  Everything after to matched string

The use of C<$`>, C<$&> or C<$'> will slow down B<all> regex use
within your program. Consult L<perlvar> for C<@->
to see equivalent expressions that won't cause slow down.
See also L<Devel::SawAmpersand>. Starting with Perl 5.10, you
can also use the equivalent variables C<${^PREMATCH}>, C<${^MATCH}>
and C<${^POSTMATCH}>, but for them to be defined, you have to
specify the C</p> (preserve) modifier on your regular expression.

$1, $2 ...  hold the Xth captured expr
   $+    Last parenthesized pattern match
   $^N   Holds the most recently closed capture
   $^R   Holds the result of the last (?{...}) expr
   @-    Offsets of starts of groups. $-[0] holds start of whole match
   @+    Offsets of ends of groups. $+[0] holds end of whole match
   %+    Named capture buffers
   %-    Named capture buffers, as array refs

Captured groups are numbered according to their I<opening> paren.

=head2 FUNCTIONS

lc          Lowercase a string
   lcfirst     Lowercase first char of a string
   uc          Uppercase a string
   ucfirst     Titlecase first char of a string

pos         Return or set current match position
   quotemeta   Quote metacharacters
   reset       Reset ?pattern? status
   study       Analyze string for optimizing matching

split       Use a regex to split a string into parts

The first four of these are like the escape sequences C<\L>, C<\l>,
C<\U>, and C<\u>.  For Titlecase, see L</Titlecase>.

=head2 TERMINOLOGY

=head3 Titlecase

Unicode concept which most often is equal to uppercase, but for
certain characters like the German "sharp s" there is a difference.

=head1 AUTHOR

Iain Truskett. Updated by the Perl 5 Porters.

This document may be distributed under the same terms as Perl itself.

=head1 SEE ALSO

=over 4

=item *

L<perlretut> for a tutorial on regular expressions.

=item *

L<perlrequick> for a rapid tutorial.

=item *

L<perlre> for more details.

=item *

L<perlvar> for details on the variables.

=item *

L<perlop> for details on the operators.

=item *

L<perlfunc> for details on the functions.

=item *

L<perlfaq6> for FAQs on regular expressions.

=item *

L<perlrebackslash> for a reference on backslash sequences.

=item *

L<perlrecharclass> for a reference on character classes.

=item *

The L<re> module to alter behaviour and aid
debugging.

=item *

L<perldebug/"Debugging regular expressions">

=item *

L<perluniintro>, L<perlunicode>, L<charnames> and L<perllocale>
for details on regexes and internationalisation.

=item *

I<Mastering Regular Expressions> by Jeffrey Friedl
(F<http://regex.info/>) for a thorough grounding and
reference on the topic.

=back

=head1 THANKS

David P.C. Wollmann,
Richard Soderberg,
Sean M. Burke,
Tom Christiansen,
Jim Cromie,
and
Jeffrey Goff
for useful advice.

=cut

cmd: