summaryrefslogtreecommitdiff
path: root/secure/lib/libssl/man/SSL_clear.3
diff options
context:
space:
mode:
authorSimon L. B. Nielsen <simon@FreeBSD.org>2006-07-29 19:41:41 +0000
committerSimon L. B. Nielsen <simon@FreeBSD.org>2006-07-29 19:41:41 +0000
commite7926dc0a540b28f570a97e4e0d6c614490141cc (patch)
treee9b6155f49a3b6073b95b808e1e0a1ec5489a21f /secure/lib/libssl/man/SSL_clear.3
parent9ceddbd532223cd33c22b786a2994dee68be9c8e (diff)
downloadsrc-test2-e7926dc0a540b28f570a97e4e0d6c614490141cc.tar.gz
src-test2-e7926dc0a540b28f570a97e4e0d6c614490141cc.zip
Notes
Diffstat (limited to 'secure/lib/libssl/man/SSL_clear.3')
-rw-r--r--secure/lib/libssl/man/SSL_clear.359
1 files changed, 25 insertions, 34 deletions
diff --git a/secure/lib/libssl/man/SSL_clear.3 b/secure/lib/libssl/man/SSL_clear.3
index 26afe9eee008..0defcb1d2754 100644
--- a/secure/lib/libssl/man/SSL_clear.3
+++ b/secure/lib/libssl/man/SSL_clear.3
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:47:44 2003
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
-.\" ======================================================================
+.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
@@ -15,12 +14,6 @@
.if t .sp .5v
.if n .sp
..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
.de Vb \" Begin verbatim text
.ft CW
.nf
@@ -28,15 +21,14 @@
..
.de Ve \" End verbatim text
.ft R
-
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available. \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
@@ -56,10 +48,10 @@
. ds R" ''
'br\}
.\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD. Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
@@ -68,14 +60,13 @@
. rr F
.\}
.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
-.bd B 3
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
@@ -135,18 +126,18 @@
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
.\"
.IX Title "SSL_clear 3"
-.TH SSL_clear 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
+.TH SSL_clear 3 "2006-07-29" "0.9.8b" "OpenSSL"
.SH "NAME"
-SSL_clear \- reset \s-1SSL\s0 object to allow another connection
+SSL_clear \- reset SSL object to allow another connection
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
.Ve
+.PP
.Vb 1
\& int SSL_clear(SSL *ssl);
.Ve
@@ -160,8 +151,8 @@ SSL_clear is used to prepare an \s-1SSL\s0 object for a new connection. While al
settings are kept, a side effect is the handling of the current \s-1SSL\s0 session.
If a session is still \fBopen\fR, it is considered bad and will be removed
from the session cache, as required by \s-1RFC2246\s0. A session is considered open,
-if SSL_shutdown(3) was not called for the connection
-or at least SSL_set_shutdown(3) was used to
+if \fISSL_shutdown\fR\|(3) was not called for the connection
+or at least \fISSL_set_shutdown\fR\|(3) was used to
set the \s-1SSL_SENT_SHUTDOWN\s0 state.
.PP
If a session was closed cleanly, the session object will be kept and all
@@ -170,7 +161,7 @@ used during the session will be kept for the next handshake. So if the
session was a TLSv1 session, a \s-1SSL\s0 client object will use a TLSv1 client
method for the next handshake and a \s-1SSL\s0 server object will use a TLSv1
server method, even if SSLv23_*_methods were chosen on startup. This
-will might lead to connection failures (see SSL_new(3))
+will might lead to connection failures (see \fISSL_new\fR\|(3))
for a description of the method's properties.
.SH "WARNINGS"
.IX Header "WARNINGS"
@@ -180,18 +171,18 @@ reset operation however keeps several settings of the last sessions
handshake). It only makes sense when opening a new session (or reusing
an old one) with the same peer that shares these settings.
\&\fISSL_clear()\fR is not a short form for the sequence
-SSL_free(3); SSL_new(3); .
+\&\fISSL_free\fR\|(3); \fISSL_new\fR\|(3); .
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
The following return values can occur:
-.Ip "0" 4
+.IP "0" 4
The \fISSL_clear()\fR operation could not be performed. Check the error stack to
find out the reason.
-.Ip "1" 4
+.IP "1" 4
.IX Item "1"
The \fISSL_clear()\fR operation was successful.
.PP
-SSL_new(3), SSL_free(3),
-SSL_shutdown(3), SSL_set_shutdown(3),
-SSL_CTX_set_options(3), ssl(3),
-SSL_CTX_set_client_cert_cb(3)
+\&\fISSL_new\fR\|(3), \fISSL_free\fR\|(3),
+\&\fISSL_shutdown\fR\|(3), \fISSL_set_shutdown\fR\|(3),
+\&\fISSL_CTX_set_options\fR\|(3), \fIssl\fR\|(3),
+\&\fISSL_CTX_set_client_cert_cb\fR\|(3)