Correct the man page for skein1024sum
[skeinsum.git] / skein1024sum.1
1 .\" Copyright (C) 2014 2015 2019 Jason Self <j@jxself.org>
2 .\"
3 .\" This file is part of skeinsum.
4 .\"
5 .\" skeinsum is free software: you can redistribute it and/or modify it
6 .\" under the terms of the GNU General Public License as published by
7 .\" the Free Software Foundation, either version 3 of the License, or
8 .\" (at your option) any later version.
9 .\"
10 .\" skeinsum is distributed in the hope that it will be useful, but
11 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 .\" General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU General Public License
16 .\" along with skeinsum. If not, see <http://www.gnu.org/licenses/>.
17 .TH skein1024sum 1
18 .SH NAME
19 skein1024sum \- Compute and check Skein cryptographic hashes
20 .SH SYNOPSIS
21 .B skein1024sum
22 [OPTIONS]
23 .IR file
24 .PP
25 With no
26 .IR file
27 or when
28 .IR file
29 is
30 .B \-
31 read standard input.
32 .SH DESCRIPTION
33 .BR skein1024sum
34 is part of the skeinsum package, which consists of the programs
35 skein256sum, skein512sum and skein1024sum providing state sizes of
36 256, 512 and 1024 bits respectively. The programs are an
37 implementation of version 1.3 of the Skein specification. Skein itself
38 is a fast and secure cryptographic hash, based the Threefish block
39 cipher. Skein can be used as a drop-in replacement for the entire SHA
40 family of hash functions.
41 .SH OPTIONS
42 .TP
43 .BR \-b, \-\-binary
44 read in binary mode
45 .TP
46 .BR \-c, \-\-check
47 read skein sums from the FILEs and check them
48 .TP
49 .BR \-\-tag
50 create a BSD-style checksum
51 .TP
52 .BR \-t, \-\-text
53 read in text mode (default)
54 .TP
55 .BR \-0
56 hash strings from command line
57 .PP
58 The following three options are useful only when verifying checksums:
59 .TP
60 .BR \-\-quiet
61 don't print OK for each successfully verified file
62 .TP
63 .BR \-\-status
64 don't output anything, status code shows success
65 .TP
66 .BR \-w, \-\-warn
67 warn about improperly formatted checksum lines
68 .TP
69 .BR \-\-strict
70 with 
71 .BR \-\-check
72 , exit non-zero for any invalid input
73 .TP
74 .BR \-h, \-\-help
75 display this help and exit
76 .TP
77 .BR \-V, \-\-version
78 output version information and exit
79 .SH AUTHORS
80 The Skein cryptographic hash function was created by Bruce Schneier,
81 Niels Ferguson, Stefan Lucks, Doug Whiting, Mihir Bellare, Tadayoshi
82 Kohno, Jon Callas and Jesse Walker.
83 .SH REPORTING BUGS
84 Report bugs to Jason Self <j@jxself.org>
85 .SH COPYRIGHT
86 skeinsum is free software: you can redistribute it and/or modify it
87 under the terms of the GNU General Public License as published by
88 the Free Software Foundation, either version 3 of the License, or
89 (at your option) any later version.
90 .PP
91 skeinsum is distributed in the hope that it will be useful, but
92 WITHOUT ANY WARRANTY; without even the implied warranty of
93 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
94 General Public License for more details.
95 .PP
96 You should have received a copy of the GNU General Public License
97 along with skeinsum. If not, see <http://www.gnu.org/licenses/>.
98 .SH SEE ALSO
99 .BR skein256sum(1),
100 .BR skein512sum(1)