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 672dc2f48de07ef4ce7e1d83cf2857fa0ffb150c..b2a29263f4cd45d5eff2c47f5c506c1407a9e56b 100644 (file)
--- a/doc/crypto/BIO_s_file.pod
+++ b/doc/crypto/BIO_s_file.pod
@@ -34,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().
 
@@ -56,6 +59,11 @@ meaning as in BIO_new_fp(), it is a macro.
 
 BIO_get_fp() retrieves the fp of a file BIO, it is a macro.
 
+BIO_seek() is a macro that sets the position pointer to B<offset> bytes
+from the start of file.
+
+BIO_tell() returns the value of the position pointer.
+
 BIO_read_filename(), BIO_write_filename(), BIO_append_filename() and
 BIO_rw_filename() set the file BIO B<b> to use file B<name> for
 reading, writing, append or read write respectively.
@@ -66,7 +74,7 @@ When wrapping stdout, stdin or stderr the underlying stream should not
 normally be closed so the BIO_NOCLOSE flag should be set.
 
 Because the file BIO calls the underlying stdio functions any quirks
-in stdio behavior will be mirrored by the corresponding BIO.
+in stdio behaviour will be mirrored by the corresponding BIO.
 
 =head1 EXAMPLES
 
@@ -97,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);
 
@@ -111,9 +119,26 @@ occurred.
 BIO_set_fp() and BIO_get_fp() return 1 for success or 0 for failure
 (although the current implementation never return 0).
 
+BIO_seek() returns the same value as the underlying fseek() function:
+0 for success or -1 for failure.
+
+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
 
-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)>