aboutsummaryrefslogtreecommitdiff
path: root/man/cksum.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/cksum.1')
-rw-r--r--man/cksum.1125
1 files changed, 125 insertions, 0 deletions
diff --git a/man/cksum.1 b/man/cksum.1
new file mode 100644
index 0000000..967cfbd
--- /dev/null
+++ b/man/cksum.1
@@ -0,0 +1,125 @@
+.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
+.TH CKSUM "1" "2026-07-28" "BNU 9.11" "BNU Commands"
+.SH NAME
+cksum \- compute and verify file checksums
+.SH SYNOPSIS
+.B cksum
+[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
+.SH DESCRIPTION
+.\" This page is derived from GNU Coreutils documentation.
+This page documents BNU, an independent Bun implementation compatible with
+GNU Coreutils 9.11.
+.PP
+Print or verify checksums.
+By default use the 32 bit CRC algorithm.
+.PP
+With no FILE, or when FILE is \-, read standard input.
+.PP
+Mandatory arguments to long options are mandatory for short options too.
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum-a'\fB\-a, \-\-algorithm=\,TYPE\fP\X'tty: link'\/\fR
+select the digest type to use. See DIGEST below
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--base64'\fB\-\-base64\fP\X'tty: link'
+emit base64\-encoded digests, not hexadecimal
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum-c'\fB\-c, \-\-check\fP\X'tty: link'
+read checksums from the FILEs and check them
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum-l'\fB\-l, \-\-length=\,BITS\fP\X'tty: link'\/\fR
+digest length in bits; must not exceed the max size
+and must be a multiple of 8 for blake2b;
+must be 224, 256, 384, or 512 for sha2 or sha3
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--raw'\fB\-\-raw\fP\X'tty: link'
+emit a raw binary digest, not hexadecimal
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--tag'\fB\-\-tag\fP\X'tty: link'
+create a BSD\-style checksum (the default)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--untagged'\fB\-\-untagged\fP\X'tty: link'
+create a reversed style checksum, without digest type
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum-z'\fB\-z, \-\-zero\fP\X'tty: link'
+end each output line with NUL, not newline,
+and disable file name escaping
+.SS "The following five options are useful only when verifying checksums:"
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--ignore-missing'\fB\-\-ignore\-missing\fP\X'tty: link'
+don't fail or report status for missing files
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--quiet'\fB\-\-quiet\fP\X'tty: link'
+don't print OK for each successfully verified file
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--status'\fB\-\-status\fP\X'tty: link'
+don't output anything, status code shows success
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--strict'\fB\-\-strict\fP\X'tty: link'
+exit non\-zero for improperly formatted checksum lines
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum-w'\fB\-w, \-\-warn\fP\X'tty: link'
+warn about improperly formatted checksum lines
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#cksum--debug'\fB\-\-debug\fP\X'tty: link'
+indicate which implementation used
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/cksum#cksum--help'\fB\-\-help\fP\X'tty: link'
+display this help and exit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/cksum#cksum--version'\fB\-\-version\fP\X'tty: link'
+output version information and exit
+.SS "DIGEST determines the digest algorithm and default output format:"
+.TP
+sysv
+(equivalent to sum \fB\-s\fR)
+.TP
+bsd
+(equivalent to sum \fB\-r\fR)
+.TP
+crc
+(equivalent to cksum)
+.TP
+crc32b
+(only available through cksum)
+.TP
+md5
+(equivalent to md5sum)
+.TP
+sha1
+(equivalent to sha1sum)
+.TP
+sha2
+(equivalent to sha{224,256,384,512}sum)
+.TP
+sha3
+(only available through cksum)
+.TP
+blake2b
+(equivalent to b2sum)
+.TP
+sm3
+(only available through cksum)
+.PP
+When checking, the input should be a former output of this program,
+or equivalent standalone program.
+.SH AUTHORS
+Upstream GNU Coreutils documentation authors:
+Written by Padraig Brady and Q. Frank Xia.
+.br
+Adapted for BNU; the BNU implementation is independent.
+.SH "REPORTING BUGS"
+Report BNU bugs at <https://github.com/Soccera1/bnu/issues>.
+.br
+For upstream GNU Coreutils, see <https://www.gnu.org/software/coreutils/>.
+.SH COPYRIGHT
+Copyright \(co 2026 Free Software Foundation, Inc.
+.br
+This manual page was adapted for BNU in 2026.
+License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.SH "SEE ALSO"
+Upstream documentation <https://www.gnu.org/software/coreutils/cksum>
+.br
+BNU documentation is available locally via: info \(aq(bnu) cksum invocation\(aq