FEX-Emu/xxHash
1
0
Fork 0
mirror of https://github.com/FEX-Emu/xxHash.git synced 2024-12-03 20:21:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
d2df04efcb
xxHash/xxhsum.1

151 lines
3.6 KiB
Groff
Raw Normal View History

Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.
Added : make install
2016-08-23 09:42:53 +00:00
.TH "XXHSUM" "1" "August 2016" "xxhsum 0.6.2" "User Commands"
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.
.SH "NAME"
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
\fBxxhsum\fR \- print or check xxHash non\-cryptographic checksums
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.
.SH "SYNOPSIS"
\fBxxhsum\fR [\fIOPTION\fR] \.\.\. [\fIFILE\fR] \.\.\.
.
Added : make install
2016-08-23 09:42:53 +00:00
.br
\fBxxhsum \-b\fR [\fIOPTION\fR] \.\.\.
.
.P
\fBxxh32sum\fR is equivalent to \fBxxhsum \-H0\fR
.
.br
\fBxxh64sum\fR is equivalent to \fBxxhsum \-H1\fR
.
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.SH "DESCRIPTION"
Print or check xxHash (32 or 64bit) checksums\. When \fIFILE\fR is \fB\-\fR, read standard input\.
.
.P
Revamp xxhsum.1
2016-02-22 13:23:29 +00:00
\fBxxhsum\fR supports a command line syntax similar but not indentical 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);
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
.P
Added : make install
2016-08-23 09:42:53 +00:00
As xxHash is a fast non\-cryptographic checksum algorithm, \fBxxhsum\fR should not be used for security related purposes\.
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
.
Added : make install
2016-08-23 09:42:53 +00:00
.P
\fBxxhsum \-b\fR invokes benchmark mode\. See \fIOPTIONS\fR and \fIEXAMPLES\fR for details\.
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
.
Added : make install
2016-08-23 09:42:53 +00:00
.SH "OPTIONS"
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.
.TP
Added : make install
2016-08-23 09:42:53 +00:00
\fB\-V\fR, \fB\-\-version\fR
Display xxhsum version
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
.
.TP
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
\fB\-H\fR\fIHASHTYPE\fR
Hash selection\. \fIHASHTYPE\fR means \fB0\fR=32bits, \fB1\fR=64bits\. Default value is \fB1\fR (64bits)
.
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
.TP
\fB\-\-little\-endian\fR
Added : make install
2016-08-23 09:42:53 +00:00
Set output hexadecimal checksum value as little endian convention\. By default, value is displayed as big endian\.
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
.
.TP
Added : make install
2016-08-23 09:42:53 +00:00
\fB\-h\fR, \fB\-\-help\fR
Display help and exit
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
.
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.P
Add EXIT STATUS, EXAMPLES, version number to xxhsum.1 Makefile - Add version number XXHSUM_VERSION - Add ronn's options to add version number xxhsum.1.md - Add `EXIT STATUS` and `EXAMPLE` section
2016-02-21 00:46:58 +00:00
\fBThe following four options are useful only when verifying checksums (\fB\-c\fR)\fR
.
.TP
Added : make install
2016-08-23 09:42:53 +00:00
\fB\-c\fR, \fB\-\-check\fR
Read xxHash sums from the \fIFILE\fRs and check them
.
.TP
Add EXIT STATUS, EXAMPLES, version number to xxhsum.1 Makefile - Add version number XXHSUM_VERSION - Add ronn's options to add version number xxhsum.1.md - Add `EXIT STATUS` and `EXAMPLE` section
2016-02-21 00:46:58 +00:00
\fB\-\-quiet\fR
Exit non\-zero for improperly formatted checksum lines
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.
.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
Revamp xxhsum.1
2016-02-22 13:23:29 +00:00
\fB\-w\fR, \fB\-\-warn\fR
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
Warn about improperly formatted checksum lines
.
Added : make install
2016-08-23 09:42:53 +00:00
.P
\fBThe following options are useful only benchmark purpose\fR
.
.TP
\fB\-b\fR
Benchmark mode\. See \fIEXAMPLES\fR for details\.
.
.TP
\fB\-B\fR\fIBLOCKSIZE\fR
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 \fIEXAMPLES\fR for details\. \fIITERATIONS\fR specifies number of iterations in benchmark\. Single iteration takes at least 2500 milliseconds\. Default value is 3
.
Add EXIT STATUS, EXAMPLES, version number to xxhsum.1 Makefile - Add version number XXHSUM_VERSION - Add ronn's options to add version number xxhsum.1.md - Add `EXIT STATUS` and `EXAMPLE` section
2016-02-21 00:46:58 +00:00
.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
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
Output xxHash (32bit and 64bit) checksum values of specific files to standard output, and redirect it to \fBxyz\.xxh32\fR and \fBqux\.xxh64\fR
Add EXIT STATUS, EXAMPLES, version number to xxhsum.1 Makefile - Add version number XXHSUM_VERSION - Add ronn's options to add version number xxhsum.1.md - Add `EXIT STATUS` and `EXAMPLE` section
2016-02-21 00:46:58 +00:00
.
.IP "" 4
.
.nf
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
$ xxhsum \-H0 foo bar baz > xyz\.xxh32
$ xxhsum \-H1 foo bar baz > qux\.xxh64
Add EXIT STATUS, EXAMPLES, version number to xxhsum.1 Makefile - Add version number XXHSUM_VERSION - Add ronn's options to add version number xxhsum.1.md - Add `EXIT STATUS` and `EXAMPLE` section
2016-02-21 00:46:58 +00:00
.
.fi
.
.IP "" 0
.
.P
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
Read xxHash sums from specific files and check them
Add EXIT STATUS, EXAMPLES, version number to xxhsum.1 Makefile - Add version number XXHSUM_VERSION - Add ronn's options to add version number xxhsum.1.md - Add `EXIT STATUS` and `EXAMPLE` section
2016-02-21 00:46:58 +00:00
.
.IP "" 4
.
.nf
Revamp xxhsum.1
2016-02-21 14:26:31 +00:00
$ xxhsum \-c xyz\.xxh32 qux\.xxh64
Add EXIT STATUS, EXAMPLES, version number to xxhsum.1 Makefile - Add version number XXHSUM_VERSION - Add ronn's options to add version number xxhsum.1.md - Add `EXIT STATUS` and `EXAMPLE` section
2016-02-21 00:46:58 +00:00
.
.fi
.
.IP "" 0
.
Added : make install
2016-08-23 09:42:53 +00:00
.P
Benchmark xxHash algorithm for 16384 bytes data in 10 times\. \fBxxhsum\fR benchmarks xxHash algorithm for 32\-bit and 64\-bit and output results to standard output\. First column means algorithm, second column is source data size in bytes, last column means hash generation speed in mega\-bytes per seconds\.
.
.IP "" 4
.
.nf
$ xxhsum \-b \-i10 \-B16384
.
.fi
.
.IP "" 0
.
Add manpage files: xxhsum.1 and xxhsum.1.md You can generate xxhsum.1 by the following procedure: ``` sudo apt-get install -y ruby-ronn # make man generates xxhsum.1 from xxhsum.1.md # make man # edit xxhsum.1.md here # # auto preview for development make preview-man ``` `Makefile` has the following tricky part: ``` xxhsum.1: xxhsum.1.md cat $^ | $(MD2ROFF) $(MD2ROFF_FLAGS) | sed -n '/^\.\\\".*/!p' > $@ ``` Last `sed` command removes `ronn`'s comment lines (`ronn`'s version, author, URL). It doesn't mean disrespect for `ronn`. We need this removal because we must ignore `ronn`'s version to minimize diff.
2016-02-19 18:08:46 +00:00
.SH "BUGS"
Report bugs at: https://github\.com/Cyan4973/xxHash/issues/
.
.SH "AUTHOR"
Yann Collet
Added : make install
2016-08-23 09:42:53 +00:00
.
.SH "SEE ALSO"
md5sum(1)
Reference in New Issue Copy Permalink