Add man pages

[skeinsum.git] / skein1024sum.1

diff --git a/skein1024sum.1 b/skein1024sum.1
new file mode 100644 (file)
index 0000000..20ac577
--- /dev/null
+++ b/skein1024sum.1
@@ -0,0 +1,100 @@
+.\" Copyright (C) 2014 2015 2019 Jason Self <j@jxself.org>
+.\"
+.\" This file is part of skeinsum.
+.\"
+.\" skeinsum is free software: you can redistribute it and/or modify it
+.\" under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" skeinsum is distributed in the hope that it will be useful, but
+.\" WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+.\" General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with skeinsum. If not, see <http://www.gnu.org/licenses/>.
+.TH skein1024sum 1
+.SH NAME
+skein256sum \- Compute and check Skein cryptographic hashes
+.SH SYNOPSIS
+.B skein1024sum
+[OPTIONS]
+.IR file
+.PP
+With no
+.IR file
+or when
+.IR file
+is
+.B \-
+read standard input.
+.SH DESCRIPTION
+.BR skein1024sum
+is part of the skeinsum package, which consists of the programs
+skein256sum, skein512sum and skein1024sum providing state sizes of
+256, 512 and 1024 bits respectively. The programs are an
+implementation of version 1.3 of the Skein specification. Skein itself
+is a fast and secure cryptographic hash, based the Threefish block
+cipher. Skein can be used as a drop-in replacement for the entire SHA
+family of hash functions.
+.SH OPTIONS
+.TP
+.BR \-b, \-\-binary
+read in binary mode
+.TP
+.BR \-c, \-\-check
+read skein sums from the FILEs and check them
+.TP
+.BR \-\-tag
+create a BSD-style checksum
+.TP
+.BR \-t, \-\-text
+read in text mode (default)
+.TP
+.BR \-0
+hash strings from command line
+.PP
+The following three options are useful only when verifying checksums:
+.TP
+.BR \-\-quiet
+don't print OK for each successfully verified file
+.TP
+.BR \-\-status
+don't output anything, status code shows success
+.TP
+.BR \-w, \-\-warn
+warn about improperly formatted checksum lines
+.TP
+.BR \-\-strict
+with 
+.BR \-\-check
+, exit non-zero for any invalid input
+.TP
+.BR \-h, \-\-help
+display this help and exit
+.TP
+.BR \-V, \-\-version
+output version information and exit
+.SH AUTHORS
+The Skein cryptographic hash function was created by Bruce Schneier,
+Niels Ferguson, Stefan Lucks, Doug Whiting, Mihir Bellare, Tadayoshi
+Kohno, Jon Callas and Jesse Walker.
+.SH REPORTING BUGS
+Report bugs to Jason Self <j@jxself.org>
+.SH COPYRIGHT
+skeinsum is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+.PP
+skeinsum is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+.PP
+You should have received a copy of the GNU General Public License
+along with skeinsum. If not, see <http://www.gnu.org/licenses/>.
+.SH SEE ALSO
+.BR skein256sum(1),
+.BR skein512sum(1)
\ No newline at end of file