Bug#820491: argon2: missing man page for argon2

[Luca BRUNO]

On Friday, April 08, 2016 10:39:04 PM Daniel Kahn Gillmor wrote:
 
> argon2 is missing a manpage, and it doesn't respond well to the usual
> -h or --help (it treats those as an attempted salt).

Usage is printed when no arguments are passed.
I agree this is not very intuitive, will propose upstream if they are ok with 
using -h for help and moving hash length to -l.
 
> The attached patch (which i'll push to collab-maint shortly) fixes the
> problem.  I'd be happy if they want to adopt this upstream, but i am
> not in touch with upstream.  Feel free to forward it to them!

I've see all your commits, thanks for it (and for sticking to CC0).
I'll forward the manpage and a couple of other bits to upstream.
A new upload will follow soon, I've just have another small change to land 
before that. 

Cheers, Luca

-- 
 .''`.  ** Debian GNU/Linux **  | Luca Bruno (kaeso)
: :'  :   The Universal O.S.| lucab (AT) debian.org
`. `'`  | GPG: 0xBB1A3A854F3BBEBF
  `- http://www.debian.org  | Debian GNU/Linux Developer


signature.asc
Description: This is a digitally signed message part.

Bug#820491: argon2: missing man page for argon2

[Daniel Kahn Gillmor]

Package: argon2
Version: 0~20160406-1
Severity: normal
Tags: upstream patch

argon2 is missing a manpage, and it doesn't respond well to the usual
-h or --help (it treats those as an attempted salt).

The attached patch (which i'll push to collab-maint shortly) fixes the
problem.  I'd be happy if they want to adopt this upstream, but i am
not in touch with upstream.  Feel free to forward it to them!

Thanks for packaging argon2 for debian!

   --dkg

-- System Information:
Debian Release: stretch/sid
  APT prefers unstable-debug
  APT policy: (500, 'unstable-debug'), (500, 'testing'), (200, 'unstable'), (1, 
'experimental-debug'), (1, 'experimental')
Architecture: amd64 (x86_64)
Foreign Architectures: i386

Kernel: Linux 4.4.0-1-amd64 (SMP w/4 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)

Versions of packages argon2 depends on:
ii  libc6  2.22-5

argon2 recommends no packages.

argon2 suggests no packages.

-- debconf-show failed
diff --git a/debian/argon2.1 b/debian/argon2.1
new file mode 100644
index 000..f8a811f
--- /dev/null
+++ b/debian/argon2.1
@@ -0,0 +1,47 @@
+.TH ARGON2 "1" "April 2016" "argon2 " "User Commands"
+
+.SH NAME
+argon2 \- generate argon2 hashes
+
+.SH SYNOPSIS
+.B argon2 salt
+.RB [ OPTIONS ]
+
+.SH DESCRIPTION
+Generate Argon2 hashes from the command line.
+
+The supplied salt (the first argument to the command) must be at least
+8 octets in length, and the password is supplied on standard input.
+
+By default, this uses Argon2i, the variant where memory access is
+indepedent of secret data.  This is the correct variant to use for
+password hashing.
+
+.SH OPTIONS
+.TP
+.B \-d
+Use Argon2d instead of Argon2i (Argon2i is the default)
+.TP
+.BI \-t " N"
+Sets the number of iterations to N (default = 3)
+.TP
+.BI \-m " N"
+Sets the memory usage of 2^N KiB (default = 12)
+.TP
+.BI \-p " N"
+Sets parallelism to N threads (default = 1)
+.TP
+.BI \-h " N"
+Sets hash output length to N bytes (default = 32)
+.TP
+.B \-e
+Output only encoded hash
+.TP
+.B \-r
+Output only the raw bytes of the hash
+
+.SH COPYRIGHT
+This manpage was written by \fBDaniel Kahn Gillmor\fR for the Debian
+distribution (but may be used by others).  It is released, like the
+rest of this Argon2 implementation, under the terms of Creative
+Commons 0 (CC0)
diff --git a/debian/argon2.manpages b/debian/argon2.manpages
new file mode 100644
index 000..39ab410
--- /dev/null
+++ b/debian/argon2.manpages
@@ -0,0 +1 @@
+debian/argon2.1
diff --git a/debian/copyright b/debian/copyright
index dba1b93..3ac2cb3 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -22,6 +22,10 @@ Files: debian/*
 Copyright: 2016, Luca Bruno 
 License: CC0
 
+Files: debian/argon2.1
+Copyright: 2016, Daniel Kahn Gillmor 
+License: CC0
+
 License: CC0
  /Statement of Purpose/
  .
diff --git a/debian/argon2.1 b/debian/argon2.1
new file mode 100644
index 000..f8a811f
--- /dev/null
+++ b/debian/argon2.1
@@ -0,0 +1,47 @@
+.TH ARGON2 "1" "April 2016" "argon2 " "User Commands"
+
+.SH NAME
+argon2 \- generate argon2 hashes
+
+.SH SYNOPSIS
+.B argon2 salt
+.RB [ OPTIONS ]
+
+.SH DESCRIPTION
+Generate Argon2 hashes from the command line.
+
+The supplied salt (the first argument to the command) must be at least
+8 octets in length, and the password is supplied on standard input.
+
+By default, this uses Argon2i, the variant where memory access is
+indepedent of secret data.  This is the correct variant to use for
+password hashing.
+
+.SH OPTIONS
+.TP
+.B \-d
+Use Argon2d instead of Argon2i (Argon2i is the default)
+.TP
+.BI \-t " N"
+Sets the number of iterations to N (default = 3)
+.TP
+.BI \-m " N"
+Sets the memory usage of 2^N KiB (default = 12)
+.TP
+.BI \-p " N"
+Sets parallelism to N threads (default = 1)
+.TP
+.BI \-h " N"
+Sets hash output length to N bytes (default = 32)
+.TP
+.B \-e
+Output only encoded hash
+.TP
+.B \-r
+Output only the raw bytes of the hash
+
+.SH COPYRIGHT
+This manpage was written by \fBDaniel Kahn Gillmor\fR for the Debian
+distribution (but may be used by others).  It is released, like the
+rest of this Argon2 implementation, under the terms of Creative
+Commons 0 (CC0)
diff --git a/debian/argon2.manpages b/debian/argon2.manpages
new file mode 100644
index 000..39ab410
--- /dev/null
+++ b/debian/argon2.manpages
@@ -0,0 +1 @@
+debian/argon2.1
diff --git a/debian/copyright b/debian/copyright
index dba1b93..3ac2cb3 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -22,6 +22,10 @@ Files: debian/*
 Copyright: 2016, Luca Bruno 
 License: CC0
 
+Files: debian/argon2.1
+Copyright: 2016, Daniel Kahn Gillmor 
+License: CC0
+
 License: CC0
  /Statement of Purpose/
  .