Debian Codegraph @

upstream/mageia-cauldron/man3pm/File::Compare.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "File::Compare 3pm"
61 .TH File::Compare 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 File::Compare \- Compare files or filehandles
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use File::Compare;
72 \&
73 \& if (compare("file1", "file2") == 0) {
74 \& print "They\*(Aqre equal\en";
75 \& }
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 The \f(CW\*(C`File::Compare::compare\*(C'\fR function compares the contents of two
80 sources, each of which can be a file or a file handle. It is exported
81 from \f(CW\*(C`File::Compare\*(C'\fR by default.
82 .PP
83 \&\f(CW\*(C`File::Compare::cmp\*(C'\fR is a synonym for \f(CW\*(C`File::Compare::compare\*(C'\fR. It is
84 exported from \f(CW\*(C`File::Compare\*(C'\fR only by request.
85 .PP
86 \&\f(CW\*(C`File::Compare::compare_text\*(C'\fR does a line by line comparison of the two
87 files. It stops as soon as a difference is detected. \f(CWcompare_text()\fR
88 accepts an optional third argument: This must be a CODE reference to
89 a line comparison function, which returns \f(CW0\fR when both lines are considered
90 equal. For example:
91 .PP
92 .Vb 1
93 \& compare_text($file1, $file2)
94 .Ve
95 .PP
96 is basically equivalent to
97 .PP
98 .Vb 1
99 \& compare_text($file1, $file2, sub {$_[0] ne $_[1]} )
100 .Ve
101 .SH RETURN
102 .IX Header "RETURN"
103 \&\f(CW\*(C`File::Compare::compare\*(C'\fR and its sibling functions return \f(CW0\fR if the files
104 are equal, \f(CW1\fR if the files are unequal, or \f(CW\-1\fR if an error was encountered.
105 .SH AUTHOR
106 .IX Header "AUTHOR"
107 \&\f(CW\*(C`File::Compare\*(C'\fR was written by Nick Ing\-Simmons.
108 Its original documentation was written by Chip Salzenberg.