nicer manpages

andy737 · Feb 24, 2000 · 4d524e1 · 4d524e1
1 parent c6a33c6
commit 4d524e1
Show file tree

Hide file tree

Showing 55 changed files with 104 additions and 87 deletions.
diff --git a/INSTALL b/INSTALL
@@ -117,8 +117,7 @@
 
      If "make" fails, please report the problem to <[email protected]>
      (note that your message will be forwarded to a public mailing list).
-     Include the output of "./config -t" and the OpenSSL version
-     number in your message.
+     Include the output of "make report" in your message.
 
      [If you encounter assembler error messages, try the "no-asm"
      configuration option as an immediate fix.]
@@ -133,7 +132,7 @@
     If a test fails, try removing any compiler optimization flags from
     the CFLAGS line in Makefile.ssl and run "make clean; make". Please
     send a bug report to <[email protected]>, including the
-    output of "openssl version -a" and of the failed test.
+    output of "make report".
 
   4. If everything tests ok, install OpenSSL with
 

diff --git a/NEWS b/NEWS
@@ -35,8 +35,9 @@
       o Memory leak detection now allows applications to add extra information
         via a per-thread stack
       o PRNG robustness improved
+      o EGD support
       o BIGNUM library bug fixes
-      o faster DSA parameter generation
+      o Faster DSA parameter generation
       o Enhanced support for Alpha Linux
       o Experimental MacOS support
 

diff --git a/doc/apps/version.pod b/doc/apps/version.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-version - print version information
+version - print OpenSSL version information
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/BN_add.pod b/doc/crypto/BN_add.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 BN_add, BN_sub, BN_mul, BN_div, BN_sqr, BN_mod, BN_mod_mul, BN_exp,
-BN_mod_exp, BN_gcd - Arithmetic operations on BIGNUMs
+BN_mod_exp, BN_gcd - arithmetic operations on BIGNUMs
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/BN_add_word.pod b/doc/crypto/BN_add_word.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word - Arithmetic
+BN_add_word, BN_sub_word, BN_mul_word, BN_div_word, BN_mod_word - arithmetic
 functions on BIGNUMs with integers
 
 =head1 SYNOPSIS

diff --git a/doc/crypto/BN_bn2bin.pod b/doc/crypto/BN_bn2bin.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 BN_bn2bin, BN_bin2bn, BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn,
-BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn - Format conversions
+BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn - format conversions
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/BN_generate_prime.pod b/doc/crypto/BN_generate_prime.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-BN_generate_prime, BN_is_prime, BN_is_prime_fasttest - Generate primes and test for primality
+BN_generate_prime, BN_is_prime, BN_is_prime_fasttest - generate primes and test for primality
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/BN_mod_inverse.pod b/doc/crypto/BN_mod_inverse.pod
@@ -2,13 +2,14 @@
 
 =head1 NAME
 
-BN_mod_inverse - Compute inverse modulo n
+BN_mod_inverse - compute inverse modulo n
 
 =head1 SYNOPSIS
 
  #include <openssl/bn.h>
 
- BIGNUM *BN_mod_inverse(BIGNUM *r, BIGNUM *a, const BIGNUM *n, BN_CTX *ctx);
+ BIGNUM *BN_mod_inverse(BIGNUM *r, BIGNUM *a, const BIGNUM *n,
+           BN_CTX *ctx);
 
 =head1 DESCRIPTION
 

diff --git a/doc/crypto/BN_mod_mul_reciprocal.pod b/doc/crypto/BN_mod_mul_reciprocal.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 BN_mod_mul_reciprocal, BN_RECP_CTX_new, BN_RECP_CTX_init,
-BN_RECP_CTX_free, BN_RECP_CTX_set - Modular multiplication using
+BN_RECP_CTX_free, BN_RECP_CTX_set - modular multiplication using
 reciprocal
 
 =head1 SYNOPSIS

diff --git a/doc/crypto/BN_num_bytes.pod b/doc/crypto/BN_num_bytes.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-BN_num_bits, BN_num_bytes, BN_num_bits_word - Get BIGNUM size
+BN_num_bits, BN_num_bytes, BN_num_bits_word - get BIGNUM size
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/BN_rand.pod b/doc/crypto/BN_rand.pod
@@ -2,15 +2,15 @@
 
 =head1 NAME
 
