Sponsoring The Perl Toolchain Summit 2025: Help make this important event another success Learn more

PERLANCAR / App-xsum-0.010 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

              
NAME
    App::xsum - Compute and check file checksums/digests (using various
    algorithms)
VERSION
    This document describes version 0.010 of App::xsum (from Perl
    distribution App-xsum), released on 2020-05-28.
SYNOPSIS
    See xsum.
FUNCTIONS
  xsum
    Usage:
     xsum(%args) -> [status, msg, payload, meta]
    Compute and check file checksums/digests (using various algorithms).
    "xsum" is a handy small utility that can be used as an
    alternative/replacement for the individual per-algorithm Unix utilities
    like "md5sum", "sha1sum", "sha224sum", and so on. It's basically the
    same as said Unix utilities but you can use a single command instead.
    The backend of "xsum" is a Perl module File::Digest which in turn
    delegates to the individual per-algorithm backend like Digest::MD5,
    Digest::SHA, and so on. Most of the backend modules are written in C/XS
    so you don't suffer significant performance decrease.
    This function is not exported.
    Arguments ('*' denotes required arguments):
    *   algorithm => *str*
        In addition to "md5", "sha1" or the other algorithms, you can also
        specify "Digest" to use Perl's Digest module. This gives you access
        to tens of other digest modules, for example Digest::BLAKE2 (see
        examples).
        When "--digest-args" ("-A") is not specified, algorithm defaults to
        "md5". But if "--digest-args" ("-A") is specified, algorithm
        defaults to "Digest", for convenience.
    *   check => *bool*
        Read checksum from files and check them.
    *   checksums => *array[str]*
        Supply checksum(s).
    *   digest_args => *array*
        If you use "Digest" as the algorithm, you can pass arguments for the
        Digest module here.
    *   files* => *array[filename]*
    *   tag => *bool*
        Create a BSD-style checksum.
    Returns an enveloped result (an array).
    First element (status) is an integer containing HTTP status code (200
    means OK, 4xx caller error, 5xx function error). Second element (msg) is
    a string containing error message, or 'OK' if status is 200. Third
    element (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.
    Return value: (any)
HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-xsum>.
SOURCE
    Source repository is at <https://github.com/perlancar/perl-App-xsum>.
BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=App-xsum>
    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.
SEE ALSO
    shasum. Perinci::To::POD=HASH(0x55f16a06f658).
    md5sum. Perinci::To::POD=HASH(0x55f16a06f658).
    sha1sum. Perinci::To::POD=HASH(0x55f16a06f658).
    sha224sum. Perinci::To::POD=HASH(0x55f16a06f658).
    sha256sum. Perinci::To::POD=HASH(0x55f16a06f658).
    sha384sum. Perinci::To::POD=HASH(0x55f16a06f658).
    sha512sum. Perinci::To::POD=HASH(0x55f16a06f658).
    sum from PerlPowerTools (which only supports older algorithms like
    CRC32).
AUTHOR
    perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
    This software is copyright (c) 2020, 2019, 2016 by perlancar@cpan.org.
    This is free software; you can redistribute it and/or modify it under
    the same terms as the Perl 5 programming language system itself.