]> gitweb.factorcode.org Git - factor.git/commitdiff
openssl: docs
authorBjörn Lindqvist <bjourne@gmail.com>
Sat, 1 Jul 2017 11:50:29 +0000 (13:50 +0200)
committerBjörn Lindqvist <bjourne@gmail.com>
Sat, 1 Jul 2017 11:50:29 +0000 (13:50 +0200)
basis/openssl/openssl-docs.factor [new file with mode: 0644]

diff --git a/basis/openssl/openssl-docs.factor b/basis/openssl/openssl-docs.factor
new file mode 100644 (file)
index 0000000..9930fa1
--- /dev/null
@@ -0,0 +1,18 @@
+USING: help.markup help.syntax ;
+IN: openssl
+
+HELP: maybe-init-ssl
+{ $description "Word that initializes openssl if it isn't already initialized." }
+{ $see-also ssl-initialized? } ;
+
+HELP: ssl-initialized?
+{ $var-description "Boolean that is " { $link t } " after ssl has been initialized." } ;
+
+HELP: ssl-new-api?
+{ $var-description "Boolean that is " { $link t } " if the detected libssl version is 1.1.0 or greater." } ;
+
+ARTICLE: "openssl" "OpenSSL Binding"
+"The " { $vocab-link "openssl" } " vocab and its subvocabs implements bindings for the libssl and libcrypto SSL libraries. Variables:"
+{ $subsections ssl-initialized? ssl-new-api? } ;
+
+ABOUT: "openssl"