More doc cleanup

[openssl.git] / doc / crypto / BIO_f_cipher.pod

diff --git a/doc/crypto/BIO_f_cipher.pod b/doc/crypto/BIO_f_cipher.pod
index 7270c743c5ec7b3a3a0db1569908dfe257f1379d..87ab3ccc9dfac4334f6d4dbfb88a2b8bde400a4e 100644 (file)
--- a/doc/crypto/BIO_f_cipher.pod
+++ b/doc/crypto/BIO_f_cipher.pod
@@ -2,16 +2,18 @@
 
 =head1 NAME
 
-       BIO_f_cipher - cipher BIO
+BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx - cipher BIO filter
+
+=for comment multiple includes
 
 =head1 SYNOPSIS
 
  #include <openssl/bio.h>
  #include <openssl/evp.h>
 
- BIO_METHOD *  BIO_f_cipher(void);
- void BIO_set_cipher(BIO *b,const EVP_CIPHER *cipher,
-               unsigned char *key, unsigned char *iv, int enc);
+ const BIO_METHOD *BIO_f_cipher(void);
+ void BIO_set_cipher(BIO *b, const EVP_CIPHER *cipher,
+                unsigned char *key, unsigned char *iv, int enc);
  int BIO_get_cipher_status(BIO *b)
  int BIO_get_cipher_ctx(BIO *b, EVP_CIPHER_CTX **pctx)
 
@@ -22,13 +24,13 @@ BIO that encrypts any data written through it, and decrypts any data
 read from it. It is a BIO wrapper for the cipher routines
 EVP_CipherInit(), EVP_CipherUpdate() and EVP_CipherFinal().
 
-Cipher BIOs do not support BIO_gets() or BIO_puts(). 
+Cipher BIOs do not support BIO_gets() or BIO_puts().
 
 BIO_flush() on an encryption BIO that is being written through is
 used to signal that no more data is to be encrypted: this is used
 to flush and possibly pad the final block through the BIO.
 
-BIO_set_cipher() sets the cipher of BIO <b> to B<cipher> using key B<key>
+BIO_set_cipher() sets the cipher of BIO B<b> to B<cipher> using key B<key>
 and IV B<iv>. B<enc> should be set to 1 for encryption and zero for
 decryption.
 
@@ -38,7 +40,7 @@ is a BIO_ctrl() macro which can be called to determine whether the
 decryption operation was successful.
 
 BIO_get_cipher_ctx() is a BIO_ctrl() macro which retrieves the internal
-BIO cipher context. The retrieved context can be used in conjustion
+BIO cipher context. The retrieved context can be used in conjunction
 with the standard cipher routines to set it up. This is useful when
 BIO_set_cipher() is not flexible enough for the applications needs.
 
@@ -48,7 +50,7 @@ When encrypting BIO_flush() B<must> be called to flush the final block
 through the BIO. If it is not then the final block will fail a subsequent
 decrypt.
 
-When decrypting an error on the final block is signalled by a zero
+When decrypting an error on the final block is signaled by a zero
 return value from the read operation. A successful decrypt followed
 by EOF will also return zero for the final read. BIO_get_cipher_status()
 should be called to determine if the decrypt was successful.
@@ -67,10 +69,13 @@ for failure.
 
 BIO_get_cipher_ctx() currently always returns 1.
 
-=head1 EXAMPLES
+=head1 COPYRIGHT
 
-TBA
+Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 
-=head1 SEE ALSO
+Licensed under the OpenSSL license (the "License").  You may not use
+this file except in compliance with the License.  You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
 
-TBA
+=cut