Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Digest::file.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 "Digest::file 3pm"
61 .TH Digest::file 3pm 2026-03-09 "perl v5.42.1" "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 Digest::file \- Calculate digests of files
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 5
71 \& # Poor mans "md5sum" command
72 \& use Digest::file qw(digest_file_hex);
73 \& for (@ARGV) {
74 \& print digest_file_hex($_, "MD5"), " $_\en";
75 \& }
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 This module provide 3 convenience functions to calculate the digest
80 of files. The following functions are provided:
81 .ie n .IP "digest_file( $file, $algorithm, [$arg,...] )" 4
82 .el .IP "digest_file( \f(CW$file\fR, \f(CW$algorithm\fR, [$arg,...] )" 4
83 .IX Item "digest_file( $file, $algorithm, [$arg,...] )"
84 This function will calculate and return the binary digest of the bytes
85 of the given file. The function will croak if it fails to open or
86 read the file.
87 .Sp
88 The \f(CW$algorithm\fR is a string like "MD2", "MD5", "SHA\-1", "SHA\-512".
89 Additional arguments are passed to the constructor for the
90 implementation of the given algorithm.
91 .ie n .IP "digest_file_hex( $file, $algorithm, [$arg,...] )" 4
92 .el .IP "digest_file_hex( \f(CW$file\fR, \f(CW$algorithm\fR, [$arg,...] )" 4
93 .IX Item "digest_file_hex( $file, $algorithm, [$arg,...] )"
94 Same as \fBdigest_file()\fR, but return the digest in hex form.
95 .ie n .IP "digest_file_base64( $file, $algorithm, [$arg,...] )" 4
96 .el .IP "digest_file_base64( \f(CW$file\fR, \f(CW$algorithm\fR, [$arg,...] )" 4
97 .IX Item "digest_file_base64( $file, $algorithm, [$arg,...] )"
98 Same as \fBdigest_file()\fR, but return the digest as a base64 encoded
99 string.
100 .SH "SEE ALSO"
101 .IX Header "SEE ALSO"
102 Digest