summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-18 18:43:06 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-18 18:43:06 +0000
commit597e8bf2e269d8b8b789d8d4fa715b53fa497c67 (patch)
tree65740a169834b6db8f8a3ddd081b80f575aa9057 /lib/libcrypto/man
parent5ce3e946018f62d4d62e4794838a80976a2188ce (diff)
Add Copyright and license.
Document that BIO_free(3), BIO_vfree(3), and BIO_free_all(3) accept NULL. Delete the useless statement that void functions return no value.
Diffstat (limited to 'lib/libcrypto/man')
-rw-r--r--lib/libcrypto/man/BIO_new.367
1 files changed, 60 insertions, 7 deletions
diff --git a/lib/libcrypto/man/BIO_new.3 b/lib/libcrypto/man/BIO_new.3
index 71385986747..59a5b370563 100644
--- a/lib/libcrypto/man/BIO_new.3
+++ b/lib/libcrypto/man/BIO_new.3
@@ -1,6 +1,54 @@
-.\" $OpenBSD: BIO_new.3,v 1.4 2016/11/07 15:52:47 jmc Exp $
+.\" $OpenBSD: BIO_new.3,v 1.5 2016/11/18 18:43:05 schwarze Exp $
+.\" OpenSSL ca3a82c3 Mar 25 11:31:18 2015 -0400
.\"
-.Dd $Mdocdate: November 7 2016 $
+.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
+.\" Copyright (c) 2000, 2015, 2016 The OpenSSL Project. All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in
+.\" the documentation and/or other materials provided with the
+.\" distribution.
+.\"
+.\" 3. All advertising materials mentioning features or use of this
+.\" software must display the following acknowledgment:
+.\" "This product includes software developed by the OpenSSL Project
+.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+.\"
+.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+.\" endorse or promote products derived from this software without
+.\" prior written permission. For written permission, please contact
+.\" openssl-core@openssl.org.
+.\"
+.\" 5. Products derived from this software may not be called "OpenSSL"
+.\" nor may "OpenSSL" appear in their names without prior written
+.\" permission of the OpenSSL Project.
+.\"
+.\" 6. Redistributions of any form whatsoever must retain the following
+.\" acknowledgment:
+.\" "This product includes software developed by the OpenSSL Project
+.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
+.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+.\" OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: November 18 2016 $
.Dt BIO_NEW 3
.Os
.Sh NAME
@@ -46,6 +94,11 @@ sets the method of an already existing BIO.
frees up a single BIO;
.Fn BIO_vfree
also frees up a single BIO, but it does not return a value.
+If
+.Fa a
+is a
+.Dv NULL
+pointer, no action occurs.
Calling
.Fn BIO_free
may also have some effect on the underlying I/O structure,
@@ -59,6 +112,11 @@ descriptions.
frees up an entire BIO chain.
It does not halt if an error occurs
freeing up an individual BIO in the chain.
+If
+.Fa a
+is a
+.Dv NULL
+pointer, no action occurs.
.Pp
Some BIOs (such as memory BIOs) can be used immediately after calling
.Fn BIO_new .
@@ -95,11 +153,6 @@ if the call fails.
and
.Fn BIO_free
return 1 for success and 0 for failure.
-.Pp
-.Fn BIO_free_all
-and
-.Fn BIO_vfree
-do not return values.
.Sh EXAMPLES
Create a memory BIO:
.Pp