diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/BIO_read.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/BIO_read.3 | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/secure/lib/libcrypto/man/man3/BIO_read.3 b/secure/lib/libcrypto/man/man3/BIO_read.3 index 29926d5ad6e7..950fa28c3c2a 100644 --- a/secure/lib/libcrypto/man/man3/BIO_read.3 +++ b/secure/lib/libcrypto/man/man3/BIO_read.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "BIO_READ 3ossl" -.TH BIO_READ 3ossl 2025-09-30 3.5.4 OpenSSL +.TH BIO_READ 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -96,22 +99,24 @@ in \fIbuf\fR. Usually this operation will attempt to read a line of data from the BIO of maximum length \fIsize\-1\fR. There are exceptions to this, however; for example, \fBBIO_gets()\fR on a digest BIO will calculate and return the digest and other BIOs may not support \fBBIO_gets()\fR at all. -The returned string is always NUL-terminated and the '\en' is preserved +The returned string is always NUL\-terminated and the \*(Aq\en\*(Aq is preserved if present in the input data. On binary input there may be NUL characters within the string; in this case the return value (if nonnegative) may give an incorrect length. .PP -\&\fBBIO_get_line()\fR attempts to read from BIO \fIb\fR a line of data up to the next '\en' +\&\fBBIO_get_line()\fR attempts to read from BIO \fIb\fR a line of data up to the next \*(Aq\en\*(Aq or the maximum length \fIsize\-1\fR is reached and places the data in \fIbuf\fR. -The returned string is always NUL-terminated and the '\en' is preserved +The returned string is always NUL\-terminated and the \*(Aq\en\*(Aq is preserved if present in the input data. On binary input there may be NUL characters within the string; in this case the return value (if nonnegative) gives the actual length read. -For implementing this, unfortunately the data needs to be read byte-by-byte. +For implementing this, unfortunately the data needs to be read byte\-by\-byte. .PP \&\fBBIO_write()\fR attempts to write \fIlen\fR bytes from \fIbuf\fR to BIO \fIb\fR. .PP -\&\fBBIO_puts()\fR attempts to write a NUL-terminated string \fIbuf\fR to BIO \fIb\fR. +\&\fBBIO_puts()\fR attempts to write a NUL\-terminated string \fIbuf\fR to BIO \fIb\fR, +without the terminating NUL byte and without appending \*(Aq\en\*(Aq +(so, similar to \fBfputs\fR\|(3), and not \fBputs\fR\|(3)). .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBBIO_read_ex()\fR returns 1 if data was successfully read, and 0 otherwise. @@ -165,7 +170,7 @@ supported by adding a buffering BIO \fBBIO_f_buffer\fR\|(3) to the chain. .SH HISTORY .IX Header "HISTORY" \&\fBBIO_gets()\fR on 1.1.0 and older when called on \fBBIO_fd()\fR based BIO did not -keep the '\en' at the end of the line in the buffer. +keep the \*(Aq\en\*(Aq at the end of the line in the buffer. .PP \&\fBBIO_get_line()\fR was added in OpenSSL 3.0. .PP @@ -173,7 +178,7 @@ keep the '\en' at the end of the line in the buffer. \&\fIwritten\fR parameter of the function can be NULL since OpenSSL 3.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2000\-2023 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000\-2026 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |