/ 
App-xsum-0.010
River stage one • 1 direct dependent • 1 total dependent
/ xsum

NAME

xsum - Compute and check file checksums/digests (using various algorithms)

VERSION

This document describes version 0.010 of xsum (from Perl distribution App-xsum), released on 2020-05-28.

SYNOPSIS

Usage:

% xsum [-A=s] [-C=s+] [-a=s] [--algorithm=s] [-c] [--check] [--checksums-json=s] [--digest-args-json=s] [--digest-args=s] [--file=s+] [--files-json=s] [--page-result[=program]] [--tag] [--view-result[=program]] <file> ...

Examples:

Compute MD5 digests for some files:

% xsum -a md5 *.dat

Compute MD5 digests for some files (same as previous example, -a defaults to "md5"):

% xsum *.dat

Compute MD5 digests for some files (also same as previous example):

% xsum -a Digest -A MD5 *.dat

Compute MD5 digests for some files (also same as previous example, -a defaults to "Digest" when -A is specified):

% xsum -A MD5 *.dat

Compute BLAKE2b digests for some files (requirest Digest::BLAKE2 Perl module):

% xsum -A BLAKE2,blake2b *.dat

Compute SHA1 digest for data in stdin:

% somecmd | xsum -a sha1 -

Check MD5 digests of files listed in MD5SUMS:

% xsum --check MD5SUMS

Check MD5 digest of one file:

% xsum download.exe -C 9f4b2277f50a412e56de6e0306f4afb8

Check MD5 digest of two files:

% xsum download1.exe -C 9f4b2277f50a412e56de6e0306f4afb8 download2.zip -C 62b3bf86abdfdd87e9f6a3ea7b51aa7b

DESCRIPTION

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.

OPTIONS

* marks required options.

Main options

--algorithm=s, -a

Valid values:

["crc32","md5","sha1","sha224","sha256","sha384","sha512","sha512224","sha512256","Digest"]

In addition to `md5`, `sha1` or the other algorithms, you can also specify `Digest` to use Perl's <pm:Digest> module. This gives you access to tens of other digest modules, for example <pm: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, -c

Read checksum from files and check them.

--checksums-json=s, -C

Supply checksum(s) (JSON-encoded).

See --file.

--digest-args-json=s, -A

See --digest-args.

--digest-args=s

If you use `Digest` as the algorithm, you can pass arguments for the <pm:Digest> module here.

--file=s@

Supply checksum(s).

Can be specified multiple times.

--files-json=s
--tag

Create a BSD-style checksum.

Output options

--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C xsum xsum

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete xsum 'p/*/`xsum`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

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. Script which comes with the perl distribution.

md5sum. Unix utility.

sha1sum. Unix utility.

sha224sum. Unix utility.

sha256sum. Unix utility.

sha384sum. Unix utility.

sha512sum. Unix utility.

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.