summaryrefslogtreecommitdiffstats
path: root/doc/crypto/BIO_s_file.pod
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2000-09-16 23:32:33 +0000
committerRichard Levitte <levitte@openssl.org>2000-09-16 23:32:33 +0000
commitda542e1bf762507bc6630847e4c3dd18de81359d (patch)
treebb525a055ebaab7f5db17c827e08b856f967acaa /doc/crypto/BIO_s_file.pod
parent93fe6e13a379c5902dddb49f3d331e795d049a43 (diff)
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).
Diffstat (limited to 'doc/crypto/BIO_s_file.pod')
-rw-r--r--doc/crypto/BIO_s_file.pod35
1 files changed, 20 insertions, 15 deletions
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<mode> the meaning
of B<mode> 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<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>, TBA
+L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>,
+L<BIO_reset(3)|BIO_reset(3)>, L<BIO_flush(3)|BIO_flush(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)>