Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libcrypto / man / BIO_s_bio.3
index 3b8056b..1bba0f1 100644 (file)
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 ..
 .\" 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<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote.  \*(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-
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds -- \(*W-
 .    ds R" ''
 'br\}
 .\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
 .\" 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 \{\
+.ie \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 ..
 .    nr % 0
 .    rr F
 .\}
-.\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+.    de IX
+..
+.\}
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 .\" ========================================================================
 .\"
 .IX Title "BIO_s_bio 3"
-.TH BIO_s_bio 3 "2008-09-27" "0.9.8i" "OpenSSL"
+.TH BIO_s_bio 3 "2009-01-11" "0.9.8j" "OpenSSL"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
 .SH "NAME"
 BIO_s_bio, BIO_make_bio_pair, BIO_destroy_bio_pair, BIO_shutdown_wr, 
 BIO_set_write_buf_size, BIO_get_write_buf_size, BIO_new_bio_pair,
@@ -139,41 +146,25 @@ BIO_ctrl_get_read_request, BIO_ctrl_reset_read_request \- BIO pair BIO
 .IX Header "SYNOPSIS"
 .Vb 1
 \& #include <openssl/bio.h>
-.Ve
-.PP
-.Vb 1
+\&
 \& BIO_METHOD *BIO_s_bio(void);
-.Ve
-.PP
-.Vb 2
+\&
 \& #define BIO_make_bio_pair(b1,b2)   (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
 \& #define BIO_destroy_bio_pair(b)    (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
-.Ve
-.PP
-.Vb 1
+\&
 \& #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
-.Ve
-.PP
-.Vb 2
+\&
 \& #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
 \& #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
-.Ve
-.PP
-.Vb 1
+\&
 \& int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, BIO **bio2, size_t writebuf2);
-.Ve
-.PP
-.Vb 2
+\&
 \& #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
 \& size_t BIO_ctrl_get_write_guarantee(BIO *b);
-.Ve
-.PP
-.Vb 2
+\&
 \& #define BIO_get_read_request(b)    (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
 \& size_t BIO_ctrl_get_read_request(BIO *b);
-.Ve
-.PP
-.Vb 1
+\&
 \& int BIO_ctrl_reset_read_request(BIO *b);
 .Ve
 .SH "DESCRIPTION"
@@ -210,7 +201,7 @@ up any half of the pair will automatically destroy the association.
 \&\fIBIO_shutdown_wr()\fR is used to close down a \s-1BIO\s0 \fBb\fR. After this call no further
 writes on \s-1BIO\s0 \fBb\fR are allowed (they will return an error). Reads on the other
 half of the pair will return any pending data or \s-1EOF\s0 when all pending data has
-been read. 
+been read.
 .PP
 \&\fIBIO_set_write_buf_size()\fR sets the write buffer size of \s-1BIO\s0 \fBb\fR to \fBsize\fR.
 If the size is not initialized a default value is used. This is currently
@@ -274,7 +265,7 @@ locations for \fBbio1\fR and \fBbio2\fR. Check the error stack for more informat
 .IX Header "EXAMPLE"
 The \s-1BIO\s0 pair can be used to have full control over the network access of an
 application. The application can call \fIselect()\fR on the socket as required
-without having to go through the SSL\-interface.
+without having to go through the SSL-interface.
 .PP
 .Vb 6
 \& BIO *internal_bio, *network_bio;
@@ -283,21 +274,17 @@ without having to go through the SSL\-interface.
 \& SSL_set_bio(ssl, internal_bio, internal_bio);
 \& SSL_operations();
 \& ...
-.Ve
-.PP
-.Vb 9
-\& application |   TLS-engine
+\&
+\& application |   TLS\-engine
 \&    |        |
-\&    +----------> SSL_operations()
+\&    +\-\-\-\-\-\-\-\-\-\-> SSL_operations()
 \&             |     /\e    ||
 \&             |     ||    \e/
-\&             |   BIO-pair (internal_bio)
-\&    +----------< BIO-pair (network_bio)
+\&             |   BIO\-pair (internal_bio)
+\&    +\-\-\-\-\-\-\-\-\-\-< BIO\-pair (network_bio)
 \&    |        |
 \&  socket     |
-.Ve
-.PP
-.Vb 4
+\&
 \&  ...
 \&  SSL_free(ssl);                /* implicitly frees internal_bio */
 \&  BIO_free(network_bio);