From: Jason Self Date: Mon, 25 Feb 2019 04:00:14 +0000 (-0800) Subject: Add man pages X-Git-Url: https://jxself.org/git/?a=commitdiff_plain;h=dc08fdc15f71ba1dd1d360bb773f17fcd8480bc2;p=skeinsum.git Add man pages --- diff --git a/makefile.am b/makefile.am index 8aea02c..7bfbdac 100644 --- a/makefile.am +++ b/makefile.am @@ -14,6 +14,7 @@ # along with skeinsum. If not, see . bin_PROGRAMS = skein256sum skein512sum skein1024sum +man_MANS = skein256sum.1 skein512sum.1 skein1024sum.1 skein256sum_SOURCES = skeinapi_ref.c skein.c skein256.c skein_block.c skein_debug.c skein_cli.c skein512sum_SOURCES = skeinapi_ref.c skein.c skein512.c skein_block.c skein_debug.c skein_cli.c skein1024sum_SOURCES = skeinapi_ref.c skein.c skein1024.c skein_block.c skein_debug.c skein_cli.c diff --git a/skein1024sum.1 b/skein1024sum.1 new file mode 100644 index 0000000..20ac577 --- /dev/null +++ b/skein1024sum.1 @@ -0,0 +1,100 @@ +.\" Copyright (C) 2014 2015 2019 Jason Self +.\" +.\" 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 . +.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 +.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 . +.SH SEE ALSO +.BR skein256sum(1), +.BR skein512sum(1) \ No newline at end of file diff --git a/skein256sum.1 b/skein256sum.1 new file mode 100644 index 0000000..f4ddf74 --- /dev/null +++ b/skein256sum.1 @@ -0,0 +1,100 @@ +.\" Copyright (C) 2014 2015 2019 Jason Self +.\" +.\" 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 . +.TH skein256sum 1 +.SH NAME +skein256sum \- Compute and check Skein cryptographic hashes +.SH SYNOPSIS +.B skein256sum +[OPTIONS] +.IR file +.PP +With no +.IR file +or when +.IR file +is +.B \- +read standard input. +.SH DESCRIPTION +.BR skein256sum +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 +.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 . +.SH SEE ALSO +.BR skein512sum(1), +.BR skein1024sum(1) \ No newline at end of file diff --git a/skein512sum.1 b/skein512sum.1 new file mode 100644 index 0000000..0bff429 --- /dev/null +++ b/skein512sum.1 @@ -0,0 +1,100 @@ +.\" Copyright (C) 2014 2015 2019 Jason Self +.\" +.\" 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 . +.TH skein512sum 1 +.SH NAME +skein512sum \- Compute and check Skein cryptographic hashes +.SH SYNOPSIS +.B skein512sum +[OPTIONS] +.IR file +.PP +With no +.IR file +or when +.IR file +is +.B \- +read standard input. +.SH DESCRIPTION +.BR skein512sum +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 +.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 . +.SH SEE ALSO +.BR skein256sum(1), +.BR skein1024sum(1) \ No newline at end of file