This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
move version details to version::Internals and other clean up
[perl5.git] / lib / version / Internals.pod
1 =head1 NAME
2
3 version::Internals - Perl extension for Version Objects
4
5 =head1 DESCRIPTION
6
7 Overloaded version objects for all modern versions of Perl.  This documents
8 the internal data representation and underlying code for version.pm.  See
9 L<version.pod> for daily usage.  This document is only useful for users
10 interested in the gory details.
11
12 =head1 WHAT IS A VERSION?
13
14 For the purposes of this module, a version "number" is a sequence of
15 positive integer values separated by one or more decimal points and
16 optionally a single underscore.  This corresponds to what Perl itself
17 uses for a version, as well as extending the "version as number" that
18 is discussed in the various editions of the Camel book.
19
20 There are actually two distinct kinds of version objects:
21
22 =over 4
23
24 =item Decimal Versions
25
26 Any version which "looks like a number", see L<Decimal Versions>.  This
27 also includes versions with a single decimal point and a single embedded
28 underscore, see L<Alpha Versions>, even though these must be quoted
29 to preserve the underscore formatting.
30
31 =item Dotted-Decimal Versions
32
33 Also referred to as "Dotted-Integer", these contains more than one decimal
34 point and may have an optional embedded underscore, see L<Dotted-Decimal
35 Versions>.  This is what is commonly used in most open source software as
36 the "external" version (the one used as part of the tag or tarfile name).
37 A leading 'v' character is now required and will warn if it missing.
38
39 =back
40
41 Both of these methods will produce similar version objects, in that
42 the default stringification will yield the version L<Normal Form> only
43 if required:
44
45   $v  = version->new(1.002);     # 1.002, but compares like 1.2.0
46   $v  = version->new(1.002003);  # 1.002003
47   $v2 = version->new("v1.2.3");  # v1.2.3
48
49 In specific, version numbers initialized as L<Decimal Versions> will
50 stringify as they were originally created (i.e. the same string that was
51 passed to C<new()>.  Version numbers initialized as L<Dotted-Decimal Versions>
52 will be stringified as L<Normal Form>.
53
54 =head2 Decimal Versions
55
56 These correspond to historical versions of Perl itself prior to 5.6.0,
57 as well as all other modules which follow the Camel rules for the
58 $VERSION scalar.  A Decimal version is initialized with what looks like
59 a floating point number.  Leading zeros B<are> significant and trailing
60 zeros are implied so that a minimum of three places is maintained
61 between subversions.  What this means is that any subversion (digits
62 to the right of the decimal place) that contains less than three digits
63 will have trailing zeros added to make up the difference, but only for
64 purposes of comparison with other version objects.  For example:
65
66                                    # Prints     Equivalent to
67   $v = version->new(      1.2);    # 1.2        v1.200.0
68   $v = version->new(     1.02);    # 1.02       v1.20.0
69   $v = version->new(    1.002);    # 1.002      v1.2.0
70   $v = version->new(   1.0023);    # 1.0023     v1.2.300
71   $v = version->new(  1.00203);    # 1.00203    v1.2.30
72   $v = version->new( 1.002003);    # 1.002003   v1.2.3
73
74 All of the preceding examples are true whether or not the input value is
75 quoted.  The important feature is that the input value contains only a
76 single decimal.  See also L<Alpha Versions>.
77
78 IMPORTANT NOTE: As shown above, if your Decimal version contains more
79 than 3 significant digits after the decimal place, it will be split on
80 each multiple of 3, so 1.0003 is equivalent to v1.0.300, due to the need
81 to remain compatible with Perl's own 5.005_03 == 5.5.30 interpretation.
82 Any trailing zeros are ignored for mathematical comparison purposes.
83
84 =head2 Dotted-Decimal Versions
85
86 These are the newest form of versions, and correspond to Perl's own
87 version style beginning with 5.6.0.  Starting with Perl 5.10.0,
88 and most likely Perl 6, this is likely to be the preferred form.  This
89 method normally requires that the input parameter be quoted, although
90 Perl's after 5.8.1 can use v-strings as a special form of quoting, but
91 this is highly discouraged.
92
93 Unlike L<Decimal Versions>, Dotted-Decimal Versions have more than
94 a single decimal point, e.g.:
95
96                                    # Prints
97   $v = version->new( "v1.200");    # v1.200.0
98   $v = version->new("v1.20.0");    # v1.20.0
99   $v = qv("v1.2.3");               # v1.2.3
100   $v = qv("1.2.3");                # v1.2.3
101   $v = qv("1.20");                 # v1.20.0
102
103 In general, Dotted-Decimal Versions permit the greatest amount of freedom
104 to specify a version, whereas Decimal Versions enforce a certain
105 uniformity.  See also L<New Operator> for an additional method of
106 initializing version objects.
107
108 Just like L<Decimal Versions>, Dotted-Decimal Versions can be used as
109 L<Alpha Versions>.
110
111 =head2 Alpha Versions
112
113 For module authors using CPAN, the convention has been to note unstable
114 releases with an underscore in the version string. (See L<CPAN>.)  version.pm
115 follows this convention and alpha releases will test as being newer than the
116 more recent stable release, and less than the next stable release.  Only the
117 last element may be separated by an underscore:
118
119   # Declaring
120   use version 0.77; our $VERSION = version->declare("v1.2_3");
121
122   # Parsing
123   $v1 = version->parse("v1.2_3");
124   $v1 = version->parse("1.002_003");
125
126 Note that you B<must> quote the version when writing an alpha Decimal version.
127 The stringified form of Decimal versions will always be the same string that
128 was used to initialize the version object.
129
130 =head2 Regular Expressions for Version Parsing
131
132 A formalized definition of the legal forms for version strings is
133 included in the main F<version.pm> file.  Primitives are included for
134 common elements, although they are scoped to the file so they are useful
135 for reference purposes only.  There are two publicly accessible scalars
136 that can be used in other code (not exported):
137
138 =over 4
139
140 =item C<$version::LAX>
141
142 This regexp covers all of the legal forms allowed under the current
143 version string parser.  This is not to say that all of these forms
144 are recommended, and some of them can only be used when quoted.
145
146 For dotted decimals:
147
148     v1.2
149     1.2345.6
150     v1.23_4
151
152 The leading 'v' is optional if two or more decimals appear.  If only
153 a single decimal is included, then the leading 'v' is required to
154 trigger the dotted-decimal parsing.  A leading zero is permitted,
155 though not recommended except when quoted, because of the risk that
156 Perl will treat the number as octal.  A trailing underscore plus one
157 or more digits denotes an alpha or development release (and must be
158 quoted to be parsed properly).
159
160 For decimal versions:
161
162     1
163     1.2345
164     1.2345_01
165
166 an integer portion, an optional decimal point, and optionally one or
167 more digits to the right of the decimal are all required.  A trailing
168 underscore is permitted and a leading zero is permitted.  Just like
169 the lax dotted-decimal version, quoting the values is required for
170 alpha/development forms to be parsed correctly.
171
172 =item C<$version::STRICT>
173
174 This regexp covers a much more limited set of formats and constitutes
175 the best practices for initializing version objects.  Whether you choose
176 to employ decimal or dotted-decimal for is a personal preference however.
177
178 =over 4
179
180 =item v1.234.5
181
182 For dotted-decimal versions, a leading 'v' is required, with three or
183 more sub-versions of no more than three digits.  A leading 0 (zero)
184 before the first sub-version (in the above example, '1') is also
185 prohibited.
186
187 =item 2.3456
188
189 For decimal versions, an integer portion (no leading 0), a decimal point,
190 and one or more digits to the right of the decimal are all required.
191
192 =back
193
194 =back
195
196 Both of the provided scalars are already compiled as regular expressions
197 and do not contain either anchors or implicit groupings, so they can be
198 included in your own regular expressions freely.  For example, consider
199 the following code:
200
201         ($pkg, $ver) =~ /
202                 ^[ \t]*
203                 use [ \t]+($PKGNAME)
204                 (?:[ \t]+($version::STRICT))?
205                 [ \t]*;
206         /x;
207
208 This would match a line of the form:
209
210         use Foo::Bar::Baz v1.2.3;       # legal only in Perl 5.8.1+
211
212 where C<$PKGNAME> is another regular expression that defines the legal
213 forms for package names.
214
215 =head1 IMPLEMENTATION DETAILS
216
217 =head2 Equivalence between Decimal and Dotted-Decimal Versions
218
219 When Perl 5.6.0 was released, the decision was made to provide a
220 transformation between the old-style decimal versions and new-style
221 dotted-decimal versions:
222
223   5.6.0    == 5.006000
224   5.005_04 == 5.5.40
225
226 The floating point number is taken and split first on the single decimal
227 place, then each group of three digits to the right of the decimal makes up
228 the next digit, and so on until the number of significant digits is exhausted,
229 B<plus> enough trailing zeros to reach the next multiple of three.
230
231 This was the method that version.pm adopted as well.  Some examples may be
232 helpful:
233
234                             equivalent
235   decimal    zero-padded    dotted-decimal
236   -------    -----------    --------------
237   1.2        1.200          v1.200.0
238   1.02       1.020          v1.20.0
239   1.002      1.002          v1.2.0
240   1.0023     1.002300       v1.2.300
241   1.00203    1.002030       v1.2.30
242   1.002003   1.002003       v1.2.3
243
244 =head2 Quoting Rules
245
246 Because of the nature of the Perl parsing and tokenizing routines,
247 certain initialization values B<must> be quoted in order to correctly
248 parse as the intended version, especially when using the L<declare> or
249 L<qv> methods.  While you do not have to quote decimal numbers when
250 creating version objects, it is always safe to quote B<all> initial values
251 when using version.pm methods, as this will ensure that what you type is
252 what is used.
253
254 Additionally, if you quote your initializer, then the quoted value that goes
255 B<in> will be be exactly what comes B<out> when your $VERSION is printed
256 (stringified).  If you do not quote your value, Perl's normal numeric handling
257 comes into play and you may not get back what you were expecting.
258
259 If you use a mathematic formula that resolves to a floating point number,
260 you are dependent on Perl's conversion routines to yield the version you
261 expect.  You are pretty safe by dividing by a power of 10, for example,
262 but other operations are not likely to be what you intend.  For example:
263
264   $VERSION = version->new((qw$Revision: 1.4)[1]/10);
265   print $VERSION;          # yields 0.14
266   $V2 = version->new(100/9); # Integer overflow in decimal number
267   print $V2;               # yields something like 11.111.111.100
268
269 Perl 5.8.1 and beyond are able to automatically quote v-strings but
270 that is not possible in earlier versions of Perl.  In other words:
271
272   $version = version->new("v2.5.4");  # legal in all versions of Perl
273   $newvers = version->new(v2.5.4);    # legal only in Perl >= 5.8.1
274
275 =head2 What about v-strings?
276
277 There are two ways to enter v-strings: a bare number with two or more
278 decimal points, or a bare number with one or more decimal points and a
279 leading 'v' character (also bare).  For example:
280
281   $vs1 = 1.2.3; # encoded as \1\2\3
282   $vs2 = v1.2;  # encoded as \1\2
283
284 However, the use of bare v-strings to initialize version objects is
285 B<strongly> discouraged in all circumstances.  Also, bare
286 v-strings are not completely supported in any version of Perl prior to
287 5.8.1.
288
289 If you insist on using bare v-strings with Perl > 5.6.0, be aware of the
290 following limitations:
291
292 1) For Perl releases 5.6.0 through 5.8.0, the v-string code merely guesses,
293 based on some characteristics of v-strings.  You B<must> use a three part
294 version, e.g. 1.2.3 or v1.2.3 in order for this heuristic to be successful.
295
296 2) For Perl releases 5.8.1 and later, v-strings have changed in the Perl
297 core to be magical, which means that the version.pm code can automatically
298 determine whether the v-string encoding was used.
299
300 3) In all cases, a version created using v-strings will have a stringified
301 form that has a leading 'v' character, for the simple reason that sometimes
302 it is impossible to tell whether one was present initially.
303
304 =head2 Version Object Internals
305
306 version.pm provides an overloaded version object that is designed to both
307 encapsulate the author's intended $VERSION assignment as well as make it
308 completely natural to use those objects as if they were numbers (e.g. for
309 comparisons).  To do this, a version object contains both the original
310 representation as typed by the author, as well as a parsed representation
311 to ease comparisons.  Version objects employ L<overload> methods to
312 simplify code that needs to compare, print, etc the objects.
313
314 The internal structure of version objects is a blessed hash with several
315 components:
316
317     bless( {
318       'original' => 'v1.2.3_4',
319       'alpha' => 1,
320       'qv' => 1,
321       'version' => [
322         1,
323         2,
324         3,
325         4
326       ]
327     }, 'version' );
328
329 =over 4
330
331 =item original
332
333 A faithful representation of the value used to initialize this version
334 object.  The only time this will not be precisely the same characters
335 that exist in the source file is if a short dotted-decimal version like
336 v1.2 was used (in which case it will contain 'v1.2').  This form is
337 B<STRONGLY> discouraged, in that it will confuse you and your users.
338
339 =item qv
340
341 A boolean that denotes whether this is a decimal or dotted-decimal version.
342 See L<is_qv>.
343
344 =item alpha
345
346 A boolean that denotes whether this is an alpha version.  NOTE: that the
347 underscore can can only appear in the last position.  See L<is_alpha>.
348
349 =item version
350
351 An array of non-negative integers that is used for comparison purposes with
352 other version objects.
353
354 =back
355
356 =head2 Replacement UNIVERSAL::VERSION
357
358 In addition to the version objects, this modules also replaces the core
359 UNIVERSAL::VERSION function with one that uses version objects for its
360 comparisons.  The return from this operator is always the stringified form
361 as a simple scalar (i.e. not an object), but the warning message generated
362 includes either the stringified form or the normal form, depending on how
363 it was called.
364
365 For example:
366
367   package Foo;
368   $VERSION = 1.2;
369
370   package Bar;
371   $VERSION = "v1.3.5"; # works with all Perl's (since it is quoted)
372
373   package main;
374   use version;
375
376   print $Foo::VERSION; # prints 1.2
377
378   print $Bar::VERSION; # prints 1.003005
379
380   eval "use foo 10";
381   print $@; # prints "foo version 10 required..."
382   eval "use foo 1.3.5; # work in Perl 5.6.1 or better
383   print $@; # prints "foo version 1.3.5 required..."
384
385   eval "use bar 1.3.6";
386   print $@; # prints "bar version 1.3.6 required..."
387   eval "use bar 1.004"; # note Decimal version
388   print $@; # prints "bar version 1.004 required..."
389
390
391 IMPORTANT NOTE: This may mean that code which searches for a specific
392 string (to determine whether a given module is available) may need to be
393 changed.  It is always better to use the built-in comparison implicit in
394 C<use> or C<require>, rather than manually poking at C<< class->VERSION >>
395 and then doing a comparison yourself.
396
397 The replacement UNIVERSAL::VERSION, when used as a function, like this:
398
399   print $module->VERSION;
400
401 will also exclusively return the stringified form.  See L<Stringification>
402 for more details.
403
404 =head1 USAGE DETAILS
405
406 =head2 Using modules that use version.pm
407
408 As much as possible, the version.pm module remains compatible with all
409 current code.  However, if your module is using a module that has defined
410 C<$VERSION> using the version class, there are a couple of things to be
411 aware of.  For purposes of discussion, we will assume that we have the
412 following module installed:
413
414   package Example;
415   use version;  $VERSION = qv('1.2.2');
416   ...module code here...
417   1;
418
419 =over 4
420
421 =item Decimal versions always work
422
423 Code of the form:
424
425   use Example 1.002003;
426
427 will always work correctly.  The C<use> will perform an automatic
428 C<$VERSION> comparison using the floating point number given as the first
429 term after the module name (e.g. above 1.002.003).  In this case, the
430 installed module is too old for the requested line, so you would see an
431 error like:
432
433   Example version 1.002003 (v1.2.3) required--this is only version 1.002002 (v1.2.2)...
434
435 =item Dotted-Decimal version work sometimes
436
437 With Perl >= 5.6.2, you can also use a line like this:
438
439   use Example 1.2.3;
440
441 and it will again work (i.e. give the error message as above), even with
442 releases of Perl which do not normally support v-strings (see L<version/What about v-strings> below).  This has to do with that fact that C<use> only checks
443 to see if the second term I<looks like a number> and passes that to the
444 replacement L<UNIVERSAL::VERSION>.  This is not true in Perl 5.005_04,
445 however, so you are B<strongly encouraged> to always use a Decimal version
446 in your code, even for those versions of Perl which support the Dotted-Decimal
447 version.
448
449 =back
450
451 =head2 Object Methods
452
453 =over 4
454
455 =item new()
456
457 Like many OO interfaces, the new() method is used to initialize version
458 objects.  If two arguments are passed to C<new()>, the B<second> one will be
459 used as if it were prefixed with "v".  This is to support historical use of the
460 C<qw> operator with the CVS variable $Revision, which is automatically
461 incremented by CVS every time the file is committed to the repository.
462
463 In order to facilitate this feature, the following
464 code can be employed:
465
466   $VERSION = version->new(qw$Revision: 2.7 $);
467
468 and the version object will be created as if the following code
469 were used:
470
471   $VERSION = version->new("v2.7");
472
473 In other words, the version will be automatically parsed out of the
474 string, and it will be quoted to preserve the meaning CVS normally
475 carries for versions.  The CVS $Revision$ increments differently from
476 Decimal versions (i.e. 1.10 follows 1.9), so it must be handled as if
477 it were a Dotted-Decimal Version.
478
479 A new version object can be created as a copy of an existing version
480 object, either as a class method:
481
482   $v1 = version->new(12.3);
483   $v2 = version->new($v1);
484
485 or as an object method:
486
487   $v1 = version->new(12.3);
488   $v2 = $v1->new(12.3);
489
490 and in each case, $v1 and $v2 will be identical.  NOTE: if you create
491 a new object using an existing object like this:
492
493   $v2 = $v1->new();
494
495 the new object B<will not> be a clone of the existing object.  In the
496 example case, $v2 will be an empty object of the same type as $v1.
497
498 =back
499
500 =over 4
501
502 =item qv()
503
504 An alternate way to create a new version object is through the exported
505 qv() sub.  This is not strictly like other q? operators (like qq, qw),
506 in that the only delimiters supported are parentheses (or spaces).  It is
507 the best way to initialize a short version without triggering the floating
508 point interpretation.  For example:
509
510   $v1 = qv(1.2);         # v1.2.0
511   $v2 = qv("1.2");       # also v1.2.0
512
513 As you can see, either a bare number or a quoted string can usually
514 be used interchangably, except in the case of a trailing zero, which
515 must be quoted to be converted properly.  For this reason, it is strongly
516 recommended that all initializers to qv() be quoted strings instead of
517 bare numbers.
518
519 To prevent the C<qv()> function from being exported to the caller's namespace,
520 either use version with a null parameter:
521
522   use version ();
523
524 or just require version, like this:
525
526   require version;
527
528 Both methods will prevent the import() method from firing and exporting the
529 C<qv()> sub.
530
531 =back
532
533 For the subsequent examples, the following three objects will be used:
534
535   $ver   = version->new("1.2.3.4"); # see "Quoting Rules"
536   $alpha = version->new("1.2.3_4"); # see "Alpha Versions"
537   $nver  = version->new(1.002);     # see "Decimal Versions"
538
539 =over 4
540
541 =item Normal Form
542
543 For any version object which is initialized with multiple decimal
544 places (either quoted or if possible v-string), or initialized using
545 the L<qv>() operator, the stringified representation is returned in
546 a normalized or reduced form (no extraneous zeros), and with a leading 'v':
547
548   print $ver->normal;         # prints as v1.2.3.4
549   print $ver->stringify;      # ditto
550   print $ver;                 # ditto
551   print $nver->normal;        # prints as v1.2.0
552   print $nver->stringify;     # prints as 1.002, see "Stringification"
553
554 In order to preserve the meaning of the processed version, the
555 normalized representation will always contain at least three sub terms.
556 In other words, the following is guaranteed to always be true:
557
558   my $newver = version->new($ver->stringify);
559   if ($newver eq $ver ) # always true
560     {...}
561
562 =back
563
564 =over 4
565
566 =item Numification
567
568 Although all mathematical operations on version objects are forbidden
569 by default, it is possible to retrieve a number which corresponds
570 to the version object through the use of the $obj->numify
571 method.  For formatting purposes, when displaying a number which
572 corresponds a version object, all sub versions are assumed to have
573 three decimal places.  So for example:
574
575   print $ver->numify;         # prints 1.002003004
576   print $nver->numify;        # prints 1.002
577
578 Unlike the stringification operator, there is never any need to append
579 trailing zeros to preserve the correct version value.
580
581 =back
582
583 =over 4
584
585 =item Stringification
586
587 The default stringification for version objects returns exactly the same
588 string as was used to create it, whether you used C<new()> or C<qv()>,
589 with one exception.  The sole exception is if the object was created using
590 C<qv()> and the initializer did not have two decimal places or a leading
591 'v' (both optional), then the stringified form will have a leading 'v'
592 prepended, in order to support round-trip processing.
593
594 For example:
595
596   Initialized as          Stringifies to
597   ==============          ==============
598   version->new("1.2")       1.2
599   version->new("v1.2")     v1.2
600   qv("1.2.3")               1.2.3
601   qv("v1.3.5")             v1.3.5
602   qv("1.2")                v1.2   ### exceptional case
603
604 See also L<UNIVERSAL::VERSION>, as this also returns the stringified form
605 when used as a class method.
606
607 IMPORTANT NOTE: There is one exceptional cases shown in the above table
608 where the "initializer" is not stringwise equivalent to the stringified
609 representation.  If you use the C<qv>() operator on a version without a
610 leading 'v' B<and> with only a single decimal place, the stringified output
611 will have a leading 'v', to preserve the sense.  See the L<qv>() operator
612 for more details.
613
614 IMPORTANT NOTE 2: Attempting to bypass the normal stringification rules by
615 manually applying L<numify>() and L<normal>() will sometimes yield
616 surprising results:
617
618   print version->new(version->new("v1.0")->numify)->normal; # v1.0.0
619
620 The reason for this is that the L<numify>() operator will turn "v1.0"
621 into the equivalent string "1.000000".  Forcing the outer version object
622 to L<normal>() form will display the mathematically equivalent "v1.0.0".
623
624 As the example in L<new>() shows, you can always create a copy of an
625 existing version object with the same value by the very compact:
626
627   $v2 = $v1->new($v1);
628
629 and be assured that both C<$v1> and C<$v2> will be completely equivalent,
630 down to the same internal representation as well as stringification.
631
632 =back
633
634 =over 4
635
636 =item Comparison operators
637
638 Both C<cmp> and C<E<lt>=E<gt>> operators perform the same comparison between
639 terms (upgrading to a version object automatically).  Perl automatically
640 generates all of the other comparison operators based on those two.
641 In addition to the obvious equalities listed below, appending a single
642 trailing 0 term does not change the value of a version for comparison
643 purposes.  In other words "v1.2" and "1.2.0" will compare as identical.
644
645 For example, the following relations hold:
646
647   As Number        As String           Truth Value
648   -------------    ----------------    -----------
649   $ver >  1.0      $ver gt "1.0"       true
650   $ver <  2.5      $ver lt             true
651   $ver != 1.3      $ver ne "1.3"       true
652   $ver == 1.2      $ver eq "1.2"       false
653   $ver == 1.2.3.4  $ver eq "1.2.3.4"   see discussion below
654
655 It is probably best to chose either the Decimal notation or the string
656 notation and stick with it, to reduce confusion.  Perl6 version objects
657 B<may> only support Decimal comparisons.  See also L<Quoting Rules>.
658
659 WARNING: Comparing version with unequal numbers of decimal points (whether
660 explicitly or implicitly initialized), may yield unexpected results at
661 first glance.  For example, the following inequalities hold:
662
663   version->new(0.96)     > version->new(0.95); # 0.960.0 > 0.950.0
664   version->new("0.96.1") < version->new(0.95); # 0.096.1 < 0.950.0
665
666 For this reason, it is best to use either exclusively L<Decimal Versions> or
667 L<Dotted-Decimal Versions> with multiple decimal points.
668
669 =back
670
671 =over 4
672
673 =item Logical Operators
674
675 If you need to test whether a version object
676 has been initialized, you can simply test it directly:
677
678   $vobj = version->new($something);
679   if ( $vobj )   # true only if $something was non-blank
680
681 You can also test whether a version object is an L<Alpha Version>, for
682 example to prevent the use of some feature not present in the main
683 release:
684
685   $vobj = version->new("1.2_3"); # MUST QUOTE
686   ...later...
687   if ( $vobj->is_alpha )       # True
688
689 =back
690
691 =head1 AUTHOR
692
693 John Peacock E<lt>jpeacock@cpan.orgE<gt>
694
695 =head1 SEE ALSO
696
697 L<perl>.
698
699 =cut