Commit c3266a5e authored by Yang Tse's avatar Yang Tse
Browse files

Sync man page with reality

parent ced1e1e7

ares/ares_expand_name.3

+2 −2
Original line number Diff line number Diff line
@@ -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

ares/ares_expand_string.3

+2 −2
Original line number Diff line number Diff line
@@ -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

ares/ares_mkquery.3

+2 −2
Original line number Diff line number Diff line
@@ -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

ares/ares_parse_aaaa_reply.3

+3 −3
Original line number Diff line number Diff line
@@ -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

ares/ares_set_socket_callback.3

+7 −2
Original line number Diff line number Diff line 
.\" $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