1XXHSUM(1)                        User Commands                       XXHSUM(1)
2
3
4

NAME

6       xxhsum - print or check xxHash non-cryptographic checksums
7

SYNOPSIS

9       xxhsum [<OPTION>]... [<FILE>]...
10       xxhsum -b [<OPTION>]...
11
12       xxh32sum is equivalent to xxhsum -H0
13       xxh64sum is equivalent to xxhsum -H1
14       xxh128sum is equivalent to xxhsum -H2
15

DESCRIPTION

17       Print  or  check xxHash (32, 64 or 128 bits) checksums. When FILE is -,
18       read standard input.
19
20       xxhsum supports a command line syntax  similar  but  not  identical  to
21       md5sum(1). Differences are: xxhsum doesn´t have text/binary mode switch
22       (-b, -t); xxhsum always treats files as binary files; xxhsum has a hash
23       bit width switch (-H);
24
25       As xxHash is a fast non-cryptographic checksum algorithm, xxhsum should
26       not be used for security related purposes.
27
28       xxhsum -b invokes benchmark mode. See OPTIONS and EXAMPLES for details.
29

OPTIONS

31       -V, --version
32              Displays xxhsum version and exits
33
34       -HHASHTYPE
35              Hash selection. HASHTYPE means  0=32bits,  1=64bits,  2=128bits.
36              Default value is 1 (64bits)
37
38       -q, --quiet
39              Remove status messages like "Loading..." written to stderr .
40
41       --little-endian
42              Set  output  hexadecimal checksum value as little endian conven‐
43              tion. By default, value is displayed as big endian.
44
45       -h, --help
46              Displays help and exits
47
48       The following four options are useful  only  when  verifying  checksums
49       (-c)
50
51       -c, --check FILE
52              Read xxHash sums from FILE and check them
53
54       -q, --quiet
55              On top of removing status messages written to stderr, also don´t
56              print OK for each successfully verified file
57
58       --strict
59              Return an error code if any line in the  file  is  invalid,  not
60              just  if  some  checksums  are wrong. This policy is disabled by
61              default, though UI will prompt an informational message  if  any
62              line in the file is detected invalid.
63
64       --status
65              Don´t output anything. Status code shows success.
66
67       -w, --warn
68              Emit  a warning message about each improperly formatted checksum
69              line.
70
71       The following options are useful only benchmark purpose
72
73       -b     Benchmark mode. See EXAMPLES for details.
74
75       -BBLOCKSIZE
76              Only useful for benchmark mode (-b). See EXAMPLES  for  details.
77              BLOCKSIZE  specifies  benchmark  mode´s  test data block size in
78              bytes. Default value is 102400
79
80       -iITERATIONS
81              Only useful for benchmark mode (-b). See EXAMPLES  for  details.
82              ITERATIONS  specifies  number of iterations in benchmark. Single
83              iteration lasts approximately 1000 milliseconds.  Default  value
84              is 3
85

EXIT STATUS

87       xxhsum  exit  0  on success, 1 if at least one file couldn´t be read or
88       doesn´t have the same checksum as the -c option.
89

EXAMPLES

91       Output xxHash (64bit) checksum values of  specific  files  to  standard
92       output
93
94
95
96           $ xxhsum -H1 foo bar baz
97
98
99
100       Output  xxHash  (32bit  and 64bit) checksum values of specific files to
101       standard output, and redirect it to xyz.xxh32 and qux.xxh64
102
103
104
105           $ xxhsum -H0 foo bar baz > xyz.xxh32
106           $ xxhsum -H1 foo bar baz > qux.xxh64
107
108
109
110       Read xxHash sums from specific files and check them
111
112
113
114           $ xxhsum -c xyz.xxh32 qux.xxh64
115
116
117
118       Benchmark xxHash algorithm for 16384 bytes data  in  10  times.  xxhsum
119       benchmarks all xxHash variants and output results to standard output.
120       The first column is the algorithm, the second column is the source data
121       size in bytes, the third column is the number of hashes  generated  per
122       second  (throughput),  and finally, the last column translates speed in
123       megabytes per second.
124
125
126
127           $ xxhsum -b -i10 -B16384
128
129
130

BUGS

132       Report bugs at: https://github.com/Cyan4973/xxHash/issues/
133

AUTHOR

135       Yann Collet
136

SEE ALSO

138       md5sum(1)
139
140
141
142xxhsum 0.7.2                     December 2019                       XXHSUM(1)
Impressum