diff options
| -rw-r--r-- | ares/ares_destroy.3 | 3 | ||||
| -rw-r--r-- | ares/ares_free_hostent.3 | 19 | ||||
| -rw-r--r-- | ares/ares_mkquery.3 | 3 | ||||
| -rw-r--r-- | ares/ares_process.3 | 9 | ||||
| -rw-r--r-- | ares/ares_timeout.3 | 6 |
5 files changed, 15 insertions, 25 deletions
diff --git a/ares/ares_destroy.3 b/ares/ares_destroy.3 index 7ed21e6fa..3014e055d 100644 --- a/ares/ares_destroy.3 +++ b/ares/ares_destroy.3 @@ -36,7 +36,8 @@ status of These calls give the callbacks a chance to clean up any state which might have been stored in their arguments. .SH SEE ALSO -.BR ares_init (3) +.BR ares_init (3), +.BR ares_cancel (3) .SH AUTHOR Greg Hudson, MIT Information Systems .br diff --git a/ares/ares_free_hostent.3 b/ares/ares_free_hostent.3 index 3068cfd35..82bbfb55c 100644 --- a/ares/ares_free_hostent.3 +++ b/ares/ares_free_hostent.3 @@ -28,21 +28,16 @@ The .I ares_free_hostent function frees a .B struct hostent -allocated by one of the functions -.I ares_parse_a_reply -or -.IR ares_parse_ptr_reply . +allocated by one of the functions \fIares_parse_a_reply(3)\fP or +\fIares_parse_ptr_reply(3)\fP. +.SH NOTES +It is not necessary (and is not correct) to free the host structure passed to +the callback functions for \fIares_gethostbyname(3)\fP or +\fIares_gethostbyaddr(3)\fP. The ares library will automatically free such +host structures when the callback returns. .SH SEE ALSO .BR ares_parse_a_reply (3), .BR ares_parse_ptr_reply (3) -.SH NOTES -It is not necessary (and is not correct) to free the host structure -passed to the callback functions for -.I ares_gethostbyname -or -.IR ares_gethostbyaddr . -The ares library will automatically free such host structures when the -callback returns. .SH AUTHOR Greg Hudson, MIT Information Systems .br diff --git a/ares/ares_mkquery.3 b/ares/ares_mkquery.3 index f2f5a49ce..613076bcf 100644 --- a/ares/ares_mkquery.3 +++ b/ares/ares_mkquery.3 @@ -50,8 +50,7 @@ stored in the variable pointed to by and the length of which will be stored in the variable pointed to by .IR buflen . It is the caller's responsibility to free this buffer using -.B ares_free_string -when it is no longer needed. +\fIares_free_string(3)\fP when it is no longer needed. .SH RETURN VALUES .B ares_mkquery can return any of the following values: diff --git a/ares/ares_process.3 b/ares/ares_process.3 index a707a41db..50216e144 100644 --- a/ares/ares_process.3 +++ b/ares/ares_process.3 @@ -35,13 +35,10 @@ The file descriptor sets pointed to by and .I write_fds should have file descriptors set in them according to whether the file -descriptors specified by -.BR ares_fds (3) -are ready for reading and writing. (The easiest way to determine this -information is to invoke +descriptors specified by \fIares_fds(3)\fP are ready for reading and writing. +(The easiest way to determine this information is to invoke .B select -with a timeout no greater than the timeout given by -.BR ares_timeout (3)). +with a timeout no greater than the timeout given by \fIares_timeout(3)\fP ). .PP The .B ares_process diff --git a/ares/ares_timeout.3 b/ares/ares_timeout.3 index 8c4596309..d5b52d013 100644 --- a/ares/ares_timeout.3 +++ b/ares/ares_timeout.3 @@ -27,10 +27,8 @@ ares_fds \- Get file descriptors to select on for name service .SH DESCRIPTION The .B ares_timeout -function determines the maximum time for which the caller should wait -before invoking -.BR ares_process (3) -to process timeouts. The parameter +function determines the maximum time for which the caller should wait before +invoking \fIares_process(3)\fP to process timeouts. The parameter .I maxtv specifies a existing maximum timeout, or .B NULL |