Add documentation for -starttls (s_client) and -id_prefix (s_server).
[openssl.git] / doc / crypto / BIO_read.pod
index e7eb5ea0450512a3b2d090ac58b26625675e6c45..b34528104ddf248813b68c666111f0316986aefc 100644 (file)
@@ -2,16 +2,16 @@
 
 =head1 NAME
 
-       BIO_read, BIO_write, BIO_gets, BIO_puts - BIO I/O functions
+BIO_read, BIO_write, BIO_gets, BIO_puts - BIO I/O functions
 
 =head1 SYNOPSIS
 
  #include <openssl/bio.h>
 
-int    BIO_read(BIO *b, void *buf, int len);
-int    BIO_gets(BIO *b,char *buf, int size);
-int    BIO_write(BIO *b, const void *buf, int len);
-int    BIO_puts(BIO *b,const char *buf);
+ int   BIO_read(BIO *b, void *buf, int len);
+ int   BIO_gets(BIO *b,char *buf, int size);
+ int   BIO_write(BIO *b, const void *buf, int len);
+ int   BIO_puts(BIO *b,const char *buf);
 
 =head1 DESCRIPTION
 
@@ -43,8 +43,8 @@ it may merely be an indication that no data is currently available and that
 the application should retry the operation later.
 
 One technique sometimes used with blocking sockets is to use a system call
-(such as select(), poll() or eqivalent) to determine when data is available
-and then call read() to read the data. The eqivalent with BIOs (that is call
+(such as select(), poll() or equivalent) to determine when data is available
+and then call read() to read the data. The equivalent with BIOs (that is call
 select() on the underlying I/O structure and then call BIO_read() to
 read the data) should B<not> be used because a single call to BIO_read()
 can cause several reads (and writes in the case of SSL BIOs) on the underlying
@@ -52,7 +52,7 @@ I/O structure and may block as a result. Instead select() (or equivalent)
 should be combined with non blocking I/O so successive reads will request
 a retry instead of blocking.
 
-See the L<BIO_should_retry(3)|BIO_should_retry(3)> for details of how to
+See L<BIO_should_retry(3)|BIO_should_retry(3)> for details of how to
 determine the cause of a retry and other I/O issues.
 
 If the BIO_gets() function is not supported by a BIO then it possible to
@@ -60,6 +60,7 @@ work around this by adding a buffering BIO L<BIO_f_buffer(3)|BIO_f_buffer(3)>
 to the chain.
 
 =head1 SEE ALSO
+
 L<BIO_should_retry(3)|BIO_should_retry(3)>
 
 TBA