summaryrefslogtreecommitdiff
path: root/secure/lib/libssl/man/SSL_write.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libssl/man/SSL_write.3')
-rw-r--r--secure/lib/libssl/man/SSL_write.347
1 files changed, 21 insertions, 26 deletions
diff --git a/secure/lib/libssl/man/SSL_write.3 b/secure/lib/libssl/man/SSL_write.3
index 6fef4834b658f..f2140428e143b 100644
--- a/secure/lib/libssl/man/SSL_write.3
+++ b/secure/lib/libssl/man/SSL_write.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
+.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -46,7 +46,7 @@
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
@@ -54,20 +54,16 @@
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
-.nr rF 0
-.if \n(.g .if rF .nr rF 1
-.if (\n(rF:(\n(.g==0)) \{
-. if \nF \{
-. de IX
-. tm Index:\\$1\t\\n%\t"\\$2"
+.if !\nF .nr F 0
+.if \nF>0 \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
..
-. if !\nF==2 \{
-. nr % 0
-. nr F 2
-. \}
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
. \}
.\}
-.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
@@ -133,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "SSL_write 3"
-.TH SSL_write 3 "2016-09-26" "1.0.2j" "OpenSSL"
+.TH SSL_write 3 "2017-01-26" "1.0.2k" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -205,24 +201,23 @@ undefined.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
The following return values can occur:
-.IP ">0" 4
-.IX Item ">0"
+.IP "> 0" 4
+.IX Item "> 0"
The write operation was successful, the return value is the number of
bytes actually written to the \s-1TLS/SSL\s0 connection.
-.IP "0" 4
-The write operation was not successful. Probably the underlying connection
-was closed. Call \fISSL_get_error()\fR with the return value \fBret\fR to find out,
-whether an error occurred or the connection was shut down cleanly
-(\s-1SSL_ERROR_ZERO_RETURN\s0).
+.IP "<= 0" 4
+.IX Item "<= 0"
+The write operation was not successful, because either the connection was
+closed, an error occurred or action must be taken by the calling process.
+Call \fISSL_get_error()\fR with the return value \fBret\fR to find out the reason.
.Sp
SSLv2 (deprecated) does not support a shutdown alert protocol, so it can
only be detected, whether the underlying connection was closed. It cannot
be checked, why the closure happened.
-.IP "<0" 4
-.IX Item "<0"
-The write operation was not successful, because either an error occurred
-or action must be taken by the calling process. Call \fISSL_get_error()\fR with the
-return value \fBret\fR to find out the reason.
+.Sp
+Old documentation indicated a difference between 0 and \-1, and that \-1 was
+retryable.
+You should instead call \fISSL_get_error()\fR to find out if it's retryable.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fISSL_get_error\fR\|(3), \fISSL_read\fR\|(3),