xsum.man


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

.TH XSUM 1 sha3sum
.SH NAME
xsum - Compute and check Xsum message digests
.SH SYNOPSIS
.B xsum
[-u | -l | -b | -c]
[-R
.IR rate ]
[-C
.IR capacity ]
[-N
.IR output-size ]
[-S
.IR state-size ]
[-W
.IR word-size ]
[-Z
.IR squeeze-count ]
[-vx]
.RI [ file \ ...]
.SH DESCRIPTION
Print or check Xsum checksums. If no file
or when the file is -, read standard input.
.TP
.B -u
Output checksums in upper-case hexadecimal representation. (default)
.TP
.B -l
Output checksums in lower-case hexadecimal representation.
.TP
.B -b
Output checksums in binary representation. This suppresses
the filenames and checksum delimiters. Only the checksums
are printed.
.TP
.B -c
Read Xsum sums from the file and check them against
the files on your systems. The input files files
should be formated as the output of this program, or
similarly. This is not going to work if any of the
filenames in the input files starts with a regular
blank space or horizontal tab space, or if they
contain a line feed, carriage return or form feed.
.TP
.B -x
Convert input files from hexadecimal for to binary form
before calculating the checksums.
.TP
.B -v
Print the hashing parameters.
.P
The following options change the hashing parameters:
.TP
.BI -R\  rate
Change the rate.
.TP
.BI -C\  capacity
Change the capacity.
.TP
.BR -N ,\  -O \ \fIoutput-size\fP
Change the output size.
.TP
.BR -S ,\  -B \ \fIstate-size\fP
Change the state size.
.TP
.BI -W\  word-size
Change the word size.
.TP
.BI -Z\  squeeze-count
Change the number of squeezes that is performed.
.SH EXIT STATUS
.TP
0
Successful completion.
.TP
1
Checksums did not match or a file did not exist.
.TP
2
An error occurrsed.
.SH AUTHORS
Mattias Andrée
.RI < maandree@kth.se >
.SH NOTES
All commands in the sha3sum package allow changing
the hashing parameters. However it is only intended
to be used with
.BR keccaksum (1),
or if you know what you are doing; apart from
.B -N
which is intended to
.I always
be used with
.BR shake256sum (1),
.BR shake512sum (1),
.BR rawshake256sum (1),
and
.BR rawshake512sum (1).