mirror of
https://github.com/FEX-Emu/xxHash.git
synced 2024-11-27 16:51:01 +00:00
updated man page regarding -q
This commit is contained in:
Yann Collet
parent
4e4570f751
commit
c6ea1d2107
77
xxhsum.1
77
xxhsum.1
@ -1,101 +1,160 @@
|
||||
.TH "XXHSUM" "1" "September 2019" "xxhsum 0.7.2" "User Commands"
|
||||
.
|
||||
.TH "XXHSUM" "1" "October 2019" "xxhsum 0.7.2" "User Commands"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fBxxhsum\fR \- print or check xxHash non\-cryptographic checksums
|
||||
.
|
||||
.SH "SYNOPSIS"
|
||||
\fBxxhsum [<OPTION>] \|\.\|\.\|\. [<FILE>] \|\.\|\.\|\.\fR
|
||||
\fBxxhsum [<OPTION>] \.\.\. [<FILE>] \.\.\.\fR
|
||||
.
|
||||
.br
|
||||
\fBxxhsum \-b [<OPTION>] \|\.\|\.\|\.\fR
|
||||
\fBxxhsum \-b [<OPTION>] \.\.\.\fR
|
||||
.
|
||||
.P
|
||||
\fBxxh32sum\fR is equivalent to \fBxxhsum \-H0\fR
|
||||
.
|
||||
.br
|
||||
\fBxxh64sum\fR is equivalent to \fBxxhsum \-H1\fR
|
||||
.
|
||||
.br
|
||||
\fBxxh128sum\fR is equivalent to \fBxxhsum \-H2\fR
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
Print or check xxHash (32, 64 or 128 bits) checksums\. When \fIFILE\fR is \fB\-\fR, read standard input\.
|
||||
.
|
||||
.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 file as binary file; \fBxxhsum\fR has hash bit width switch (\fB\-H\fR);
|
||||
.
|
||||
.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 \fI\%#OPTIONS\fR and \fI\%#EXAMPLES\fR for details\.
|
||||
\fBxxhsum \-b\fR invokes benchmark mode\. See \fIOPTIONS\fR and \fIEXAMPLES\fR for details\.
|
||||
.
|
||||
.SH "OPTIONS"
|
||||
.
|
||||
.TP
|
||||
\fB\-V\fR, \fB\-\-version\fR
|
||||
Display xxhsum version
|
||||
Display xxhsum version and exits
|
||||
.
|
||||
.TP
|
||||
\fB\-H\fR\fIHASHTYPE\fR
|
||||
Hash selection\. \fIHASHTYPE\fR means \fB0\fR=32bits, \fB1\fR=64bits, \fB2\fR=128bits\. Default value is \fB1\fR (64bits)
|
||||
.
|
||||
.TP
|
||||
\fB\-q\fR, \fB\-\-quiet\fR
|
||||
Remove status messages like "Loading \.\.\." written to \fBstderr\fR \.
|
||||
.
|
||||
.TP
|
||||
\fB\-\-little\-endian\fR
|
||||
Set output hexadecimal checksum value as little endian convention\. By default, value is displayed as big endian\.
|
||||
.
|
||||
.TP
|
||||
\fB\-h\fR, \fB\-\-help\fR
|
||||
Display help and exit
|
||||
.
|
||||
.P
|
||||
\fBThe following four options are useful only when verifying checksums (\fB\-c\fR)\fR
|
||||
.
|
||||
.TP
|
||||
\fB\-c\fR, \fB\-\-check\fR
|
||||
Read xxHash sums from the \fIFILE\fRs and check them
|
||||
.
|
||||
.TP
|
||||
\fB\-\-quiet\fR
|
||||
\fBq\fR, \fB\-\-quiet\fR
|
||||
Exit non\-zero for improperly formatted checksum lines
|
||||
.
|
||||
.TP
|
||||
\fB\-\-strict\fR
|
||||
Don\'t print OK for each successfully verified file
|
||||
.
|
||||
.TP
|
||||
\fB\-\-status\fR
|
||||
Don\'t output anything, status code shows success
|
||||
.
|
||||
.TP
|
||||
\fB\-w\fR, \fB\-\-warn\fR
|
||||
Warn about improperly formatted checksum lines
|
||||
.
|
||||
.P
|
||||
\fBThe following options are useful only benchmark purpose\fR
|
||||
.
|
||||
.TP
|
||||
\fB\-b\fR
|
||||
Benchmark mode\. See \fI\%#EXAMPLES\fR for details\.
|
||||
Benchmark mode\. See \fIEXAMPLES\fR for details\.
|
||||
.
|
||||
.TP
|
||||
\fB\-B\fR\fIBLOCKSIZE\fR
|
||||
Only useful for benchmark mode (\fB\-b\fR)\. See \fI\%#EXAMPLES\fR for details\. \fIBLOCKSIZE\fR specifies benchmark mode\'s test data block size in bytes\. Default value is 102400
|
||||
Only useful for benchmark mode (\fB\-b\fR)\. See \fIEXAMPLES\fR for details\. \fIBLOCKSIZE\fR specifies benchmark mode\'s test data block size in bytes\. Default value is 102400
|
||||
.
|
||||
.TP
|
||||
\fB\-i\fR\fIITERATIONS\fR
|
||||
Only useful for benchmark mode (\fB\-b\fR)\. See \fI\%#EXAMPLES\fR for details\. \fIITERATIONS\fR specifies number of iterations in benchmark\. Single iteration lasts approximately 1000 milliseconds\. Default value is 3
|
||||
Only useful for benchmark mode (\fB\-b\fR)\. See \fIEXAMPLES\fR for details\. \fIITERATIONS\fR specifies number of iterations in benchmark\. Single iteration lasts approximately 1000 milliseconds\. Default value is 3
|
||||
.
|
||||
.SH "EXIT STATUS"
|
||||
\fBxxhsum\fR exit \fB0\fR on success, \fB1\fR if at least one file couldn\'t be read or doesn\'t have the same checksum as the \fB\-c\fR option\.
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
Output xxHash (64bit) checksum values of specific files to standard output
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ xxhsum \-H1 foo bar baz
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Output xxHash (32bit and 64bit) checksum values of specific files to standard output, and redirect it to \fBxyz\.xxh32\fR and \fBqux\.xxh64\fR
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ xxhsum \-H0 foo bar baz > xyz\.xxh32
|
||||
$ xxhsum \-H1 foo bar baz > qux\.xxh64
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Read xxHash sums from specific files and check them
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ xxhsum \-c xyz\.xxh32 qux\.xxh64
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Benchmark xxHash algorithm for 16384 bytes data in 10 times\. \fBxxhsum\fR benchmarks all xxHash variants and output results to standard output\.
|
||||
.
|
||||
.br
|
||||
First column means algorithm, second column is source data size in bytes, third column is number of hashes generated per second (throughput), and finally last column translates speed in mega\-bytes per seconds\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
$ xxhsum \-b \-i10 \-B16384
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "BUGS"
|
||||
Report bugs at: https://github\.com/Cyan4973/xxHash/issues/
|
||||
.
|
||||
.SH "AUTHOR"
|
||||
Yann Collet
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
md5sum(1)
|
||||
|
||||
@ -33,12 +33,15 @@ OPTIONS
|
||||
-------
|
||||
|
||||
* `-V`, `--version`:
|
||||
Display xxhsum version
|
||||
Display xxhsum version and exits
|
||||
|
||||
* `-H`<HASHTYPE>:
|
||||
Hash selection. <HASHTYPE> means `0`=32bits, `1`=64bits, `2`=128bits.
|
||||
Default value is `1` (64bits)
|
||||
|
||||
* `-q`, `--quiet`:
|
||||
Remove status messages like "Loading ..." written to `stderr` .
|
||||
|
||||
* `--little-endian`:
|
||||
Set output hexadecimal checksum value as little endian convention.
|
||||
By default, value is displayed as big endian.
|
||||
@ -51,7 +54,7 @@ OPTIONS
|
||||
* `-c`, `--check`:
|
||||
Read xxHash sums from the <FILE>s and check them
|
||||
|
||||
* `--quiet`:
|
||||
* `q`, `--quiet`:
|
||||
Exit non-zero for improperly formatted checksum lines
|
||||
|
||||
* `--strict`:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user