aboutsummaryrefslogtreecommitdiffstats
path: root/libar2_latest_argon2_version.3
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_latest_argon2_version.3
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_latest_argon2_version.3')
-rw-r--r--libar2_latest_argon2_version.336
1 files changed, 36 insertions, 0 deletions
diff --git a/libar2_latest_argon2_version.3 b/libar2_latest_argon2_version.3
new file mode 100644
index 0000000..8a10d47
--- /dev/null
+++ b/libar2_latest_argon2_version.3
@@ -0,0 +1,36 @@
+.TH LIBAR2_LATEST_ARGON2_VERSION 7 LIBAR2
+.SH NAME
+libar2_latest_argon2_version - Highest support version of Argon2
+
+.SH SYNOPSIS
+.nf
+#include <libar2.h>
+
+enum libar2_argon2_version {
+ LIBAR2_ARGON2_VERSION_10 = 0x10,
+ LIBAR2_ARGON2_VERSION_13 = 0x13
+};
+
+extern const enum libar2_argon2_version libar2_latest_argon2_version;
+.fi
+.PP
+Link with
+.IR -lar2 .
+
+.SH DESCRIPTION
+The
+.B libar2_latest_argon2_version
+global, constant variable is set to the latest version of Argon2
+that is supported by the version of the libar2 library linked by
+the application. In the current version of libar2,
+.B libar2_latest_argon2_version
+is set to
+.IR LIBAR2_ARGON2_VERSION_13 ,
+which represents version 1.3, also called version 13, of the
+Argon2 family.
+
+.SH SEE ALSO
+.BR libar2 (7),
+.BR libar2_version_to_string (3),
+.BR libar2_version_to_string_proper (3),
+.BR libar2_string_to_version (3)