Author: Adam <git@apiote.tk>
add man page
meowsum.1.scd | 46 ++++++++++++++++++++++++++++++++++++++++++++++ mkfile | 3 +++
diff --git a/meowsum.1.scd b/meowsum.1.scd new file mode 100644 index 0000000000000000000000000000000000000000..812747ae9a988b2ea90ba2e4217d7cc4c5bfd464 --- /dev/null +++ b/meowsum.1.scd @@ -0,0 +1,46 @@ +meowsum(1) + +# NAME + +meowsum — print or check Meow hash checksums + +# SYNOPSIS + +meowsum [-ceq] [FILE]... + +meowsum [-s size] [FILE]... + +# DESCRIPTION + +The meowsum utility calculates and prints or checks Meow hash checksums. +The output format is consistent with POSIX cksum; meowsum prints the checksum, +number of bytes, and file path to standard output. + +When FILE is -, meowsum reads standard input. + +# OPTIONS + +\-c read sums from the FILEs and check them++ +\-s size set hash size; size can be 32, 64, 128 bits;++ + the default is 128 + +The following options are useful only when verifying checksums:++ +\-q only return status; do not print OK, ERH, ERS, ERM++ +\-e fail for missing files + +# AUTHORS + +Maintained by Adam Pioterek <me@apiote.tk>. Up-to-date sources can be found at +https://git.apiote.tk/meowsum.git and bugs/patches can be submitted by email to +git+meowsum@apiote.tk. + +# COPYRIGHT + +Copyright © 2021 Adam Pioterek. License GPLv3+: GNU GPL version 3 or later +<https://gnu.org/licenses/gpl.html>. +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. + +# SEE ALSO + +Source code of Meow hash <https://github.com/cmuratori/meow_hash> diff --git a/mkfile b/mkfile index 917ebd282012976672706707df5a47583f650f0b..7de554800dc7f19f3366a357f07b0ba9b568224c 100644 --- a/mkfile +++ b/mkfile @@ -1,2 +1,5 @@ meowsum: meowsum.c clang -O3 -mavx -maes -pedantic -Wall -o meowsum meowsum.c + +meowsum.1: meowsum.1.scd + scdoc < meowsum.1.scd > meowsum.1