From ab3d9838cd88981b4d7ca54f06b8f7d2227f61b9 Mon Sep 17 00:00:00 2001 From: Charlie Root Date: Fri, 11 Jul 2014 04:14:48 -0600 Subject: wording changes and initial stab at crypto man pages. still need to get man links working and ssl and apps man pages added. --- .gitignore | 1 + COPYING | 7 ++ Makefile.am | 2 +- configure.ac | 2 +- man/Makefile.am | 202 ++++++++++++++++++++++++++++++++++++++++++++++++++++ man/Makefile.am.tpl | 2 + update.sh | 15 +++- 7 files changed, 227 insertions(+), 4 deletions(-) create mode 100644 man/Makefile.am create mode 100644 man/Makefile.am.tpl diff --git a/.gitignore b/.gitignore index daeedcd..f80d75a 100644 --- a/.gitignore +++ b/.gitignore @@ -171,3 +171,4 @@ crypto/x509/ crypto/x509v3/ openbsd/ .gitmodules +ChangeLog diff --git a/COPYING b/COPYING index e47d101..fa970f9 100644 --- a/COPYING +++ b/COPYING @@ -1,4 +1,11 @@ + LibReSSL files are retained under the copyright of the authors. New + additions are ISC licensed as per OpenBSD's normal licensing policy, + or are placed in the public domain. + + The OpenSSL code is distributed under the terms of the original OpenSSL + licenses which follow: + LICENSE ISSUES ============== diff --git a/Makefile.am b/Makefile.am index 2cae3f8..bec672c 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,2 +1,2 @@ -SUBDIRS = crypto ssl include apps tests +SUBDIRS = crypto ssl include apps tests man ACLOCAL_AMFLAGS = -I m4 diff --git a/configure.ac b/configure.ac index e21bc47..fa7ef6b 100644 --- a/configure.ac +++ b/configure.ac @@ -95,4 +95,4 @@ AC_CHECK_FUNC(funopen, AC_DEFINE(HAVE_FUNOPEN)) LT_INIT AC_OUTPUT(Makefile include/Makefile include/openssl/Makefile ssl/Makefile - crypto/Makefile tests/Makefile apps/Makefile) + crypto/Makefile tests/Makefile apps/Makefile man/Makefile) diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..68216dd --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,202 @@ +include $(top_srcdir)/Makefile.am.common +man_MAN= +man_MAN += ASN1_OBJECT_new.3 +man_MAN += ASN1_STRING_length.3 +man_MAN += ASN1_STRING_new.3 +man_MAN += ASN1_STRING_print_ex.3 +man_MAN += ASN1_generate_nconf.3 +man_MAN += BF_set_key.3 +man_MAN += BIO.3 +man_MAN += BIO_ctrl.3 +man_MAN += BIO_f_base64.3 +man_MAN += BIO_f_buffer.3 +man_MAN += BIO_f_cipher.3 +man_MAN += BIO_f_md.3 +man_MAN += BIO_f_null.3 +man_MAN += BIO_find_type.3 +man_MAN += BIO_new.3 +man_MAN += BIO_new_CMS.3 +man_MAN += BIO_push.3 +man_MAN += BIO_read.3 +man_MAN += BIO_s_accept.3 +man_MAN += BIO_s_bio.3 +man_MAN += BIO_s_connect.3 +man_MAN += BIO_s_fd.3 +man_MAN += BIO_s_file.3 +man_MAN += BIO_s_mem.3 +man_MAN += BIO_s_null.3 +man_MAN += BIO_s_socket.3 +man_MAN += BIO_set_callback.3 +man_MAN += BIO_should_retry.3 +man_MAN += BN_BLINDING_new.3 +man_MAN += BN_CTX_new.3 +man_MAN += BN_CTX_start.3 +man_MAN += BN_add.3 +man_MAN += BN_add_word.3 +man_MAN += BN_bn2bin.3 +man_MAN += BN_cmp.3 +man_MAN += BN_copy.3 +man_MAN += BN_generate_prime.3 +man_MAN += BN_mod_inverse.3 +man_MAN += BN_mod_mul_montgomery.3 +man_MAN += BN_mod_mul_reciprocal.3 +man_MAN += BN_new.3 +man_MAN += BN_num_bytes.3 +man_MAN += BN_rand.3 +man_MAN += BN_set_bit.3 +man_MAN += BN_swap.3 +man_MAN += BN_zero.3 +man_MAN += BUF_MEM_new.3 +man_MAN += CMS_add0_cert.3 +man_MAN += CMS_add1_recipient_cert.3 +man_MAN += CMS_compress.3 +man_MAN += CMS_decrypt.3 +man_MAN += CMS_encrypt.3 +man_MAN += CMS_final.3 +man_MAN += CMS_get0_RecipientInfos.3 +man_MAN += CMS_get0_SignerInfos.3 +man_MAN += CMS_get0_type.3 +man_MAN += CMS_get1_ReceiptRequest.3 +man_MAN += CMS_sign.3 +man_MAN += CMS_sign_add1_signer.3 +man_MAN += CMS_sign_receipt.3 +man_MAN += CMS_uncompress.3 +man_MAN += CMS_verify.3 +man_MAN += CMS_verify_receipt.3 +man_MAN += CONF_modules_free.3 +man_MAN += CONF_modules_load_file.3 +man_MAN += CRYPTO_set_ex_data.3 +man_MAN += CRYPTO_set_locking_callback.3 +man_MAN += DES_set_key.3 +man_MAN += DH_generate_key.3 +man_MAN += DH_generate_parameters.3 +man_MAN += DH_get_ex_new_index.3 +man_MAN += DH_new.3 +man_MAN += DH_set_method.3 +man_MAN += DH_size.3 +man_MAN += DSA_SIG_new.3 +man_MAN += DSA_do_sign.3 +man_MAN += DSA_dup_DH.3 +man_MAN += DSA_generate_key.3 +man_MAN += DSA_generate_parameters.3 +man_MAN += DSA_get_ex_new_index.3 +man_MAN += DSA_new.3 +man_MAN += DSA_set_method.3 +man_MAN += DSA_sign.3 +man_MAN += DSA_size.3 +man_MAN += ERR.3 +man_MAN += ERR_GET_LIB.3 +man_MAN += ERR_clear_error.3 +man_MAN += ERR_error_string.3 +man_MAN += ERR_get_error.3 +man_MAN += ERR_load_crypto_strings.3 +man_MAN += ERR_load_strings.3 +man_MAN += ERR_print_errors.3 +man_MAN += ERR_put_error.3 +man_MAN += ERR_remove_state.3 +man_MAN += ERR_set_mark.3 +man_MAN += EVP_BytesToKey.3 +man_MAN += EVP_DigestInit.3 +man_MAN += EVP_DigestSignInit.3 +man_MAN += EVP_DigestVerifyInit.3 +man_MAN += EVP_EncryptInit.3 +man_MAN += EVP_OpenInit.3 +man_MAN += EVP_PKEY_CTX_ctrl.3 +man_MAN += EVP_PKEY_CTX_new.3 +man_MAN += EVP_PKEY_cmp.3 +man_MAN += EVP_PKEY_decrypt.3 +man_MAN += EVP_PKEY_derive.3 +man_MAN += EVP_PKEY_encrypt.3 +man_MAN += EVP_PKEY_get_default_digest.3 +man_MAN += EVP_PKEY_keygen.3 +man_MAN += EVP_PKEY_new.3 +man_MAN += EVP_PKEY_print_private.3 +man_MAN += EVP_PKEY_set1_RSA.3 +man_MAN += EVP_PKEY_sign.3 +man_MAN += EVP_PKEY_verify.3 +man_MAN += EVP_PKEY_verify_recover.3 +man_MAN += EVP_SealInit.3 +man_MAN += EVP_SignInit.3 +man_MAN += EVP_VerifyInit.3 +man_MAN += HMAC.3 +man_MAN += MD5.3 +man_MAN += OBJ_nid2obj.3 +man_MAN += OPENSSL_VERSION_NUMBER.3 +man_MAN += OPENSSL_config.3 +man_MAN += OPENSSL_load_builtin_modules.3 +man_MAN += OpenSSL_add_all_algorithms.3 +man_MAN += PEM_read_bio_PrivateKey.3 +man_MAN += PEM_write_bio_CMS_stream.3 +man_MAN += PEM_write_bio_PKCS7_stream.3 +man_MAN += PKCS12_create.3 +man_MAN += PKCS12_parse.3 +man_MAN += PKCS7_decrypt.3 +man_MAN += PKCS7_encrypt.3 +man_MAN += PKCS7_sign.3 +man_MAN += PKCS7_sign_add_signer.3 +man_MAN += PKCS7_verify.3 +man_MAN += RAND.3 +man_MAN += RAND_add.3 +man_MAN += RAND_bytes.3 +man_MAN += RAND_cleanup.3 +man_MAN += RAND_load_file.3 +man_MAN += RAND_set_rand_method.3 +man_MAN += RC4.3 +man_MAN += RIPEMD160.3 +man_MAN += RSA_blinding_on.3 +man_MAN += RSA_check_key.3 +man_MAN += RSA_generate_key.3 +man_MAN += RSA_get_ex_new_index.3 +man_MAN += RSA_new.3 +man_MAN += RSA_padding_add_PKCS1_type_1.3 +man_MAN += RSA_print.3 +man_MAN += RSA_private_encrypt.3 +man_MAN += RSA_public_encrypt.3 +man_MAN += RSA_set_method.3 +man_MAN += RSA_sign.3 +man_MAN += RSA_sign_ASN1_OCTET_STRING.3 +man_MAN += RSA_size.3 +man_MAN += SHA1.3 +man_MAN += SMIME_read_CMS.3 +man_MAN += SMIME_read_PKCS7.3 +man_MAN += SMIME_write_CMS.3 +man_MAN += SMIME_write_PKCS7.3 +man_MAN += X509_NAME_ENTRY_get_object.3 +man_MAN += X509_NAME_add_entry_by_txt.3 +man_MAN += X509_NAME_get_index_by_NID.3 +man_MAN += X509_NAME_print_ex.3 +man_MAN += X509_STORE_CTX_get_error.3 +man_MAN += X509_STORE_CTX_get_ex_new_index.3 +man_MAN += X509_STORE_CTX_new.3 +man_MAN += X509_STORE_CTX_set_verify_cb.3 +man_MAN += X509_STORE_set_verify_cb_func.3 +man_MAN += X509_VERIFY_PARAM_set_flags.3 +man_MAN += X509_new.3 +man_MAN += X509_verify_cert.3 +man_MAN += bn.3 +man_MAN += bn_internal.3 +man_MAN += crypto.3 +man_MAN += d2i_ASN1_OBJECT.3 +man_MAN += d2i_DHparams.3 +man_MAN += d2i_DSAPublicKey.3 +man_MAN += d2i_PKCS8PrivateKey.3 +man_MAN += d2i_RSAPublicKey.3 +man_MAN += d2i_X509.3 +man_MAN += d2i_X509_ALGOR.3 +man_MAN += d2i_X509_CRL.3 +man_MAN += d2i_X509_NAME.3 +man_MAN += d2i_X509_REQ.3 +man_MAN += d2i_X509_SIG.3 +man_MAN += dh.3 +man_MAN += dsa.3 +man_MAN += ecdsa.3 +man_MAN += engine.3 +man_MAN += evp.3 +man_MAN += i2d_CMS_bio_stream.3 +man_MAN += i2d_PKCS7_bio_stream.3 +man_MAN += lh_stats.3 +man_MAN += lhash.3 +man_MAN += rsa.3 +man_MAN += ui.3 +man_MAN += ui_compat.3 +man_MAN += x509.3 diff --git a/man/Makefile.am.tpl b/man/Makefile.am.tpl new file mode 100644 index 0000000..88cbb51 --- /dev/null +++ b/man/Makefile.am.tpl @@ -0,0 +1,2 @@ +include $(top_srcdir)/Makefile.am.common +man_MAN= diff --git a/update.sh b/update.sh index c6ae79c..69fc475 100755 --- a/update.sh +++ b/update.sh @@ -4,7 +4,7 @@ set -e # resync this library with the upstream project, remove old submodule dirs if [ -d openbsd ]; then (cd openbsd - git co master + git checkout master git pull) else if [ -z "$LIBRESSL_GIT" ]; then @@ -51,7 +51,7 @@ copy_crypto() { } cp $libssl_src/src/LICENSE COPYING -cp $libssl_src/src/CHANGES ChangeLog +echo "Please see OpenBSD CVS logs" > ChangeLog cp $libcrypto_src/crypto/arch/amd64/opensslconf.h include/openssl cp $libssl_src/src/e_os2.h include/openssl @@ -381,3 +381,14 @@ crypto_excludes=( echo "noinst_HEADERS += $i" >> Makefile.am done ) + +(cd man + cp Makefile.am.tpl Makefile.am + for i in `ls -1 ../$libssl_src/src/doc/crypto/*.pod | sort`; do + BASE=`echo $i|sed -e "s/\.pod//"` + echo $BASE + NAME=`basename "$BASE"` + pod2man --official --release=LibreSSL --center=LibreSSL --section=3 --name=$NAME < $BASE.pod > $NAME.3 + echo "man_MAN += $NAME.3" >> Makefile.am + done +) -- cgit v1.2.3-55-g6feb