Commit Graph

20 Commits

Author SHA1 Message Date
Yann Collet
820c89cc9f Allow reading stdin in console mode
when `stdin` is requested explicitly,
with `xxhsum -`.

updated man page
2020-07-17 21:20:18 -07:00
Wayne Davison
5ffd33ef3a Add the ability to parse BSD style --check lines. 2020-07-05 15:49:48 -07:00
Yann Collet
c5867346ee bench: can select multiple variants
using comma separated IDs
2020-06-12 15:07:20 -07:00
Yann Collet
57377539bf can select multiple variants to benchmark
For example, `xxhsum -b1 -b2` will benchmark XXH32 in both aligned and unaligned mode.

Also : modified default list,
now only test main variants (XXH32, XXH64, XXH3 and XXH128).

Also : -bi0 makes it possible to generate a very quick (though inaccurate) evaluation.
2020-06-12 14:52:46 -07:00
Witold Baryluk
43deef25ce
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 11:43:41 -07:00
easyaspi314 (Devin)
9eb91a3b53 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 15:20:49 -05:00
Yann Collet
549c24d09a updated man page
so that it better reflects advanced functionalities.
fix #286
Reported by @LEARAX
2019-12-27 15:21:26 -08:00
Yann Collet
c6ea1d2107 updated man page regarding -q 2019-10-07 08:34:39 -07:00
Yann Collet
ea5c659701 update man page 2019-09-28 17:55:41 -07:00
Eric Engestrom
cf41292097 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 18:50:22 +01:00
Jeremy C. Reed
e58063424a few typo fixes in comments or docs 2016-10-26 09:47:53 -05:00
Yann Collet
76104cf2cb Added : make install 2016-08-23 11:42:53 +02:00
Takayuki MATSUOKA
03dee591df Tweak manpage structure
- Add "xxhsum -b" in SYNOPSIS and DESCRIPTION
 - Add example for "xxhsum -b" in EXAMPLES
 - Add "SEE ALSO"
2016-02-23 14:13:38 +09:00
Takayuki MATSUOKA
45c322c8ac Add --help and --version
--help is alias of -h
--version is alias of -V
2016-02-22 22:12:43 +09:00
Takayuki MATSUOKA
7d17c88dec Add -w (alias of --warn) 2016-02-22 22:10:25 +09:00
Takayuki MATSUOKA
08d61a117d Change example output file extension
- Use .xxh32 for -H0, 32-bit xxHash
 - Use .xxh64 for -H1, 64-bit xxHash
2016-02-21 23:25:24 +09:00
Takayuki MATSUOKA
acb925f1e1 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 23:20:47 +09:00
Takayuki MATSUOKA
9523b75b40 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 22:57:42 +09:00
Takayuki MATSUOKA
96abe78db9 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 09:46:58 +09:00
Takayuki MATSUOKA
ddbed4c2a9 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-20 03:08:46 +09:00