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 | |
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')
-rw-r--r-- | doc/crypto/BIO_ctrl.pod | 5 | ||||
-rw-r--r-- | doc/crypto/BIO_f_base64.pod | 2 | ||||
-rw-r--r-- | doc/crypto/BIO_f_cipher.pod | 2 | ||||
-rw-r--r-- | doc/crypto/BIO_f_md.pod | 2 | ||||
-rw-r--r-- | doc/crypto/BIO_s_bio.pod | 5 | ||||
-rw-r--r-- | doc/crypto/BIO_s_connect.pod | 5 | ||||
-rw-r--r-- | doc/crypto/BIO_s_fd.pod | 12 | ||||
-rw-r--r-- | doc/crypto/BIO_s_file.pod | 19 | ||||
-rw-r--r-- | doc/crypto/BIO_s_mem.pod | 3 | ||||
-rw-r--r-- | doc/crypto/BIO_s_socket.pod | 2 | ||||
-rw-r--r-- | doc/crypto/BIO_set_callback.pod | 3 | ||||
-rw-r--r-- | doc/crypto/BIO_should_retry.pod | 4 |
12 files changed, 29 insertions, 35 deletions
diff --git a/doc/crypto/BIO_ctrl.pod b/doc/crypto/BIO_ctrl.pod index c00fda9b08..5ef27f487e 100644 --- a/doc/crypto/BIO_ctrl.pod +++ b/doc/crypto/BIO_ctrl.pod @@ -2,7 +2,10 @@ =head1 NAME -BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl - BIO control operations +BIO_ctrl, BIO_callback_ctrl, BIO_ptr_ctrl, BIO_int_ctrl, BIO_reset, +BIO_flush, BIO_eof, BIO_set_close, BIO_get_close, BIO_pending, +BIO_wpending, BIO_ctrl_pending, BIO_ctrl_wpending, BIO_get_info_callback, +BIO_set_info_callback - BIO control operations =head1 SYNOPSIS diff --git a/doc/crypto/BIO_f_base64.pod b/doc/crypto/BIO_f_base64.pod index 5ab702cb9e..fdb603b38e 100644 --- a/doc/crypto/BIO_f_base64.pod +++ b/doc/crypto/BIO_f_base64.pod @@ -2,7 +2,7 @@ =head1 NAME -BIO_f_base64 - base64 BIO +BIO_f_base64 - base64 BIO filter =head1 SYNOPSIS diff --git a/doc/crypto/BIO_f_cipher.pod b/doc/crypto/BIO_f_cipher.pod index b0bc00daf0..e024865cd4 100644 --- a/doc/crypto/BIO_f_cipher.pod +++ b/doc/crypto/BIO_f_cipher.pod @@ -2,7 +2,7 @@ =head1 NAME -BIO_f_cipher - cipher BIO +BIO_f_cipher, BIO_set_cipher, BIO_get_cipher_status, BIO_get_cipher_ctx - cipher BIO filter =head1 SYNOPSIS diff --git a/doc/crypto/BIO_f_md.pod b/doc/crypto/BIO_f_md.pod index 74e46bb1d2..0845d2bc2b 100644 --- a/doc/crypto/BIO_f_md.pod +++ b/doc/crypto/BIO_f_md.pod @@ -2,7 +2,7 @@ =head1 NAME -BIO_f_md - message digest BIO +BIO_f_md, BIO_set_md, BIO_get_md, BIO_get_md_ctx - message digest BIO filter =head1 SYNOPSIS diff --git a/doc/crypto/BIO_s_bio.pod b/doc/crypto/BIO_s_bio.pod index 5867bc5a8f..bfcb975ef6 100644 --- a/doc/crypto/BIO_s_bio.pod +++ b/doc/crypto/BIO_s_bio.pod @@ -2,7 +2,10 @@ =head1 NAME -BIO_s_bio - BIO pair +BIO_s_bio, BIO_make_bio_pair, BIO_destroy_bio_pair, BIO_set_write_buf_size, +BIO_get_write_buf_size, BIO_new_bio_pair, BIO_get_write_guarantee, +BIO_ctrl_get_write_guarantee, BIO_get_read_request, BIO_ctrl_get_read_request, +BIO_ctrl_reset_read_request - BIO pair BIO =head1 SYNOPSIS diff --git a/doc/crypto/BIO_s_connect.pod b/doc/crypto/BIO_s_connect.pod index 4ee99216e9..07370ab250 100644 --- a/doc/crypto/BIO_s_connect.pod +++ b/doc/crypto/BIO_s_connect.pod @@ -2,7 +2,10 @@ =head1 NAME -BIO_s_connect - connect BIO +BIO_s_connect, BIO_set_conn_hostname, BIO_set_conn_port, +BIO_set_conn_ip, BIO_set_conn_int_port, BIO_get_conn_hostname, +BIO_get_conn_port, BIO_get_conn_ip, BIO_get_conn_int_port, +BIO_set_nbio, BIO_do_connect - connect BIO =head1 SYNOPSIS diff --git a/doc/crypto/BIO_s_fd.pod b/doc/crypto/BIO_s_fd.pod index e5b9c811a6..da08ba1023 100644 --- a/doc/crypto/BIO_s_fd.pod +++ b/doc/crypto/BIO_s_fd.pod @@ -2,7 +2,7 @@ =head1 NAME -BIO_s_fd - file descriptor BIO +BIO_s_fd, BIO_set_fd, BIO_get_fd, BIO_new_fd - file descriptor BIO =head1 SYNOPSIS @@ -10,9 +10,6 @@ BIO_s_fd - file descriptor BIO BIO_METHOD * BIO_s_fd(void); - #define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL) - #define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL) - #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd) #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) @@ -32,11 +29,6 @@ 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_seek() sets the file pointer to position B<ofs> from start of file -using lseek(fd, ofs, 0). - -BIO_tell() returns the current file position by calling lseek(fd, 0, 1). - BIO_set_fd() sets the file descriptor of BIO B<b> to B<fd> and the close flag to B<c>. @@ -85,4 +77,4 @@ This is a file descriptor BIO version of "Hello World": =head1 SEE ALSO -TBA +L<BIO_seek(3)|BIO_seek(3)>, L<BIO_tell(3)|BIO_tell(3)>, TBA 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 diff --git a/doc/crypto/BIO_s_mem.pod b/doc/crypto/BIO_s_mem.pod index 47f64b0f33..0c5f58ed1b 100644 --- a/doc/crypto/BIO_s_mem.pod +++ b/doc/crypto/BIO_s_mem.pod @@ -2,7 +2,8 @@ =head1 NAME -BIO_s_mem - memory BIO +BIO_s_mem, BIO_set_mem_eof_return, BIO_get_mem_data, BIO_set_mem_buf, +BIO_get_mem_ptr, BIO_new_mem_buf - memory BIO =head1 SYNOPSIS diff --git a/doc/crypto/BIO_s_socket.pod b/doc/crypto/BIO_s_socket.pod index 54f2b2343b..ec450e11f1 100644 --- a/doc/crypto/BIO_s_socket.pod +++ b/doc/crypto/BIO_s_socket.pod @@ -2,7 +2,7 @@ =head1 NAME -BIO_s_socket - socket BIO +BIO_s_socket, BIO_new_socket - socket BIO =head1 SYNOPSIS diff --git a/doc/crypto/BIO_set_callback.pod b/doc/crypto/BIO_set_callback.pod index 90cde79ad0..9b6961ca8d 100644 --- a/doc/crypto/BIO_set_callback.pod +++ b/doc/crypto/BIO_set_callback.pod @@ -2,7 +2,8 @@ =head1 NAME -BIO_set_callback, BIO_get_callback - BIO callback +BIO_set_callback, BIO_get_callback, BIO_set_callback_arg, BIO_get_callback_arg, +BIO_debug_callback - BIO callback functions =head1 SYNOPSIS diff --git a/doc/crypto/BIO_should_retry.pod b/doc/crypto/BIO_should_retry.pod index a0cfbc4076..539c391272 100644 --- a/doc/crypto/BIO_should_retry.pod +++ b/doc/crypto/BIO_should_retry.pod @@ -2,7 +2,9 @@ =head1 NAME -BIO_should_retry, BIO_should_read, BIO_should_write - BIO retry functions +BIO_should_retry, BIO_should_read, BIO_should_write, +BIO_should_io_special, BIO_retry_type, BIO_should_retry, +BIO_get_retry_BIO, BIO_get_retry_reason - BIO retry functions =head1 SYNOPSIS |