diff options
author | schwarze <> | 2016-11-18 18:44:11 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-18 18:44:11 +0000 |
commit | 768f4c673e8262a34b19242e5f508c8e3f85a625 (patch) | |
tree | 0ec7e75cbae86336405479988281ceb8b1bea3e4 | |
parent | b4e93a4e5192c3f2348c097f012c9bfd5d40b63c (diff) | |
download | openbsd-768f4c673e8262a34b19242e5f508c8e3f85a625.tar.gz openbsd-768f4c673e8262a34b19242e5f508c8e3f85a625.tar.bz2 openbsd-768f4c673e8262a34b19242e5f508c8e3f85a625.zip |
Add Copyright and license.
Bring in two clarifying sentences from OpenSSL.
-rw-r--r-- | src/lib/libcrypto/man/BIO_read.3 | 57 |
1 files changed, 54 insertions, 3 deletions
diff --git a/src/lib/libcrypto/man/BIO_read.3 b/src/lib/libcrypto/man/BIO_read.3 index f19c31ecab..896e41dd43 100644 --- a/src/lib/libcrypto/man/BIO_read.3 +++ b/src/lib/libcrypto/man/BIO_read.3 | |||
@@ -1,6 +1,54 @@ | |||
1 | .\" $OpenBSD: BIO_read.3,v 1.3 2016/11/07 15:52:47 jmc Exp $ | 1 | .\" $OpenBSD: BIO_read.3,v 1.4 2016/11/18 18:44:11 schwarze Exp $ |
2 | .\" OpenSSL 99d63d46 Oct 26 13:56:48 2016 -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, 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_READ 3 | 52 | .Dt BIO_READ 3 |
5 | .Os | 53 | .Os |
6 | .Sh NAME | 54 | .Sh NAME |
@@ -48,13 +96,14 @@ performs the BIOs "gets" operation and places the data in | |||
48 | .Fa buf . | 96 | .Fa buf . |
49 | Usually this operation will attempt to read a line of data | 97 | Usually this operation will attempt to read a line of data |
50 | from the BIO of maximum length | 98 | from the BIO of maximum length |
51 | .Fa len . | 99 | .Fa len No - 1 . |
52 | There are exceptions to this however, for example | 100 | There are exceptions to this however, for example |
53 | .Fn BIO_gets | 101 | .Fn BIO_gets |
54 | on a digest BIO will calculate and return the digest | 102 | on a digest BIO will calculate and return the digest |
55 | and other BIOs may not support | 103 | and other BIOs may not support |
56 | .Fn BIO_gets | 104 | .Fn BIO_gets |
57 | at all. | 105 | at all. |
106 | The returned string is always NUL-terminated. | ||
58 | .Pp | 107 | .Pp |
59 | .Fn BIO_write | 108 | .Fn BIO_write |
60 | attempts to write | 109 | attempts to write |
@@ -108,6 +157,8 @@ read or written (if the return value is positive) or that no data | |||
108 | was successfully read or written if the result is 0 or -1. | 157 | was successfully read or written if the result is 0 or -1. |
109 | If the return value is -2, then the operation is not implemented | 158 | If the return value is -2, then the operation is not implemented |
110 | in the specific BIO type. | 159 | in the specific BIO type. |
160 | The trailing NUL is not included in the length returned by | ||
161 | .Fn BIO_gets . | ||
111 | .Pp | 162 | .Pp |
112 | A 0 or -1 return is not necessarily an indication of an error. | 163 | A 0 or -1 return is not necessarily an indication of an error. |
113 | In particular when the source/sink is non-blocking or of a certain type | 164 | In particular when the source/sink is non-blocking or of a certain type |