summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/BIO.3
diff options
context:
space:
mode:
authorschwarze <>2016-12-06 12:54:19 +0000
committerschwarze <>2016-12-06 12:54:19 +0000
commit3472b6f5a290febbe7727d2886dce3ddeb0798e4 (patch)
treeff8829e73684df79b569988da2fa0850acaa867f /src/lib/libcrypto/man/BIO.3
parenteea7454d5f0937c3ffb6642ac5b1ba135b172e29 (diff)
downloadopenbsd-3472b6f5a290febbe7727d2886dce3ddeb0798e4.tar.gz
openbsd-3472b6f5a290febbe7727d2886dce3ddeb0798e4.tar.bz2
openbsd-3472b6f5a290febbe7727d2886dce3ddeb0798e4.zip
We don't want section 3 manual pages with names that do not correspond
to functions, so delete the BIO(3) manual page and merge its content into BIO_new(3) and BIO_push(3). Sort the content of BIO_new(3) into a logical order and improve the wording in various ways. Add the required cross references to BIO_push(3).
Diffstat (limited to 'src/lib/libcrypto/man/BIO.3')
-rw-r--r--src/lib/libcrypto/man/BIO.3105
1 files changed, 0 insertions, 105 deletions
diff --git a/src/lib/libcrypto/man/BIO.3 b/src/lib/libcrypto/man/BIO.3
deleted file mode 100644
index 3c2dd8cbe5..0000000000
--- a/src/lib/libcrypto/man/BIO.3
+++ /dev/null
@@ -1,105 +0,0 @@
1.\" $OpenBSD: BIO.3,v 1.5 2016/11/22 14:55:19 schwarze Exp $
2.\" OpenSSL a9c85cea Nov 11 09:33:55 2016 +0100
3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5.\" Copyright (c) 2000 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 22 2016 $
52.Dt BIO 3
53.Os
54.Sh NAME
55.Nm BIO
56.Nd OpenSSL basic I/O abstraction
57.Sh SYNOPSIS
58.In openssl/bio.h
59.Sh DESCRIPTION
60A BIO is an I/O abstraction,
61hiding many of the underlying I/O details from an application.
62If an application uses a BIO for its I/O, it can transparently handle
63SSL connections, unencrypted network connections and file I/O.
64.Pp
65There are two types of BIO, a source/sink BIO and a filter BIO.
66.Pp
67As its name implies, a source/sink BIO is a source and/or sink of data.
68Examples include a socket BIO and a file BIO.
69.Pp
70A filter BIO takes data from one BIO and passes it through
71to another, or to the application.
72The data may be left unmodified (for example a message digest BIO)
73or translated (for example an encryption BIO).
74The effect of a filter BIO may change according to the I/O operation
75it is performing: for example an encryption BIO will encrypt data
76if it is being written to and decrypt data if it is being read from.
77.Pp
78BIOs can be joined together to form a chain
79(a single BIO is a chain with one component).
80A chain normally consist of one source/sink BIO
81and one or more filter BIOs.
82Data read from or written to the first BIO then traverses the chain
83to the end (normally a source/sink BIO).
84.Sh SEE ALSO
85.Xr BIO_ctrl 3 ,
86.Xr BIO_f_base64 3 ,
87.Xr BIO_f_buffer 3 ,
88.Xr BIO_f_cipher 3 ,
89.Xr BIO_f_md 3 ,
90.Xr BIO_f_null 3 ,
91.Xr BIO_f_ssl 3 ,
92.Xr BIO_find_type 3 ,
93.Xr BIO_new 3 ,
94.Xr BIO_push 3 ,
95.Xr BIO_read 3 ,
96.Xr BIO_s_accept 3 ,
97.Xr BIO_s_bio 3 ,
98.Xr BIO_s_connect 3 ,
99.Xr BIO_s_fd 3 ,
100.Xr BIO_s_file 3 ,
101.Xr BIO_s_mem 3 ,
102.Xr BIO_s_null 3 ,
103.Xr BIO_s_socket 3 ,
104.Xr BIO_set_callback 3 ,
105.Xr BIO_should_retry 3