aboutsummaryrefslogtreecommitdiffstats
path: root/libar2.7
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2022-02-12 16:16:47 +0100
committerMattias Andrée <maandree@kth.se>2022-02-12 16:16:56 +0100
commit3aa9f7176fcb50386967e89653272af7fb7cf3c5 (patch)
tree7bade092a2e263bda67634d03f579578c2c53101 /libar2.7
parentMake libar2_latest_argon2_version const (diff)
downloadlibar2-3aa9f7176fcb50386967e89653272af7fb7cf3c5.tar.gz
libar2-3aa9f7176fcb50386967e89653272af7fb7cf3c5.tar.bz2
libar2-3aa9f7176fcb50386967e89653272af7fb7cf3c5.tar.xz
Add man pages, readme, and nonnull attributes and fix documentation typos
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'libar2.7')
-rw-r--r--libar2.728
1 files changed, 28 insertions, 0 deletions
diff --git a/libar2.7 b/libar2.7
new file mode 100644
index 0000000..7b772be
--- /dev/null
+++ b/libar2.7
@@ -0,0 +1,28 @@
+.TH LIBAR2 7 LIBAR2
+.SH NAME
+libar2 - Library for the Argon2-family of hashing functions
+
+.SH DESCRIPTION
+.BR libar2
+is a C library that implements the family of Argon2
+key derivation function, including Argon2d, Argon2i,
+and Argon2id, as well as Argon2ds which was not part
+of the submission to the Password Hashing Competition
+of 2013, which Argon2 won in 2015. As a key derivation
+function, Argon2 is well-suited for cryptographically
+hashing (one-way encrypting) passwords.
+
+.SH SEE ALSO
+.BR libar2_decode_base64 (3),
+.BR libar2_decode_params (3),
+.BR libar2_encode_base64 (3),
+.BR libar2_encode_params (3),
+.BR libar2_erase (3),
+.BR libar2_hash (3),
+.BR libar2_latest_argon2_version (3),
+.BR libar2_string_to_type (3),
+.BR libar2_string_to_version (3),
+.BR libar2_type_to_string (3),
+.BR libar2_validate_params (3),
+.BR libar2_version_to_string (3),
+.BR libar2_version_to_string_proper (3)