diff options
| -rw-r--r-- | DEPENDENCIES | 4 | ||||
| -rw-r--r-- | Makefile | 24 | ||||
| -rw-r--r-- | TODO | 2 | ||||
| -rw-r--r-- | doc/xsum.texman | 80 |
4 files changed, 108 insertions, 2 deletions
diff --git a/DEPENDENCIES b/DEPENDENCIES index 9c9551f..c12da92 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -3,4 +3,8 @@ https://github.com/maandree/argparser https://github.com/maandree/auto-auto-complete (make) https://github.com/maandree/texman/blob/master/texman.texman (make) libc +make (make) +coreutil (make) +gcc (make) +sed (make) @@ -27,13 +27,27 @@ CMDS = keccak-224sum keccak-256sum keccak-384sum keccak-512sum keccaksum \ sha3-224sum sha3-256sum sha3-384sum sha3-512sum \ rawshake256sum rawshake512sum shake256sum shake512sum +keccak-224sum = Keccak-224 +keccak-256sum = Keccak-256 +keccak-384sum = Keccak-384 +keccak-512sum = Keccak-512 +keccaksum = Keccak[] +sha3-224sum = SHA3-224 +sha3-256sum = SHA3-256 +sha3-384sum = SHA3-384 +sha3-512sum = SHA3-512 +rawshake256sum = RawSHAKE256 +rawshake512sum = RawSHAKE512 +shake256sum = SHAKE256 +shake512sum = SHAKE512 + .PHONY: default default: command shell .PHONY: all -all: command shell +all: command shell man .PHONY: command @@ -73,6 +87,14 @@ bin/%.fish: src/completion auto-auto-complete fish --output $@ --source $< command=$* +.PHONY: man +man: $(foreach C,$(CMDS),bin/$(C).1) + +bin/%.1: doc/xsum.texman + @mkdir -p bin + cat $< | sed -e 's/xsum/$*/g' -e 's/XSUM/$($*)/g' | texman > $@ + + .PHONY: clean clean: @@ -1,2 +1,2 @@ -write manuals +write info manual diff --git a/doc/xsum.texman b/doc/xsum.texman new file mode 100644 index 0000000..216b758 --- /dev/null +++ b/doc/xsum.texman @@ -0,0 +1,80 @@ +@c -*- texinfo -*- +@texman{xsum}{1}{November 14 2014} + +@section Name +xsum - compute and check XSUM message digests + +@section Synopsis +@b{xsum} [option...] [--] [file...] + +@section Description +Print or check XSUM checksums. If no file +or when the file is -, read standard input. + +@item @b{-h}, @b{--help} +Display option summary. + +@item @b{-u}, @b{--upper}, @b{--uppercase}, @b{--upper-case} +Output checksums in upper-case hexadecimal representation. (default) + +@item @b{-l}, @b{--lower}, @b{--lowercase}, @b{--lower-case} +Output checksums in lower-case hexadecimal representation. + +@item @b{-b}, @b{--binary} +Output checksums in binary representation. This suppresses +the filenames and checksum delimiters. Only the checksums +are printed. + +@item @b{-x}, @b{--hex}, @b{--hex-input} +Convert input files from hexadecimal for to binary form +before calculating the checksums. + +@item @b{-c}, @b{--check} +Read XSUM sums from the file and check them against +the files on your systems. The input files files +should be formated as the output of this program, or +similarly. This is not going to work if any of the +filenames in the input files starts with a regular +blank space or horizontal tab space, or if they +contain a line feed, carriage return or form feed. + +@item @b{-v}, @b{--verbose} +Print the hashing parameters. + +@item The following options change the hashing parameters: + +@item @b{-R}, @b{--bitrate}, @b{--rate} RATE +Change the rate. + +@item @b{-C}, @b{--capacity} CAPACITY +Change the capacity. + +@item @b{-N}, @b{-O}, @b{--output-size}, @b{--output} SIZE +Change the output size. + +@item @b{-S}, @b{-B}, @b{--state-size}, @b{--state} SIZE +Change the state size. + +@item @b{-W}, @b{--word-size}, @b{--word} SIZE +Change the word size. + +@item @b{-Z}, @b{--squeezes} COUNT +Change the number of squeezes that is performed. + + +@section Author + +Written by Mattias Andrée. + + +@section Note + +All commands in the sha3sum package allow changing +the hashing parameters. However it is only intended +to be used with @b{keccaksum}, or if you know what you +are doing; apart from @b{--output} which is intended +to @emph{always} be used with @b{shake256sum}, +@b{shake512sum}, @b{rawshake256sum} and @b{rawshake512sum}. + +@bye + |