diff options
author | Scarlett <scarlett@entering.space> | 2016-02-20 18:24:06 +0300 |
---|---|---|
committer | Scarlett <scarlett@entering.space> | 2016-02-20 18:24:06 +0300 |
commit | a559faebbbbaaf87dd8aa460e36eb027333077ff (patch) | |
tree | fcf1c1321e3915dbace3ca19602fb665b0d4e139 | |
parent | d893a37d37632498af2e29c01fecde2d951b24f4 (diff) |
add and install b2sum man page, improve makefile portability
-rw-r--r-- | b2sum/b2sum.1 | 94 | ||||
-rw-r--r-- | b2sum/makefile | 20 |
2 files changed, 109 insertions, 5 deletions
diff --git a/b2sum/b2sum.1 b/b2sum/b2sum.1 new file mode 100644 index 0000000..43382b0 --- /dev/null +++ b/b2sum/b2sum.1 @@ -0,0 +1,94 @@ +.Dd February 20, 2016 +.Dt B2SUM 1 +.Os +.Sh NAME +.Nm b2sum +.Nd generate checksums using the BLAKE2 hash function +.Sh SYNOPSIS +.Nm +.Op Fl a Ar algorithm +.Op Fl l Ar length +.Op Fl -tag +.Op Ar file ... +.Nm +.Op Fl -help +.Sh DESCRIPTION +The +.Nm +command generates checksums for files using the BLAKE2 cryptographic +hash function and writes them to standard output. +.Pp +When +.Op Ar file ... +is empty or -, +.Nm +reads from standard input. +.Bl -tag -width Ar +.It Fl a Ar algorithm +Specify a variant of BLAKE2 to use when generating checksums. The +variants are listed under the algorithms section, and the default +is blake2b. +.It Fl l Ar length +Specify the digest length in bits. It must not exceed the maximum +for the variant of BLAKE2 being used, and must be a multiple of 8. +.It Fl -tag +Prepend the checksums with +.Qq "ALGORITHM-NAME (file) =" , +a format common on BSD systems. +.It Fl -help +Display usage. +.El +.Sh ALGORITHMS +.Bl -tag -width blake2xx +.It blake2b +optimized for 64-bit platforms and NEON-enabled ARMs, produces digests +of any size between 1 and 64 bytes +.It blake2s +optimized for 8 to 32-bit platforms, produces digests of any size +between 1 and 32 bytes +.It blake2bp +4-way parallel BLAKE2b +.It blake2sp +8-way parallel BLAKE2s +.El +.Sh SEE ALSO +.Xr shasum 1 +.Sh STANDARDS +.Bl -tag -width "RFC XXXX" +.It RFC 7693 +.\".Lk https://tools.ietf.org/rfc/rfc7693.txt RFC 7693 +The BLAKE2 Cryptographic Hash and Message Authentication Code +.El +.Sh AUTHORS +.Nm +is part of the +.Em BLAKE2 +official implementation. BLAKE2 was designed by +.An -nosplit +.An "Jean-Philippe Aumasson" , +.An "Samuel Neves" , +.An "Zooko Wilcox-O'Hearn" , and +.An "Christian Winnerlein" . +.Pp +BLAKE2 is based on the SHA-3 proposal +.Em BLAKE +which was designed by +.An "Jean-Philippe Aumasson" , +.An "Luca Henzen" , +.An "Willi Meier" , and +.An "Raphael C.-W. Phan" . +.Pp +BLAKE2, like BLAKE, relies on the +.Em ChaCha20 +stream cipher, designed by +.An Daniel J. Bernstein . +.Pp +A mailing list for BLAKE2 can be subscribed to by sending an empty +message to +.Mt info-subscribe@blake2.net . +.Pp +The four designers of BLAKE2 can be contacted at +.Mt contact@blake2.net . +.Pp +This manual page was written by +.Lk https://github.com/Scarletts Scarlett . diff --git a/b2sum/makefile b/b2sum/makefile index 5b79ee2..4c75924 100644 --- a/b2sum/makefile +++ b/b2sum/makefile @@ -1,10 +1,20 @@ -CC=gcc -CFLAGS=-std=c99 -O3 -march=native -I../sse -static -fopenmp +PROG=b2sum +PREFIX?=/usr/local +MANDIR?=$(PREFIX)/man +CC?=gcc +CFLAGS?=-O3 -march=native -static +CFLAGS+=-std=c99 -I../sse -fopenmp LIBS= #FILES=b2sum.c ../ref/blake2b-ref.c ../ref/blake2s-ref.c ../ref/blake2bp-ref.c ../ref/blake2sp-ref.c FILES=b2sum.c ../sse/blake2b.c ../sse/blake2s.c ../sse/blake2bp.c ../sse/blake2sp.c all: $(FILES) - $(CC) $(FILES) $(CFLAGS) $(LIBS) -o b2sum + $(CC) $(FILES) $(CFLAGS) $(LIBS) -o $(PROG) -clean: - rm -f b2sum +clean: + rm -f $(PROG) + +install: + install -d $(DESTDIR)$(PREFIX)/bin + install -d $(DESTDIR)$(MANDIR)/man1 + install -m 755 $(PROG) $(DESTDIR)$(PREFIX)/bin + install -m 644 b2sum.1 $(DESTDIR)$(MANDIR)/man1/$(PROG).1 |