summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYang Tse <yangsita@gmail.com>2009-11-20 14:15:05 (GMT)
committerYang Tse <yangsita@gmail.com>2009-11-20 14:15:05 (GMT)
commitf854ecb90befef777b6907f76d35276633830be5 (patch)
treeb07cdbaefb62cd06f0d6e134c529098973fe398a
parent7a7befd37b57ffca6b28fc89c880f2c3d5452e63 (diff)
downloadc-ares-f854ecb90befef777b6907f76d35276633830be5.zip
c-ares-f854ecb90befef777b6907f76d35276633830be5.tar.gz
c-ares-f854ecb90befef777b6907f76d35276633830be5.tar.bz2
Sync man page with reality
-rw-r--r--ares_expand_name.34
-rw-r--r--ares_expand_string.34
-rw-r--r--ares_mkquery.34
-rw-r--r--ares_parse_aaaa_reply.36
-rw-r--r--ares_set_socket_callback.39
5 files changed, 16 insertions, 11 deletions
diff --git a/ares_expand_name.3 b/ares_expand_name.3
index 65f16eb..e960bd6 100644
--- a/ares_expand_name.3
+++ b/ares_expand_name.3
@@ -14,7 +14,7 @@
.\" this software for any purpose. It is provided "as is"
.\" without express or implied warranty.
.\"
-.TH ARES_EXPAND_NAME 3 "23 July 1998"
+.TH ARES_EXPAND_NAME 3 "20 Nov 2009"
.SH NAME
ares_expand_name \- Expand a DNS-encoded domain name
.SH SYNOPSIS
@@ -23,7 +23,7 @@ ares_expand_name \- Expand a DNS-encoded domain name
.PP
.B int ares_expand_name(const unsigned char *\fIencoded\fP,
.B const unsigned char *\fIabuf\fP, int \fIalen\fP, char **\fIs\fP,
-.B int *\fIenclen\fP)
+.B long *\fIenclen\fP)
.fi
.SH DESCRIPTION
The
diff --git a/ares_expand_string.3 b/ares_expand_string.3
index 872e677..9e6eb5e 100644
--- a/ares_expand_string.3
+++ b/ares_expand_string.3
@@ -14,7 +14,7 @@
.\" this software for any purpose. It is provided "as is"
.\" without express or implied warranty.
.\"
-.TH ARES_EXPAND_NAME 3 "23 July 1998"
+.TH ARES_EXPAND_NAME 3 "20 Nov 2009"
.SH NAME
ares_expand_string \- Expand a length encoded string
.SH SYNOPSIS
@@ -23,7 +23,7 @@ ares_expand_string \- Expand a length encoded string
.PP
.B int ares_expand_string(const unsigned char *\fIencoded\fP,
.B const unsigned char *\fIabuf\fP, int \fIalen\fP, unsigned char **\fIs\fP,
-.B int *\fIenclen\fP)
+.B long *\fIenclen\fP)
.fi
.SH DESCRIPTION
The
diff --git a/ares_mkquery.3 b/ares_mkquery.3
index 613076b..ac3f36f 100644
--- a/ares_mkquery.3
+++ b/ares_mkquery.3
@@ -14,7 +14,7 @@
.\" this software for any purpose. It is provided "as is"
.\" without express or implied warranty.
.\"
-.TH ARES_MKQUERY 3 "4 January 2000"
+.TH ARES_MKQUERY 3 "20 Nov 2009"
.SH NAME
ares_mkquery \- Compose a single-question DNS query buffer
.SH SYNOPSIS
@@ -22,7 +22,7 @@ ares_mkquery \- Compose a single-question DNS query buffer
.B #include <ares.h>
.PP
.B int ares_mkquery(const char *\fIname\fP, int \fIdnsclass\fP, int \fItype\fP,
-.B unsigned short \fIid\fP, int \fIrd\fP, char **\fIbuf\fP,
+.B unsigned short \fIid\fP, int \fIrd\fP, unsigned char **\fIbuf\fP,
.B int *\fIbuflen\fP)
.fi
.SH DESCRIPTION
diff --git a/ares_parse_aaaa_reply.3 b/ares_parse_aaaa_reply.3
index ea29036..f25cb93 100644
--- a/ares_parse_aaaa_reply.3
+++ b/ares_parse_aaaa_reply.3
@@ -14,7 +14,7 @@
.\" this software for any purpose. It is provided "as is"
.\" without express or implied warranty.
.\"
-.TH ARES_PARSE_AAAA_REPLY 3 "10 March 2005"
+.TH ARES_PARSE_AAAA_REPLY 3 "20 Nov 2009"
.SH NAME
ares_parse_aaaa_reply \- Parse a reply to a DNS query of type AAAA
.SH SYNOPSIS
@@ -23,7 +23,7 @@ ares_parse_aaaa_reply \- Parse a reply to a DNS query of type AAAA
.PP
.B int ares_parse_aaaa_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP,
.B struct hostent **\fIhost\fP,
-.B struct addrttl *\fIaddrttls\fB, int *\fInaddrttls\fB);
+.B struct addr6ttl *\fIaddrttls\fB, int *\fInaddrttls\fB);
.fi
.SH DESCRIPTION
The
@@ -31,7 +31,7 @@ The
function parses the response to a query of type AAAA into a
.BR "struct hostent"
and/or an array of
-.BR "struct addrttls" .
+.BR "struct addr6ttl" .
The parameters
.I abuf
and
diff --git a/ares_set_socket_callback.3 b/ares_set_socket_callback.3
index c4f0455..fb598ca 100644
--- a/ares_set_socket_callback.3
+++ b/ares_set_socket_callback.3
@@ -1,15 +1,20 @@
.\" $Id$
.\"
-.TH ARES_SET_SOCKET_CALLBACK 3 "2 Dec 2008"
+.TH ARES_SET_SOCKET_CALLBACK 3 "20 Nov 2009"
.SH NAME
ares_set_socket_callback \- Set a socket creation callback
.SH SYNOPSIS
.nf
-int ares_set_socket_callback(ares_channel \fIchannel\fP,
+.B #include <ares.h>
+.PP
+.B void ares_set_socket_callback(ares_channel \fIchannel\fP,
ares_sock_create_callback \fIcallback\fP,
void *\fIuserdata\fP)
+.PP
+.B cc file.c -lcares
.fi
.SH DESCRIPTION
+.PP
This function sets a \fIcallback\fP in the given ares channel handle. This
callback function will be invoked after the socket has been created, and
connected to the remote server. The callback must return ARES_SUCCESS if