RT2964: Fix it via doc

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

diff --git a/doc/crypto/bio.pod b/doc/crypto/bio.pod
index d86ce4bc007801ef34a473bd0022679ff20999a7..5a305c6a2979355d3b4bc09f34066fcb2e711c7c 100644 (file)
--- a/doc/crypto/bio.pod
+++ b/doc/crypto/bio.pod
@@ -1,16 +1,15 @@
 =pod
 
+=for comment openssl_manual_section 7
+
 =head1 NAME
 
-bio - I/O abstraction
+bio - Basic I/O abstraction
 
 =head1 SYNOPSIS
 
  #include <openssl/bio.h>
 
-TBA
-
-
 =head1 DESCRIPTION
 
 A BIO is an I/O abstraction, it hides many of the underlying I/O
@@ -20,7 +19,7 @@ connections and file I/O.
 
 There are two type of BIO, a source/sink BIO and a filter BIO.
 
-As its name implies a source/sink BIO is a source or sink of data,
+As its name implies a source/sink BIO is a source and/or sink of data,
 examples include a socket BIO and a file BIO.
 
 A filter BIO takes data from one BIO and passes it through to
@@ -34,9 +33,56 @@ if it is being read from.
 BIOs can be joined together to form a chain (a single BIO is a chain
 with one component). A chain normally consist of one source/sink
 BIO and one or more filter BIOs. Data read from or written to the
-end BIO then traverses the chain to the end (normally a source/sink
+first BIO then traverses the chain to the end (normally a source/sink
 BIO).
 
+
+Some BIOs (such as memory BIOs) can be used immediately after calling
+BIO_new(). Others (such as file BIOs) need some additional initialization,
+and frequently a utility function exists to create and initialize such BIOs.
+
+If BIO_free() is called on a BIO chain it will only free one BIO resulting
+in a memory leak.
+
+Calling BIO_free_all() a single BIO has the same effect as calling BIO_free()
+on it other than the discarded return value.
+
+Normally the B<type> argument is supplied by a function which returns a
+pointer to a BIO_METHOD. There is a naming convention for such functions:
+a source/sink BIO is normally called BIO_s_*() and a filter BIO
+BIO_f_*();
+
+=head1 EXAMPLE
+
+Create a memory BIO:
+
+ BIO *mem = BIO_new(BIO_s_mem());
+
 =head1 SEE ALSO
 
-TBA
+L<BIO_ctrl(3)>,
+L<BIO_f_base64(3)>, L<BIO_f_buffer(3)>,
+L<BIO_f_cipher(3)>, L<BIO_f_md(3)>,
+L<BIO_f_null(3)>, L<BIO_f_ssl(3)>,
+L<BIO_find_type(3)>, L<BIO_new(3)>,
+L<BIO_new_bio_pair(3)>,
+L<BIO_push(3)>, L<BIO_read(3)>,
+L<BIO_s_accept(3)>, L<BIO_s_bio(3)>,
+L<BIO_s_connect(3)>, L<BIO_s_fd(3)>,
+L<BIO_s_file(3)>, L<BIO_s_mem(3)>,
+L<BIO_s_mem(3)>,
+L<BIO_s_null(3)>, L<BIO_s_socket(3)>,
+L<BIO_set_callback(3)>,
+L<BIO_should_retry(3)>
+
+=head1 COPYRIGHT
+
+Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
+
+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>.
+
+=cut
+