3 Commits

Author SHA1 Message Date
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