diff options
| author | Richard Levitte <levitte@openssl.org> | 2000-09-14 20:24:56 +0000 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2000-09-14 20:24:56 +0000 |
| commit | 8eec1389fb8e649fe971046b4108a66544955017 (patch) | |
| tree | e26acf662ce80c37d2fe2265c14859897427d716 /doc/crypto/BIO_s_file.pod | |
| parent | e38dabbc0c678739d79971c04f2852b71f90a59f (diff) | |
BIO_seed() and BIO_tell() were documented in two other documents,
which is redundant. They are now in their own document.
Also, in the name section, all the functions described shoud be
enumerated. This will also make it much simpler to generate softlinks
name like each function to man-pages containing the info.
Diffstat (limited to 'doc/crypto/BIO_s_file.pod')
| -rw-r--r-- | doc/crypto/BIO_s_file.pod | 19 |
1 files changed, 4 insertions, 15 deletions
diff --git a/doc/crypto/BIO_s_file.pod b/doc/crypto/BIO_s_file.pod index 2331f46460..10fe4933c7 100644 --- 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) @@ -57,11 +56,6 @@ 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. @@ -117,14 +111,9 @@ 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 SEE ALSO -TBA +L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>, TBA |