Use the correct number of arguments in the example.

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

diff --git a/doc/crypto/BIO_new_bio_pair.pod b/doc/crypto/BIO_new_bio_pair.pod
index 2256ba9d341077d7d03aaf5e9e4431da4361af1f..1a8dbc577b843366a3e28806190796935458fb9a 100644 (file)
--- a/doc/crypto/BIO_new_bio_pair.pod
+++ b/doc/crypto/BIO_new_bio_pair.pod
@@ -12,7 +12,8 @@ BIO_new_bio_pair - create a new BIO pair
 
 =head1 DESCRIPTION
 
-BIO_new_bio_pair() creates a buffering BIO pair. It has two endpoints between
+BIO_new_bio_pair() creates a buffering BIO pair based on the
+L<SSL_set_bio(3)|SSL_set_bio(3)> method. The BIO pair has two endpoints between which
 data can be buffered. Its typical use is to connect one endpoint as underlying
 input/output BIO to an SSL and access the other one controlled by the program
 instead of accessing the network connection directly.
@@ -38,7 +39,7 @@ without having to go through the SSL-interface.
  BIO *internal_bio, *network_bio;
  ...
  BIO_new_bio_pair(internal_bio, 0, network_bio, 0);
- SSL_set_bio(ssl, internal_bio);
+ SSL_set_bio(ssl, internal_bio, internal_bio);
  SSL_operations();
  ...
 
@@ -67,7 +68,7 @@ and must be transfered to the network. Use BIO_ctrl_get_read_request() to
 find out, how many bytes must be written into the buffer before the
 SSL_operation() can successfully be continued.
 
-=head1 IMPORTANT
+=head1 WARNING
 
 As the data is buffered, SSL_operation() may return with a ERROR_SSL_WANT_READ
 condition, but there is still data in the write buffer. An application must