From 5af30545c000c195ca6e44f207da004e5780ddb5 Mon Sep 17 00:00:00 2001
From: schwarze <>
Date: Sat, 5 Nov 2016 15:32:20 +0000
Subject: move manual pages from doc/ to man/ for consistency with other
 libraries, in particular considering that there are unrelated files in doc/;
 requested by jsing@ and beck@

---
 src/lib/libssl/man/SSL_pending.3 | 44 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 src/lib/libssl/man/SSL_pending.3

(limited to 'src/lib/libssl/man/SSL_pending.3')

diff --git a/src/lib/libssl/man/SSL_pending.3 b/src/lib/libssl/man/SSL_pending.3
new file mode 100644
index 0000000000..dadeec4b92
--- /dev/null
+++ b/src/lib/libssl/man/SSL_pending.3
@@ -0,0 +1,44 @@
+.\"
+.\"	$OpenBSD: SSL_pending.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $
+.\"
+.Dd $Mdocdate: November 5 2016 $
+.Dt SSL_PENDING 3
+.Os
+.Sh NAME
+.Nm SSL_pending
+.Nd obtain number of readable bytes buffered in an SSL object
+.Sh SYNOPSIS
+.In openssl/ssl.h
+.Ft int
+.Fn SSL_pending "const SSL *ssl"
+.Sh DESCRIPTION
+.Fn SSL_pending
+returns the number of bytes which are available inside
+.Fa ssl
+for immediate read.
+.Sh NOTES
+Data are received in blocks from the peer.
+Therefore data can be buffered inside
+.Fa ssl
+and are ready for immediate retrieval with
+.Xr SSL_read 3 .
+.Sh RETURN VALUES
+The number of bytes pending is returned.
+.Sh SEE ALSO
+.Xr ssl 3 ,
+.Xr SSL_read 3
+.Sh BUGS
+.Fn SSL_pending
+takes into account only bytes from the TLS/SSL record that is currently being
+processed (if any).
+If the
+.Vt SSL
+object's
+.Em read_ahead
+flag is set, additional protocol bytes may have been read containing more
+TLS/SSL records; these are ignored by
+.Fn SSL_pending .
+.Pp
+Up to OpenSSL 0.9.6,
+.Fn SSL_pending
+does not check if the record type of pending data is application data.
-- 
cgit v1.2.3-55-g6feb