summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorschwarze <>2016-11-18 18:49:44 +0000
committerschwarze <>2016-11-18 18:49:44 +0000
commit49eeb9aa7d3a1d61dc36d4aef80984660fb3d68e (patch)
tree2bc7a49ecd14679c1ce0765f22343173258a0ae7 /src
parentd776aeae107d1c86ba6efc7090d176efd33f01ea (diff)
downloadopenbsd-49eeb9aa7d3a1d61dc36d4aef80984660fb3d68e.tar.gz
openbsd-49eeb9aa7d3a1d61dc36d4aef80984660fb3d68e.tar.bz2
openbsd-49eeb9aa7d3a1d61dc36d4aef80984660fb3d68e.zip
Add Copyright and license.
Mention that BIO_set_fd(3) and BIO_get_fd(3) are macros. Delete off-topic sentences about the return values of BIO_seek(3), BIO_reset(3), and BIO_tell(3).
Diffstat (limited to 'src')
-rw-r--r--src/lib/libcrypto/man/BIO_s_fd.367
1 files changed, 55 insertions, 12 deletions
diff --git a/src/lib/libcrypto/man/BIO_s_fd.3 b/src/lib/libcrypto/man/BIO_s_fd.3
index 9365eaf973..e3a27421e1 100644
--- a/src/lib/libcrypto/man/BIO_s_fd.3
+++ b/src/lib/libcrypto/man/BIO_s_fd.3
@@ -1,6 +1,54 @@
1.\" $OpenBSD: BIO_s_fd.3,v 1.4 2016/11/07 15:52:47 jmc Exp $ 1.\" $OpenBSD: BIO_s_fd.3,v 1.5 2016/11/18 18:49:44 schwarze Exp $
2.\" OpenSSL 9b86974e Aug 17 15:21:33 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 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_S_FD 3 52.Dt BIO_S_FD 3
5.Os 53.Os
6.Sh NAME 54.Sh NAME
@@ -110,20 +158,15 @@ manual pages.
110.Pp 158.Pp
111File descriptor BIOs should not be used for socket I/O. 159File descriptor BIOs should not be used for socket I/O.
112Use socket BIOs instead. 160Use socket BIOs instead.
161.Pp
162.Fn BIO_set_fd
163and
164.Fn BIO_get_fd
165are implemented as macros.
113.Sh RETURN VALUES 166.Sh RETURN VALUES
114.Fn BIO_s_fd 167.Fn BIO_s_fd
115returns the file descriptor BIO method. 168returns the file descriptor BIO method.
116.Pp 169.Pp
117.Xr BIO_reset 3
118returns zero for success and -1 if an error occurred.
119.Xr BIO_seek 3
120and
121.Xr BIO_tell 3
122return the current file position or -1 if an error occurred.
123These values reflect the underlying
124.Xr lseek 2
125behaviour.
126.Pp
127.Fn BIO_set_fd 170.Fn BIO_set_fd
128always returns 1. 171always returns 1.
129.Pp 172.Pp