aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-14 12:34:09 +0200
committerMattias Andrée <maandree@kth.se>2017-10-14 12:34:09 +0200
commitd05f019228aa6993f1cbab2029edab5ae7f2643e (patch)
tree38ee8b0898de719a046a7264b72968ab8ef1b414
parentSimplify makefile (diff)
downloadsha3sum-d05f019228aa6993f1cbab2029edab5ae7f2643e.tar.gz
sha3sum-d05f019228aa6993f1cbab2029edab5ae7f2643e.tar.bz2
sha3sum-d05f019228aa6993f1cbab2029edab5ae7f2643e.tar.xz
Update readme
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--README76
1 files changed, 37 insertions, 39 deletions
diff --git a/README b/README
index 9b8207b..c62a963 100644
--- a/README
+++ b/README
@@ -2,19 +2,19 @@ NAME
sha3sum - Keccak, SHA-3, SHAKE, and RawSHAKE checksum utilities
SYNOPSIS
- keccaksum [OPTION]... [--] [FILE]...
- keccak-224sum [OPTION]... [--] [FILE]...
- keccak-256sum [OPTION]... [--] [FILE]...
- keccak-384sum [OPTION]... [--] [FILE]...
- keccak-512sum [OPTION]... [--] [FILE]...
- sha3-224sum [OPTION]... [--] [FILE]...
- sha3-256sum [OPTION]... [--] [FILE]...
- sha3-384sum [OPTION]... [--] [FILE]...
- sha3-512sum [OPTION]... [--] [FILE]...
- shake256sum [OPTION]... [--] [FILE]...
- shake512sum [OPTION]... [--] [FILE]...
- rawshake256sum [OPTION]... [--] [FILE]...
- rawshake512sum [OPTION]... [--] [FILE]...
+ keccaksum [option ...] [file ...]
+ keccak-224sum [option ...] [file ...]
+ keccak-256sum [option ...] [file ...]
+ keccak-384sum [option ...] [file ...]
+ keccak-512sum [option ...] [file ...]
+ sha3-224sum [option ...] [file ...]
+ sha3-256sum [option ...] [file ...]
+ sha3-384sum [option ...] [file ...]
+ sha3-512sum [option ...] [file ...]
+ shake256sum [option ...] [file ...]
+ shake512sum [option ...] [file ...]
+ rawshake256sum [option ...] [file ...]
+ rawshake512sum [option ...] [file ...]
DESCRIPTION
Fully configurable byte-orientated checksum utilities
@@ -31,44 +31,42 @@ DESCRIPTION
of hashes are returned identically by sha3sum.
OPTIONS
- -h, --help
- Display option summary.
- -R, --rate RATE
- Select rate.
+ -u
+ Use upper-case output.
- -C, --capacity CAPACITY
- Select capacity.
+ -l
+ Use lower-case output.
- -N, --output SIZE
- Select output size.
+ -b
+ Use binary output.
- -S, --state SIZE
- Select state size.
+ -c
+ Check checksums.
- -W, --word SIZE
- Select word size.
+ -x
+ Use hexadecimal input.
- -Z, --squeezes COUNT
- Select squeeze count.
+ -v
+ Be verbose.
- -u, --upper-case
- Use upper-case output.
+ -R rate
+ Select rate.
- -l, --lower-case
- Use lower-case output.
+ -C capacity
+ Select capacity.
- -b, --binary
- Use binary output.
+ -N, -O output-size
+ Select output size.
- -x, --hex-input
- Use hexadecimal input.
+ -S, -B state-size
+ Select state size.
- -c, --check
- Check checksums.
+ -W word-size
+ Select word size.
- -v, --verbose
- Be verbose.
+ -Z squeeze-count
+ Select squeeze count.
RATIONALE
We probably do not need this, but it is nice to have