-BN_rand, BN_pseudo_rand - Generate pseudo-random number
+BN_rand, BN_pseudo_rand - generate pseudo-random number
 
 =head1 SYNOPSIS
 
  #include <openssl/bn.h>
 
  int BN_rand(BIGNUM *rnd, int bits, int top, int bottom);
 
- int BN_pseudo_rand(BIGNUM *rnd, int bits, int top,int bottom);
+ int BN_pseudo_rand(BIGNUM *rnd, int bits, int top, int bottom);
 
 =head1 DESCRIPTION
 

diff --git a/doc/crypto/BN_set_bit.pod b/doc/crypto/BN_set_bit.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 BN_set_bit, BN_clear_bit, BN_is_bit_set, BN_mask_bits, BN_lshift,
-BN_lshift1, BN_rshift, BN_rshift1 - Bit operations on BIGNUMs
+BN_lshift1, BN_rshift, BN_rshift1 - bit operations on BIGNUMs
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DH_generate_key.pod b/doc/crypto/DH_generate_key.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DH_generate_key, DH_compute_key - Perform Diffie-Hellman key exchange
+DH_generate_key, DH_compute_key - perform Diffie-Hellman key exchange
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DH_generate_parameters.pod b/doc/crypto/DH_generate_parameters.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DH_generate_parameters, DH_check - Generate and check Diffie-Hellman parameters
+DH_generate_parameters, DH_check - generate and check Diffie-Hellman parameters
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DH_set_method.pod b/doc/crypto/DH_set_method.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 DH_set_default_method, DH_get_default_method, DH_set_method,
-DH_new_method, DH_OpenSSL - Select RSA method
+DH_new_method, DH_OpenSSL - select DH method
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DH_size.pod b/doc/crypto/DH_size.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DH_size - Get Diffie-Hellman prime size
+DH_size - get Diffie-Hellman prime size
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DSA_do_sign.pod b/doc/crypto/DSA_do_sign.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DSA_do_sign, DSA_do_verify - Raw DSA signature operations
+DSA_do_sign, DSA_do_verify - raw DSA signature operations
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DSA_dup_DH.pod b/doc/crypto/DSA_dup_DH.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DSA_dup_DH - Create a DH structure out of DSA structure
+DSA_dup_DH - create a DH structure out of DSA structure
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DSA_generate_key.pod b/doc/crypto/DSA_generate_key.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DSA_generate_key - Generate DSA key pair
+DSA_generate_key - generate DSA key pair
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DSA_generate_parameters.pod b/doc/crypto/DSA_generate_parameters.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DSA_generate_parameters - Generate DSA parameters
+DSA_generate_parameters - generate DSA parameters
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DSA_set_method.pod b/doc/crypto/DSA_set_method.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 DSA_set_default_method, DSA_get_default_method, DSA_set_method,
-DSA_new_method, DSA_OpenSSL - Select RSA method
+DSA_new_method, DSA_OpenSSL - select RSA method
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/DSA_size.pod b/doc/crypto/DSA_size.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-DSA_size - Get DSA signature size
+DSA_size - get DSA signature size
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/ERR_get_error.pod b/doc/crypto/ERR_get_error.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-ERR_get_error, ERR_peek_error - Obtain error code
+ERR_get_error, ERR_peek_error - obtain error code
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/ERR_load_crypto_strings.pod b/doc/crypto/ERR_load_crypto_strings.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 ERR_load_crypto_strings, SSL_load_error_strings, ERR_free_strings -
-Load and free error strings
+load and free error strings
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/ERR_load_strings.pod b/doc/crypto/ERR_load_strings.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-ERR_load_strings, ERR_PACK, ERR_get_next_error_library - Load
+ERR_load_strings, ERR_PACK, ERR_get_next_error_library - load
 arbitrary error strings
 
 =head1 SYNOPSIS

diff --git a/doc/crypto/ERR_put_error.pod b/doc/crypto/ERR_put_error.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-ERR_put_error, ERR_add_error_data - Record an error
+ERR_put_error, ERR_add_error_data - record an error
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/ERR_remove_state.pod b/doc/crypto/ERR_remove_state.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-ERR_remove_state - Free a thread's error queue
+ERR_remove_state - free a thread's error queue
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/EVP_DigestInit.pod b/doc/crypto/EVP_DigestInit.pod
@@ -9,8 +9,9 @@ EVP_DigestInit, EVP_DigestUpdate, EVP_DigestFinal - EVP digest routines
  #include <openssl/evp.h>
 
  void EVP_DigestInit(EVP_MD_CTX *ctx, const EVP_MD *type);
