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

131 lines
3.5 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.1.md: make arguments part of the command This unhides the arguments, as the `<>` were making them be interpreted as html.
2017-07-29 17:50:22 +00:00
`xxhsum [<OPTION>] ... [<FILE>] ...`
`xxhsum -b [<OPTION>] ...`
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
`xxh32sum` is equivalent to `xxhsum -H0`
update man page
2019-09-29 00:55:41 +00:00
`xxh64sum` is equivalent to `xxhsum -H1`
`xxh128sum` is equivalent to `xxhsum -H2`
Added : make install
2016-08-23 09:42:53 +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
DESCRIPTION
-----------
update man page
2019-09-29 00:55:41 +00:00
Print or check xxHash (32, 64 or 128 bits) checksums. When <FILE> is `-`, read
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
standard input.
few typo fixes in comments or docs
2016-10-26 14:47:53 +00:00
`xxhsum` supports a command line syntax similar but not identical to
Added : make install
2016-08-23 09:42:53 +00:00
md5sum(1). Differences are:
`xxhsum` doesn't have text/binary mode switch (`-b`, `-t`);
Let the Great Typo Hunt commence! Work in progress. - Fix many spelling/grammar issues, primarily in comments - Remove most spaces before punctuation - Update XXH3 comment - Wrap most comments to 80 columns - Unify most comments to use the same style - Use hexadecimal in the xxhash spec - Update help messages to better match POSIX/GNU conventions - Use HTML escapes in README.md to avoid UTF-8 - Mark outdated benchmark/scores
2020-03-02 20:20:49 +00:00
`xxhsum` always treats files as binary file;
`xxhsum` has a 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
Added : make install
2016-08-23 09:42:53 +00:00
As xxHash is a fast non-cryptographic checksum algorithm,
`xxhsum` should not be used for security related purposes.
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
Tweak manpage structure - Add "xxhsum -b" in SYNOPSIS and DESCRIPTION - Add example for "xxhsum -b" in EXAMPLES - Add "SEE ALSO"
2016-02-23 05:13:38 +00:00
`xxhsum -b` invokes benchmark mode. See [OPTIONS](#OPTIONS) and [EXAMPLES](#EXAMPLES) for details.
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
-------
Added : make install
2016-08-23 09:42:53 +00:00
* `-V`, `--version`:
Let the Great Typo Hunt commence! Work in progress. - Fix many spelling/grammar issues, primarily in comments - Remove most spaces before punctuation - Update XXH3 comment - Wrap most comments to 80 columns - Unify most comments to use the same style - Use hexadecimal in the xxhash spec - Update help messages to better match POSIX/GNU conventions - Use HTML escapes in README.md to avoid UTF-8 - Mark outdated benchmark/scores
2020-03-02 20:20:49 +00:00
Displays xxhsum version and exits
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
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>:
Let the Great Typo Hunt commence! Work in progress. - Fix many spelling/grammar issues, primarily in comments - Remove most spaces before punctuation - Update XXH3 comment - Wrap most comments to 80 columns - Unify most comments to use the same style - Use hexadecimal in the xxhash spec - Update help messages to better match POSIX/GNU conventions - Use HTML escapes in README.md to avoid UTF-8 - Mark outdated benchmark/scores
2020-03-02 20:20:49 +00:00
Hash selection. <HASHTYPE> means `0`=32bits, `1`=64bits, `2`=128bits.
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
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.
Added : make install
2016-08-23 09:42:53 +00:00
By default, value is displayed as big endian.
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
Added : make install
2016-08-23 09:42:53 +00:00
* `-h`, `--help`:
Let the Great Typo Hunt commence! Work in progress. - Fix many spelling/grammar issues, primarily in comments - Remove most spaces before punctuation - Update XXH3 comment - Wrap most comments to 80 columns - Unify most comments to use the same style - Use hexadecimal in the xxhash spec - Update help messages to better match POSIX/GNU conventions - Use HTML escapes in README.md to avoid UTF-8 - Mark outdated benchmark/scores
2020-03-02 20:20:49 +00:00
Displays help and exits
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
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`)**
updated man page so that it better reflects advanced functionalities. fix #286 Reported by @LEARAX
2019-12-27 23:21:26 +00:00
* `-c`, `--check` <FILE>:
Read xxHash sums from <FILE> and check them
Added : make install
2016-08-23 09:42:53 +00:00
updated man page so that it better reflects advanced functionalities. fix #286 Reported by @LEARAX
2019-12-27 23:21:26 +00:00
* `-q`, `--quiet`:
Remove "Loading..." from source (#373) * Remove --quiet and "Loading ..." from manpage * Remove "Loading ..." from markdown manpage * Removing "Loading..." from code * Update tests for "Loading..." * Remove the remaining "Loading..." from source Forgot about this one * Test error message on non-existing file * Fix a typo in a test (xxhsum vs ./xxhsum) * Fix a typo for real. noneexistent -> nonexistent Tested.
2020-05-27 18:43:41 +00:00
Don't print OK for each successfully verified file
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`:
updated man page so that it better reflects advanced functionalities. fix #286 Reported by @LEARAX
2019-12-27 23:21:26 +00:00
Return an error code if any line in the file is invalid,
not just if some checksums are wrong.
This policy is disabled by default,
though UI will prompt an informational message
if any line in the file is detected invalid.
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
* `--status`:
updated man page so that it better reflects advanced functionalities. fix #286 Reported by @LEARAX
2019-12-27 23:21:26 +00:00
Don't output anything. Status code shows success.
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
Add -w (alias of --warn)
2016-02-22 13:10:25 +00:00
* `-w`, `--warn`:
updated man page so that it better reflects advanced functionalities. fix #286 Reported by @LEARAX
2019-12-27 23:21:26 +00:00
Emit a warning message about each improperly formatted checksum line.
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
Tweak manpage structure - Add "xxhsum -b" in SYNOPSIS and DESCRIPTION - Add example for "xxhsum -b" in EXAMPLES - Add "SEE ALSO"
2016-02-23 05:13:38 +00:00
**The following options are useful only benchmark purpose**
* `-b`:
Benchmark mode. See [EXAMPLES](#EXAMPLES) for details.
* `-B`<BLOCKSIZE>:
Only useful for benchmark mode (`-b`). See [EXAMPLES](#EXAMPLES) for details.
<BLOCKSIZE> specifies benchmark mode's test data block size in bytes.
Default value is 102400
* `-i`<ITERATIONS>:
Only useful for benchmark mode (`-b`). See [EXAMPLES](#EXAMPLES) for details.
<ITERATIONS> specifies number of iterations in benchmark. Single iteration
update man page
2019-09-29 00:55:41 +00:00
lasts approximately 1000 milliseconds. Default value is 3
Tweak manpage structure - Add "xxhsum -b" in SYNOPSIS and DESCRIPTION - Add example for "xxhsum -b" in EXAMPLES - Add "SEE ALSO"
2016-02-23 05:13:38 +00:00
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
Tweak manpage structure - Add "xxhsum -b" in SYNOPSIS and DESCRIPTION - Add example for "xxhsum -b" in EXAMPLES - Add "SEE ALSO"
2016-02-23 05:13:38 +00:00
Benchmark xxHash algorithm for 16384 bytes data in 10 times. `xxhsum`
update man page
2019-09-29 00:55:41 +00:00
benchmarks all xxHash variants and output results to standard output.
Let the Great Typo Hunt commence! Work in progress. - Fix many spelling/grammar issues, primarily in comments - Remove most spaces before punctuation - Update XXH3 comment - Wrap most comments to 80 columns - Unify most comments to use the same style - Use hexadecimal in the xxhash spec - Update help messages to better match POSIX/GNU conventions - Use HTML escapes in README.md to avoid UTF-8 - Mark outdated benchmark/scores
2020-03-02 20:20:49 +00:00
The first column is the algorithm, thw second column is the source data
size in bytes, the third column is the number of hashes generated per
second (throughput), and finally the last column translates speed in
megabytes per second.
Tweak manpage structure - Add "xxhsum -b" in SYNOPSIS and DESCRIPTION - Add example for "xxhsum -b" in EXAMPLES - Add "SEE ALSO"
2016-02-23 05:13:38 +00:00
$ xxhsum -b -i10 -B16384
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
Tweak manpage structure - Add "xxhsum -b" in SYNOPSIS and DESCRIPTION - Add example for "xxhsum -b" in EXAMPLES - Add "SEE ALSO"
2016-02-23 05:13:38 +00:00
SEE ALSO
--------
md5sum(1)
Reference in New Issue Copy Permalink