cryptutils

alder32: Add alder32 manpage

Diffstat

1 files changed, 31 insertions, 0 deletions

diff --git a/man/alder32.1 b/man/alder32.1
new file mode 100644
index 0000000..c266432
--- /dev/null
+++ b/man/alder32.1
@@ -0,0 +1,31 @@
+.TH ALDER32 1 2020-08-14 "OMKOV cryptutils" "General Commands Manual"
+.SH NAME
+alder32 \(em compute the Alder-32 for a file
+.SH SYNOPSYS
+\fBalder32\fR [\fIfile\fR...]
+.SH DESCRIPTION
+Compute and print an Alder-32 for each input file, as well as the file size in
+bytes.
+.SH OPTIONS
+The following options are supported:
+.IP "\fB--help\fR" 8
+Display help information.
+.IP "\fB--version\fR" 8
+Display version information.
+.SH OPERANDS
+The following operand is supported:
+.IP "\fIfile\fR" 8
+A pathname of an input file. If no \fIfile\fR operands are specified, or
+\fIfile\fR is a '\fB-\fR', \fIalder32\fR will read from standard input.
+.SH EXIT STATUS
+The following exit values will be returned:
+.IP "\ 0" 8
+All files were processed successfully.
+.IP ">0" 8
+An error occurred.
+.SH COPYRIGHT
+.nf
+Copyright (C) 2020, Jakob Wakeling
+All rights reserved.
+OMKOV Permissive Licence (https://www.omkov.net/OLPE)
+.fi