diff options
author | 2014-10-12 09:33:03 +0000 | |
---|---|---|
committer | 2014-10-12 09:33:03 +0000 | |
commit | 709d8cd0fe4332147f808dafbb149a4bf76a0e56 (patch) | |
tree | b2433e032090fcfcf4c9645e388fdfd0b47eb254 /lib/libssl/src/doc/ssl/SSL_rstate_string.pod | |
parent | Logitech Webcam C310 just works with uvideo(4), add it (diff) | |
download | wireguard-openbsd-709d8cd0fe4332147f808dafbb149a4bf76a0e56.tar.xz wireguard-openbsd-709d8cd0fe4332147f808dafbb149a4bf76a0e56.zip |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'lib/libssl/src/doc/ssl/SSL_rstate_string.pod')
-rw-r--r-- | lib/libssl/src/doc/ssl/SSL_rstate_string.pod | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/lib/libssl/src/doc/ssl/SSL_rstate_string.pod b/lib/libssl/src/doc/ssl/SSL_rstate_string.pod deleted file mode 100644 index af726422103..00000000000 --- a/lib/libssl/src/doc/ssl/SSL_rstate_string.pod +++ /dev/null @@ -1,60 +0,0 @@ -=pod - -=head1 NAME - -SSL_rstate_string, SSL_rstate_string_long - get textual description of state of -an SSL object during read operation - -=head1 SYNOPSIS - - #include <openssl/ssl.h> - - const char *SSL_rstate_string(SSL *ssl); - const char *SSL_rstate_string_long(SSL *ssl); - -=head1 DESCRIPTION - -SSL_rstate_string() returns a 2 letter string indicating the current read state -of the SSL object B<ssl>. - -SSL_rstate_string_long() returns a string indicating the current read state of -the SSL object B<ssl>. - -=head1 NOTES - -When performing a read operation, the SSL/TLS engine must parse the record, -consisting of header and body. When working in a blocking environment, -SSL_rstate_string[_long]() should always return "RD"/"read done". - -This function should only seldom be needed in applications. - -=head1 RETURN VALUES - -SSL_rstate_string() and SSL_rstate_string_long() can return the following -values: - -=over 4 - -=item "RH"/"read header" - -The header of the record is being evaluated. - -=item "RB"/"read body" - -The body of the record is being evaluated. - -=item "RD"/"read done" - -The record has been completely processed. - -=item "unknown"/"unknown" - -The read state is unknown. This should never happen. - -=back - -=head1 SEE ALSO - -L<ssl(3)|ssl(3)> - -=cut |