summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorschwarze <>2016-11-18 18:43:05 +0000
committerschwarze <>2016-11-18 18:43:05 +0000
commitb4e93a4e5192c3f2348c097f012c9bfd5d40b63c (patch)
tree3511713b4ec9aacb337e87aee5f7614cbc90ee75 /src
parentc9944c8d48b5197b5d660006e939e59e811e2713 (diff)
downloadopenbsd-b4e93a4e5192c3f2348c097f012c9bfd5d40b63c.tar.gz
openbsd-b4e93a4e5192c3f2348c097f012c9bfd5d40b63c.tar.bz2
openbsd-b4e93a4e5192c3f2348c097f012c9bfd5d40b63c.zip
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 'src')
-rw-r--r--src/lib/libcrypto/man/BIO_new.367
1 files changed, 60 insertions, 7 deletions
diff --git a/src/lib/libcrypto/man/BIO_new.3 b/src/lib/libcrypto/man/BIO_new.3
index 7138598674..59a5b37056 100644
--- a/src/lib/libcrypto/man/BIO_new.3
+++ b/src/lib/libcrypto/man/BIO_new.3
@@ -1,6 +1,54 @@
1.\" $OpenBSD: BIO_new.3,v 1.4 2016/11/07 15:52:47 jmc Exp $ 1.\" $OpenBSD: BIO_new.3,v 1.5 2016/11/18 18:43:05 schwarze Exp $
2.\" OpenSSL ca3a82c3 Mar 25 11:31:18 2015 -0400
2.\" 3.\"
3.Dd $Mdocdate: November 7 2016 $ 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2000, 2015, 2016 The OpenSSL Project. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in
16.\" the documentation and/or other materials provided with the
17.\" distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\" software must display the following acknowledgment:
21.\" "This product includes software developed by the OpenSSL Project
22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\" endorse or promote products derived from this software without
26.\" prior written permission. For written permission, please contact
27.\" openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\" nor may "OpenSSL" appear in their names without prior written
31.\" permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\" acknowledgment:
35.\" "This product includes software developed by the OpenSSL Project
36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: November 18 2016 $
4.Dt BIO_NEW 3 52.Dt BIO_NEW 3
5.Os 53.Os
6.Sh NAME 54.Sh NAME
@@ -46,6 +94,11 @@ sets the method of an already existing BIO.
46frees up a single BIO; 94frees up a single BIO;
47.Fn BIO_vfree 95.Fn BIO_vfree
48also frees up a single BIO, but it does not return a value. 96also frees up a single BIO, but it does not return a value.
97If
98.Fa a
99is a
100.Dv NULL
101pointer, no action occurs.
49Calling 102Calling
50.Fn BIO_free 103.Fn BIO_free
51may also have some effect on the underlying I/O structure, 104may also have some effect on the underlying I/O structure,
@@ -59,6 +112,11 @@ descriptions.
59frees up an entire BIO chain. 112frees up an entire BIO chain.
60It does not halt if an error occurs 113It does not halt if an error occurs
61freeing up an individual BIO in the chain. 114freeing up an individual BIO in the chain.
115If
116.Fa a
117is a
118.Dv NULL
119pointer, no action occurs.
62.Pp 120.Pp
63Some BIOs (such as memory BIOs) can be used immediately after calling 121Some BIOs (such as memory BIOs) can be used immediately after calling
64.Fn BIO_new . 122.Fn BIO_new .
@@ -95,11 +153,6 @@ if the call fails.
95and 153and
96.Fn BIO_free 154.Fn BIO_free
97return 1 for success and 0 for failure. 155return 1 for success and 0 for failure.
98.Pp
99.Fn BIO_free_all
100and
101.Fn BIO_vfree
102do not return values.
103.Sh EXAMPLES 156.Sh EXAMPLES
104Create a memory BIO: 157Create a memory BIO:
105.Pp 158.Pp