mirror of
https://github.com/FEX-Emu/xxHash.git
synced 2024-12-02 19:46:49 +00:00
ddbed4c2a9
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.
50 lines
1.2 KiB
Groff
50 lines
1.2 KiB
Groff
.
|
|
.TH "XXHSUM" "1" "February 2016" "" ""
|
|
.
|
|
.SH "NAME"
|
|
\fBxxhsum\fR \- print or check xxHash checksums
|
|
.
|
|
.SH "SYNOPSIS"
|
|
\fBxxhsum\fR [\fIOPTION\fR] \.\.\. [\fIFILE\fR] \.\.\.
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Print or check xxHash (32 or 64bit) checksums\. When \fIFILE\fR is \fB\-\fR, read standard input\.
|
|
.
|
|
.P
|
|
\fBxxhsum\fR supports a command line syntax similar but not indentical to md5sum(1)\. Differences are: \fBxxhsum\fR doesn\'t have text/binary mode switch; \fBxxhsum\fR always treats file as binary file; \fBxxhsum\fR have hash bit width switch (\fB\-H\fR)\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.TP
|
|
\fB\-c\fR, \fB\-\-check\fR
|
|
Read xxHash sums from the \fIFILE\fRs and check them
|
|
.
|
|
.TP
|
|
\fB\-H\fR\fIHASHTYPE\fR
|
|
Hash selection\. \fIHASHTYPE\fR means \fB0\fR=32bits, \fB1\fR=64bits\. Default value is \fB1\fR (64bits)
|
|
.
|
|
.P
|
|
The following four options are useful only when verifying checksums (\fB\-c\fR)
|
|
.
|
|
.TP
|
|
\fB\-\-strict\fR
|
|
Don\'t print OK for each successfully verified file
|
|
.
|
|
.TP
|
|
\fB\-\-status\fR
|
|
Don\'t output anything, status code shows success
|
|
.
|
|
.TP
|
|
\fB\-\-quiet\fR
|
|
Exit non\-zero for improperly formatted checksum lines
|
|
.
|
|
.TP
|
|
\fB\-\-warn\fR
|
|
Warn about improperly formatted checksum lines
|
|
.
|
|
.SH "BUGS"
|
|
Report bugs at: https://github\.com/Cyan4973/xxHash/issues/
|
|
.
|
|
.SH "AUTHOR"
|
|
Yann Collet
|