Debian Codegraph @

upstream/debian-unstable/man3/File::Compare.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 "File::Compare 3perl"
58 .TH File::Compare 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 File::Compare \- Compare files or filehandles
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use File::Compare;
69 \&
70 \& if (compare("file1", "file2") == 0) {
71 \& print "They\*(Aqre equal\en";
72 \& }
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 The \f(CW\*(C`File::Compare::compare\*(C'\fR function compares the contents of two
77 sources, each of which can be a file or a file handle. It is exported
78 from \f(CW\*(C`File::Compare\*(C'\fR by default.
79 .PP
80 \&\f(CW\*(C`File::Compare::cmp\*(C'\fR is a synonym for \f(CW\*(C`File::Compare::compare\*(C'\fR. It is
81 exported from \f(CW\*(C`File::Compare\*(C'\fR only by request.
82 .PP
83 \&\f(CW\*(C`File::Compare::compare_text\*(C'\fR does a line by line comparison of the two
84 files. It stops as soon as a difference is detected. \f(CWcompare_text()\fR
85 accepts an optional third argument: This must be a CODE reference to
86 a line comparison function, which returns \f(CW0\fR when both lines are considered
87 equal. For example:
88 .PP
89 .Vb 1
90 \& compare_text($file1, $file2)
91 .Ve
92 .PP
93 is basically equivalent to
94 .PP
95 .Vb 1
96 \& compare_text($file1, $file2, sub {$_[0] ne $_[1]} )
97 .Ve
98 .SH RETURN
99 .IX Header "RETURN"
100 \&\f(CW\*(C`File::Compare::compare\*(C'\fR and its sibling functions return \f(CW0\fR if the files
101 are equal, \f(CW1\fR if the files are unequal, or \f(CW\-1\fR if an error was encountered.
102 .SH AUTHOR
103 .IX Header "AUTHOR"
104 \&\f(CW\*(C`File::Compare\*(C'\fR was written by Nick Ing-Simmons.
105 Its original documentation was written by Chip Salzenberg.