RT3462: Document actions when data==NULL

[openssl.git] / doc / crypto / BIO_s_fd.pod

diff --git a/doc/crypto/BIO_s_fd.pod b/doc/crypto/BIO_s_fd.pod
index 5c7c55fa896ca3043fe22bbe0a39793c8c260a51..b1de1d1015496b587f2a4ac690389892aa1721c3 100644 (file)
--- a/doc/crypto/BIO_s_fd.pod
+++ b/doc/crypto/BIO_s_fd.pod
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-       BIO_s_fd - file descriptor BIO
+BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO
 
 =head1 SYNOPSIS
 
@@ -10,9 +10,6 @@
 
  BIO_METHOD *  BIO_s_fd(void);
 
- #define BIO_seek(b,ofs)       (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
- #define BIO_tell(b)           (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
-
  #define BIO_set_fd(b,fd,c)    BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
  #define BIO_get_fd(b,c)       BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
 
@@ -20,7 +17,7 @@
 
 =head1 DESCRIPTION
 
-BIO_f_fd() returns the file descriptor BIO method. This is a wrapper
+BIO_s_fd() returns the file descriptor BIO method. This is a wrapper
 round the platforms file descriptor routines such as read() and write().
 
 BIO_read() and BIO_write() read or write the underlying descriptor.
@@ -44,11 +41,11 @@ BIO_get_fd() places the file descriptor in B<c> if it is not NULL, it also
 returns the file descriptor. If B<c> is not NULL it should be of type
 (int *).
 
-BIO_new_fd() returns a file desciptor BIO using B<fd> and B<close_flag>.
+BIO_new_fd() returns a file descriptor BIO using B<fd> and B<close_flag>.
 
 =head1 NOTES
 
-The behaviour of BIO_read() and BIO_write() depends on the behaviour of the
+The behaviour of BIO_read() and BIO_write() depends on the behavior of the
 platforms read() and write() calls on the descriptor. If the underlying 
 file descriptor is in a non blocking mode then the BIO will behave in the
 manner described in the L<BIO_read(3)|BIO_read(3)> and L<BIO_should_retry(3)|BIO_should_retry(3)>
@@ -69,7 +66,7 @@ behaviour.
 BIO_set_fd() always returns 1.
 
 BIO_get_fd() returns the file descriptor or -1 if the BIO has not
-been initialised.
+been initialized.
 
 BIO_new_fd() returns the newly allocated BIO or NULL is an error
 occurred.
@@ -85,4 +82,8 @@ This is a file descriptor BIO version of "Hello World":
 
 =head1 SEE ALSO
 
-TBA
+L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>,
+L<BIO_reset(3)|BIO_reset(3)>, L<BIO_read(3)|BIO_read(3)>,
+L<BIO_write(3)|BIO_write(3)>, L<BIO_puts(3)|BIO_puts(3)>,
+L<BIO_gets(3)|BIO_gets(3)>, L<BIO_printf(3)|BIO_printf(3)>,
+L<BIO_set_close(3)|BIO_set_close(3)>, L<BIO_get_close(3)|BIO_get_close(3)>