- void EVP_DigestUpdate(EVP_MD_CTX *ctx,const void *d, unsigned int cnt);
- void EVP_DigestFinal(EVP_MD_CTX *ctx,unsigned char *md,unsigned int *s);
+ void EVP_DigestUpdate(EVP_MD_CTX *ctx, const void *d, unsigned int cnt);
+ void EVP_DigestFinal(EVP_MD_CTX *ctx, unsigned char *md,
+        unsigned int *s);
 
  #define EVP_MAX_MD_SIZE (16+20) /* The SSLv3 md5+sha1 type */
 

diff --git a/doc/crypto/EVP_EncryptInit.pod b/doc/crypto/EVP_EncryptInit.pod
@@ -8,17 +8,26 @@ EVP_EncryptInit, EVP_EncryptUpdate, EVP_EncryptFinal - EVP cipher routines
 
  #include <openssl/evp.h>
 
- void EVP_EncryptInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *type, unsigned char *key, unsigned char *iv);
- void EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl, unsigned char *in, int inl);
- void EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl);
-
- void EVP_DecryptInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *type, unsigned char *key, unsigned char *iv);
- void EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl, unsigned char *in, int inl);
- int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
-
- void EVP_CipherInit(EVP_CIPHER_CTX *ctx,const EVP_CIPHER *type, unsigned char *key,unsigned char *iv,int enc);
- void EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl, unsigned char *in, int inl);
- int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
+ void EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
+         unsigned char *key, unsigned char *iv);
+ void EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
+         int *outl, unsigned char *in, int inl);
+ void EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out,
+         int *outl);
+
+ void EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
+         unsigned char *key, unsigned char *iv);
+ void EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
+         int *outl, unsigned char *in, int inl);
+ int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm,
+         int *outl);
+
+ void EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
+         unsigned char *key, unsigned char *iv, int enc);
+ void EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
+         int *outl, unsigned char *in, int inl);
+ int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm,
+         int *outl);
 
  void EVP_CIPHER_CTX_cleanup(EVP_CIPHER_CTX *a);
 

diff --git a/doc/crypto/OPENSSL_VERSION_NUMBER.pod b/doc/crypto/OPENSSL_VERSION_NUMBER.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-OPENSSL_VERSION_NUMBER, SSLeay - Get OpenSSL version number
+OPENSSL_VERSION_NUMBER, SSLeay - get OpenSSL version number
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/RAND_add.pod b/doc/crypto/RAND_add.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RAND_add, RAND_seed, RAND_screen - Add entropy to the PRNG
+RAND_add, RAND_seed, RAND_screen - add entropy to the PRNG
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/RAND_bytes.pod b/doc/crypto/RAND_bytes.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RAND_bytes, RAND_pseudo_bytes - Generate random data
+RAND_bytes, RAND_pseudo_bytes - generate random data
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/RAND_egd.pod b/doc/crypto/RAND_egd.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RAND_egd - Query entropy gathering daemon
+RAND_egd - query entropy gathering daemon
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/RAND_set_rand_method.pod b/doc/crypto/RAND_set_rand_method.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RAND_set_rand_method, RAND_get_rand_method, RAND_SSLeay - Select RAND method
+RAND_set_rand_method, RAND_get_rand_method, RAND_SSLeay - select RAND method
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/RSA_blinding_on.pod b/doc/crypto/RSA_blinding_on.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RSA_blinding_on, RSA_blinding_off - Protect the RSA operation from timing attacks
+RSA_blinding_on, RSA_blinding_off - protect the RSA operation from timing attacks
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/RSA_check_key.pod b/doc/crypto/RSA_check_key.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RSA_check_key - Validate RSA keys
+RSA_check_key - validate private RSA keys
 
 =head1 SYNOPSIS
 

diff --git a/doc/crypto/RSA_generate_key.pod b/doc/crypto/RSA_generate_key.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-RSA_generate_key - Generate RSA key pair
+RSA_generate_key - generate RSA key pair
 
 =head1 SYNOPSIS