Typos

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

diff --git a/doc/crypto/BIO_s_file.pod b/doc/crypto/BIO_s_file.pod
index 2331f46460168e24966a0d597c12bf169cd2138b..b2a29263f4cd45d5eff2c47f5c506c1407a9e56b 100644 (file)
--- a/doc/crypto/BIO_s_file.pod
+++ b/doc/crypto/BIO_s_file.pod
@@ -2,7 +2,9 @@
 
 =head1 NAME
 
-BIO_s_file - FILE bio.
+BIO_s_file, BIO_new_file, BIO_new_fp, BIO_set_fp, BIO_get_fp,
+BIO_read_filename, BIO_write_filename, BIO_append_filename,
+BIO_rw_filename - FILE bio
 
 =head1 SYNOPSIS
 
@@ -15,9 +17,6 @@ BIO_s_file - FILE bio.
  BIO_set_fp(BIO *b,FILE *fp, int flags);
  BIO_get_fp(BIO *b,FILE **fpp);
 
- BIO_seek(BIO *b,int offset);
- int BIO_tell(BIO *b);
-
  int BIO_read_filename(BIO *b, char *name)
  int BIO_write_filename(BIO *b, char *name)
  int BIO_append_filename(BIO *b, char *name)
@@ -35,8 +34,11 @@ 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_reset() attempts to change the file pointer to the start of file
+using fseek(stream, 0, 0).
+
+BIO_seek() sets the file pointer to position B<ofs> from start of file
+using fseek(stream, ofs, 0).
 
 BIO_eof() calls feof().
 
@@ -103,7 +105,7 @@ Alternative technique:
  BIO *out;
  out = BIO_new(BIO_s_file());
  if(out == NULL) /* Error ... */
- if(!BIO_read_filename(out, "filename.txt")) /* Error ... */
+ if(!BIO_write_filename(out, "filename.txt")) /* Error ... */
  BIO_printf(out, "Hello World\n");
  BIO_free(out);
 
@@ -125,6 +127,18 @@ BIO_tell() returns the current file position.
 BIO_read_filename(), BIO_write_filename(),  BIO_append_filename() and
 BIO_rw_filename() return 1 for success or 0 for failure.
 
+=head1 BUGS
+
+BIO_reset() and BIO_seek() are implemented using fseek() on the underlying
+stream. The return value for fseek() is 0 for success or -1 if an error
+occurred this differs from other types of BIO which will typically return
+1 for success and a non positive value if an error occurred.
+
 =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_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)>