Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add manpage for b3sum #423

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions b3sum/b3sum.1
Original file line number Diff line number Diff line change
@@ -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 <CONTEXT>
.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 <LEN>
.IP
The number of output bytes, before hex encoding
.IP
[default: 32]
.HP
\fB\-\-seek\fR <SEEK>
.IP
The starting output byte offset, before hex encoding
.IP
[default: 0]
.HP
\fB\-\-num\-threads\fR <NUM>
.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