Skip to content

Commit

Permalink
Update xxhsum.1
Browse files Browse the repository at this point in the history
Generate with the following commands:

rm cli/xxhsum.1
make man
man cli/xxhsum.1
  • Loading branch information
t-mat committed Jul 10, 2023
1 parent c45304f commit 4a47319
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions cli/xxhsum.1
Expand Up @@ -2,17 +2,30 @@
.SH "NAME"
\fBxxhsum\fR \- print or check xxHash non\-cryptographic checksums
.SH "SYNOPSIS"
\fBxxhsum [<OPTION>] \|\.\|\.\|\. [<FILE>] \|\.\|\.\|\.\fR \fBxxhsum \-b [<OPTION>] \|\.\|\.\|\.\fR
\fBxxhsum\fR [\fIOPTION\fR]\|\.\|\.\|\. [\fIFILE\fR]\|\.\|\.\|\.
.br
\fBxxhsum \-b\fR [\fIOPTION\fR]\|\.\|\.\|\.
.P
\fBxxh32sum\fR is equivalent to \fBxxhsum \-H0\fR, \fBxxh64sum\fR is equivalent to \fBxxhsum \-H1\fR, \fBxxh128sum\fR is equivalent to \fBxxhsum \-H2\fR\.
.SH "DESCRIPTION"
Print or check xxHash (32, 64 or 128 bits) checksums\. When no \fIFILE\fR, read standard input, except if it's the console\. When \fIFILE\fR is \fB\-\fR, read standard input even if it's the console\.
Print or check xxHash (32, 64 or 128 bits) checksums\.
.br
When no \fIFILE\fR, read standard input, except if it's the console\. When \fIFILE\fR is \fB\-\fR, read standard input even if it's the console\.
.P
\fBxxhsum\fR supports a command line syntax similar but not identical to md5sum(1)\. Differences are: \fBxxhsum\fR doesn't have text/binary mode switch (\fB\-b\fR, \fB\-t\fR); \fBxxhsum\fR always treats files as binary file; \fBxxhsum\fR has a hash selection switch (\fB\-H\fR);
\fBxxhsum\fR supports a command line syntax similar but not identical to md5sum(1)\. Differences are:
.IP "\[ci]" 4
\fBxxhsum\fR doesn't have text mode switch (\fB\-t\fR)
.IP "\[ci]" 4
\fBxxhsum\fR doesn't have short binary mode switch (\fB\-b\fR)
.IP "\[ci]" 4
\fBxxhsum\fR always treats files as binary file
.IP "\[ci]" 4
\fBxxhsum\fR has a hash selection switch (\fB\-H\fR)
.IP "" 0
.P
As xxHash is a fast non\-cryptographic checksum algorithm, \fBxxhsum\fR should not be used for security related purposes\.
.P
\fBxxhsum \-b\fR invokes benchmark mode\. See \fIOPTIONS\fR and \fIEXAMPLES\fR for details\.
\fBxxhsum \-b\fR invokes benchmark mode\. See OPTIONS and EXAMPLES for details\.
.SH "OPTIONS"
.TP
\fB\-V\fR, \fB\-\-version\fR
Expand All @@ -21,6 +34,9 @@ Displays xxhsum version and exits
\fB\-H\fR\fIHASHTYPE\fR
Hash selection\. \fIHASHTYPE\fR means \fB0\fR=XXH32, \fB1\fR=XXH64, \fB2\fR=XXH128, \fB3\fR=XXH3\. Note that \fB\-H3\fR triggers \fB\-\-tag\fR, which can't be skipped (this is to reduce risks of confusion with \fB\-H2\fR (\fBXXH64\fR))\. Alternatively, \fIHASHTYPE\fR \fB32\fR=XXH32, \fB64\fR=XXH64, \fB128\fR=XXH128\. Default value is \fB1\fR (XXH64)
.TP
\fB\-\-binary\fR
Read in binary mode\.
.TP
\fB\-\-tag\fR
Output in the BSD style\.
.TP
Expand All @@ -29,8 +45,7 @@ Set output hexadecimal checksum value as little endian convention\. By default,
.TP
\fB\-h\fR, \fB\-\-help\fR
Displays help and exits
.P
\fBThe following four options are useful only when verifying checksums (\fB\-c\fR)\fR
.SS "The following options are useful only when verifying checksums (\-c):"
.TP
\fB\-c\fR, \fB\-\-check\fR \fIFILE\fR
Read xxHash sums from \fIFILE\fR and check them
Expand All @@ -46,14 +61,10 @@ Don't output anything\. Status code shows success\.
.TP
\fB\-w\fR, \fB\-\-warn\fR
Emit a warning message about each improperly formatted checksum line\.
.TP
\fB\-\-ignore\-missing\fR
Don't fail or report status for missing files\.
.P
\fBThe following options are useful only benchmark purpose\fR
.SS "The following options are useful only benchmark purpose:"
.TP
\fB\-b\fR
Benchmark mode\. See \fIEXAMPLES\fR for details\.
Benchmark mode\. See EXAMPLES for details\.
.TP
\fB\-b#\fR
Specify ID of variant to be tested\. Multiple variants can be selected, separated by a ',' comma\.
Expand Down

0 comments on commit 4a47319

Please sign in to comment.