FEX-Emu/xxHash
1
0
Fork 0
mirror of https://github.com/FEX-Emu/xxHash.git synced 2024-12-13 17:26:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
f84201a652
xxHash/xxhsum.1.md

96 lines
2.2 KiB
Markdown
Raw Normal View History

Emphasis "xxHash is non-cryptographic algorithm" Scine all short description in xxHash github repository and github.io has "non-cryptographic", I added it for both short and long description in manpage.
2016-02-21 14:20:47 +00:00
xxhsum(1) -- 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
SYNOPSIS
--------
`xxhsum` [<OPTION>] ... [<FILE>] ...
DESCRIPTION
-----------
Print or check xxHash (32 or 64bit) checksums. When <FILE> is `-`, read
standard input.
`xxhsum` supports a command line syntax similar but not indentical to
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
md5sum(1). Differences are: `xxhsum` doesn't have text/binary mode switch
Add -w (alias of --warn)
2016-02-22 13:10:25 +00:00
(`-b`, `-t`); `xxhsum` always treats file as binary file; `xxhsum` has hash
bit width switch (`-H`);
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
Emphasis "xxHash is non-cryptographic algorithm" Scine all short description in xxHash github repository and github.io has "non-cryptographic", I added it for both short and long description in manpage.
2016-02-21 14:20:47 +00:00
Since xxHash is non-cryptographic checksum algorithm, `xxhsum` should not be
used any more for security related purposes.
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
OPTIONS
-------
Add option descriptions for b, B, h, V, --little-endian - -b and -B<BLOCKSIZE> are benchmark options - -h displays help - -V displays version - --little-endian sets hexadecimal display convension as little endian
2016-02-21 13:57:42 +00:00
* `-b`:
Benchmark mode
* `-B`<BLOCKSIZE>:
<BLOCKSIZE> specifies benchmark mode's test data block size in bytes.
Default value is 102400
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
* `-c`, `--check`:
Read xxHash sums from the <FILE>s and check them
Add --help and --version --help is alias of -h --version is alias of -V
2016-02-22 13:12:43 +00:00
* `-h`, `--help`:
Add option descriptions for b, B, h, V, --little-endian - -b and -B<BLOCKSIZE> are benchmark options - -h displays help - -V displays version - --little-endian sets hexadecimal display convension as little endian
2016-02-21 13:57:42 +00:00
Display help and exit
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
* `-H`<HASHTYPE>:
Hash selection. <HASHTYPE> means `0`=32bits, `1`=64bits.
Default value is `1` (64bits)
Add option descriptions for b, B, h, V, --little-endian - -b and -B<BLOCKSIZE> are benchmark options - -h displays help - -V displays version - --little-endian sets hexadecimal display convension as little endian
2016-02-21 13:57:42 +00:00
* `--little-endian`:
Set output hexadecimal checksum value as little endian convention.
By default, value is displayed as big endian
Add --help and --version --help is alias of -h --version is alias of -V
2016-02-22 13:12:43 +00:00
* `-V`, `--version`:
Add option descriptions for b, B, h, V, --little-endian - -b and -B<BLOCKSIZE> are benchmark options - -h displays help - -V displays version - --little-endian sets hexadecimal display convension as little endian
2016-02-21 13:57:42 +00:00
Display xxhsum version
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
**The following four options are useful only when verifying checksums (`-c`)**
* `--quiet`:
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
* `--strict`:
Don't print OK for each successfully verified file
* `--status`:
Don't output anything, status code shows success
Add -w (alias of --warn)
2016-02-22 13:10:25 +00:00
* `-w`, `--warn`:
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
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
EXIT STATUS
-----------
`xxhsum` exit `0` on success, `1` if at least one file couldn't be read or
doesn't have the same checksum as the `-c` option.
EXAMPLES
--------
Output xxHash (64bit) checksum values of specific files to standard output
$ xxhsum -H1 foo bar baz
Change example output file extension - Use .xxh32 for -H0, 32-bit xxHash - Use .xxh64 for -H1, 64-bit xxHash
2016-02-21 14:25:24 +00:00
Output xxHash (32bit and 64bit) checksum values of specific files to standard
output, and redirect it to `xyz.xxh32` and `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
Change example output file extension - Use .xxh32 for -H0, 32-bit xxHash - Use .xxh64 for -H1, 64-bit xxHash
2016-02-21 14:25:24 +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
Change example output file extension - Use .xxh32 for -H0, 32-bit xxHash - Use .xxh64 for -H1, 64-bit xxHash
2016-02-21 14:25:24 +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
Change example output file extension - Use .xxh32 for -H0, 32-bit xxHash - Use .xxh64 for -H1, 64-bit xxHash
2016-02-21 14:25:24 +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
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
BUGS
----
Report bugs at: https://github.com/Cyan4973/xxHash/issues/
AUTHOR
------
Yann Collet
Reference in New Issue Copy Permalink