From da542e1bf762507bc6630847e4c3dd18de81359d Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Sat, 16 Sep 2000 23:32:33 +0000 Subject: Move text that isn't really descriptions of the functions in the page to the NOTES section, and add references to the functions mentioned (and perhaps a few more). --- doc/crypto/BIO_s_fd.pod | 29 ++++++++++++++--------------- doc/crypto/BIO_s_file.pod | 35 ++++++++++++++++++++--------------- 2 files changed, 34 insertions(+), 30 deletions(-) (limited to 'doc/crypto') diff --git a/doc/crypto/BIO_s_fd.pod b/doc/crypto/BIO_s_fd.pod index 4681e5e13b..61789fd2c1 100644 --- a/doc/crypto/BIO_s_fd.pod +++ b/doc/crypto/BIO_s_fd.pod @@ -20,15 +20,6 @@ BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO 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. -BIO_puts() is supported but BIO_gets() is not. - -If the close flag is set then then close() is called on the underlying -file descriptor when the BIO is freed. - -BIO_reset() attempts to change the file pointer to the start of file -using lseek(fd, 0, 0). - BIO_set_fd() sets the file descriptor of BIO B to B and the close flag to B. @@ -40,6 +31,15 @@ BIO_new_fd() returns a file descriptor BIO using B and B. =head1 NOTES +If the close flag is set then then close() is called on the underlying +file descriptor when the BIO is freed. + +BIO_reset() attempts to change the file pointer to the start of file +using lseek(fd, 0, 0). + +BIO_read() and BIO_write() read or write the underlying descriptor. +BIO_puts() is supported but BIO_gets() is not. + 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 @@ -53,11 +53,6 @@ instead. BIO_s_fd() returns the file descriptor BIO method. -BIO_reset() returns zero for success and -1 if an error occurred. -BIO_seek() and BIO_tell() return the current file position or -1 -is an error occurred. These values reflect the underlying lseek() -behaviour. - BIO_set_fd() always returns 1. BIO_get_fd() returns the file descriptor or -1 if the BIO has not @@ -77,4 +72,8 @@ This is a file descriptor BIO version of "Hello World": =head1 SEE ALSO -L, L, TBA +L, L, +L, L, +L, L, +L, L, +L, L diff --git a/doc/crypto/BIO_s_file.pod b/doc/crypto/BIO_s_file.pod index 10fe4933c7..166734b0bc 100644 --- a/doc/crypto/BIO_s_file.pod +++ b/doc/crypto/BIO_s_file.pod @@ -28,20 +28,6 @@ BIO_s_file() returns the BIO file method. As its name implies it is a wrapper round the stdio FILE structure and it is a source/sink BIO. -Calls to BIO_read() and BIO_write() read and write data to the -underlying stream. BIO_gets() and BIO_puts() are supported on file BIOs. - -BIO_flush() on a file BIO calls the fflush() function on the wrapped -stream. - -BIO_reset() on a file BIO calls fseek() to reset the position indicator -to the start of the file. - -BIO_eof() calls feof(). - -Setting the BIO_CLOSE flag calls fclose() on the stream when the BIO -is freed. - BIO_new_file() creates a new file BIO with mode B the meaning of B is the same as the stdio function fopen(). The BIO_CLOSE flag is set on the returned BIO. @@ -62,6 +48,20 @@ reading, writing, append or read write respectively. =head1 NOTES +Calls to BIO_read() and BIO_write() read and write data to the +underlying stream. BIO_gets() and BIO_puts() are supported on file BIOs. + +BIO_flush() on a file BIO calls the fflush() function on the wrapped +stream. + +BIO_reset() on a file BIO calls fseek() to reset the position indicator +to the start of the file. + +BIO_eof() calls feof(). + +Setting the BIO_CLOSE flag calls fclose() on the stream when the BIO +is freed. + When wrapping stdout, stdin or stderr the underlying stream should not normally be closed so the BIO_NOCLOSE flag should be set. @@ -116,4 +116,9 @@ BIO_rw_filename() return 1 for success or 0 for failure. =head1 SEE ALSO -L, L, TBA +L, L, +L, L, +L, +L, L, +L, L, +L, L -- cgit v1.2.3