Debian Codegraph @

upstream/debian-unstable/man3/CPAN::Version.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "CPAN::Version 3perl"
58 .TH CPAN::Version 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CPAN::Version \- utility functions to compare CPAN versions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use CPAN::Version;
69 \&
70 \& CPAN::Version\->vgt("1.1","1.1.1"); # 1 bc. 1.1 > 1.001001
71 \&
72 \& CPAN::Version\->vlt("1.1","1.1"); # 0 bc. 1.1 not < 1.1
73 \&
74 \& CPAN::Version\->vcmp("1.1","1.1.1"); # 1 bc. first is larger
75 \&
76 \& CPAN::Version\->vcmp("1.1.1","1.1"); # \-1 bc. first is smaller
77 \&
78 \& CPAN::Version\->readable(v1.2.3); # "v1.2.3"
79 \&
80 \& CPAN::Version\->vstring("v1.2.3"); # v1.2.3
81 \&
82 \& CPAN::Version\->float2vv(1.002003); # "v1.2.3"
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 This module mediates between some version that perl sees in a package
87 and the version that is published by the CPAN indexer.
88 .PP
89 It's only written as a helper module for both CPAN.pm and CPANPLUS.pm.
90 .PP
91 As it stands it predates version.pm but has the same goal: make
92 version strings visible and comparable.
93 .SH LICENSE
94 .IX Header "LICENSE"
95 This program is free software; you can redistribute it and/or
96 modify it under the same terms as Perl itself.