From be75b8cbe457615b3d875ef594219fdc905d593b Mon Sep 17 00:00:00 2001 From: srirangav Date: Fri, 23 Aug 2024 10:41:04 -0700 Subject: [PATCH] add manpage for b3sum, generated using help2man: help2man -s 1 -n "Print or Check BLAKE3 Checksums" -N b3sum > b3sum.1 --- b3sum/b3sum.1 | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 b3sum/b3sum.1 diff --git a/b3sum/b3sum.1 b/b3sum/b3sum.1 new file mode 100644 index 000000000..0fb720c2d --- /dev/null +++ b/b3sum/b3sum.1 @@ -0,0 +1,79 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. +.TH B3SUM "1" "August 2024" "b3sum 1.5.4" "User Commands" +.SH NAME +b3sum \- Print or Check BLAKE3 Checksums +.SH SYNOPSIS +.B b3sum +[\fI\,OPTIONS\/\fR] [\fI\,FILE\/\fR]... +.SH DESCRIPTION +.SS "Arguments:" +.IP +[FILE]... +.IP +Files to hash, or checkfiles to check +.IP +When no file is given, or when \- is given, read standard input. +.SH OPTIONS +.HP +\fB\-\-keyed\fR +.IP +Use the keyed mode, reading the 32\-byte key from stdin +.HP +\fB\-\-derive\-key\fR +.IP +Use the key derivation mode, with the given context string +.IP +Cannot be used with \fB\-\-keyed\fR. +.HP +\fB\-l\fR, \fB\-\-length\fR +.IP +The number of output bytes, before hex encoding +.IP +[default: 32] +.HP +\fB\-\-seek\fR +.IP +The starting output byte offset, before hex encoding +.IP +[default: 0] +.HP +\fB\-\-num\-threads\fR +.IP +The maximum number of threads to use +.IP +By default, this is the number of logical cores. If this flag is omitted, or if its value +is 0, RAYON_NUM_THREADS is also respected. +.HP +\fB\-\-no\-mmap\fR +.IP +Disable memory mapping +.IP +Currently this also disables multithreading. +.HP +\fB\-\-no\-names\fR +.IP +Omit filenames in the output +.HP +\fB\-\-raw\fR +.IP +Write raw output bytes to stdout, rather than hex +.HP +\fB\-\-no\-names\fR is implied. In this case, only a single input is allowed. +.HP +\fB\-c\fR, \fB\-\-check\fR +.IP +Read BLAKE3 sums from the [FILE]s and check them +.HP +\fB\-\-quiet\fR +.IP +Skip printing OK for each checked file +.IP +Must be used with \fB\-\-check\fR. +.HP +\fB\-h\fR, \fB\-\-help\fR +.IP +Print help (see a summary with '\-h') +.HP +\fB\-V\fR, \fB\-\-version\fR +.IP +Print version