Chiebot-Mirror
/
c-ares
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: reformat/cleanup man pages SYNOPSIS sections (#494)

Browse Source 
To make them render "nicer" in both terminals and on the website.

- Removes the bold
- Removes .PP lines
- Indents them more like proper code style

Fix By: Daniel Stenberg (@bagder)
pull/503/head
Daniel Stenberg 2 years ago committed by GitHub
parent 313bd2aa7e
commit 0e7a5dee0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
41 changed files with 222 additions and 211 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      docs/ares_destroy_options.3
  2. 6
      docs/ares_dup.3
  3. 10
      docs/ares_expand_name.3
  4. 10
      docs/ares_expand_string.3
  5. 8
      docs/ares_free_data.3
  6. 6
      docs/ares_free_hostent.3
  7. 6
      docs/ares_free_string.3
  8. 11
      docs/ares_get_servers.3
  9. 18
      docs/ares_getaddrinfo.3
  10. 17
      docs/ares_gethostbyaddr.3
  11. 16
      docs/ares_gethostbyname.3
  12. 8
      docs/ares_gethostbyname_file.3
  13. 17
      docs/ares_getnameinfo.3
  14. 8
      docs/ares_getsock.3
  15. 8
      docs/ares_inet_ntop.3
  16. 6
      docs/ares_inet_pton.3
  17. 10
      docs/ares_mkquery.3
  18. 10
      docs/ares_parse_a_reply.3
  19. 10
      docs/ares_parse_aaaa_reply.3
  20. 9
      docs/ares_parse_mx_reply.3
  21. 8
      docs/ares_parse_naptr_reply.3
  22. 8
      docs/ares_parse_ns_reply.3
  23. 10
      docs/ares_parse_ptr_reply.3
  24. 8
      docs/ares_parse_soa_reply.3
  25. 8
      docs/ares_parse_srv_reply.3
  26. 14
      docs/ares_parse_txt_reply.3
  27. 8
      docs/ares_parse_uri_reply.3
  28. 17
      docs/ares_query.3
  29. 7
      docs/ares_save_options.3
  30. 17
      docs/ares_search.3
  31. 15
      docs/ares_send.3
  32. 6
      docs/ares_set_local_dev.3
  33. 6
      docs/ares_set_local_ip4.3
  34. 14
      docs/ares_set_local_ip6.3
  35. 11
      docs/ares_set_servers.3
  36. 9
      docs/ares_set_servers_csv.3
  37. 14
      docs/ares_set_socket_callback.3
  38. 16
      docs/ares_set_socket_configure_callback.3
  39. 25
      docs/ares_set_socket_functions.3
  40. 6
      docs/ares_set_sortlist.3
  41. 6
      docs/ares_strerror.3

6
docs/ares_destroy_options.3
Unescape View File

@ -18,9 +18,9 @@
ares_destroy_options \- Destroy options initialized with ares_save_options ares_destroy_options \- Destroy options initialized with ares_save_options
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B void ares_destroy_options(struct ares_options *\fIoptions\fP) void ares_destroy_options(struct ares_options *\fIoptions\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_destroy_options(3)\fP function destroys the options struct The \fBares_destroy_options(3)\fP function destroys the options struct

6
docs/ares_dup.3
Unescape View File

@ -18,9 +18,9 @@
ares_dup \- Duplicate a resolver channel ares_dup \- Duplicate a resolver channel
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_dup(ares_channel *\fIdest\fP, ares_channel \fIsource\fP) int ares_dup(ares_channel *\fIdest\fP, ares_channel \fIsource\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_dup(3)\fP function duplicates an existing communications channel The \fBares_dup(3)\fP function duplicates an existing communications channel

10
docs/ares_expand_name.3
Unescape View File

@ -18,11 +18,11 @@
ares_expand_name \- Expand a DNS-encoded domain name ares_expand_name \- Expand a DNS-encoded domain name
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_expand_name(const unsigned char *\fIencoded\fP, int ares_expand_name(const unsigned char *\fIencoded\fP,
.B const unsigned char *\fIabuf\fP, int \fIalen\fP, char **\fIs\fP, const unsigned char *\fIabuf\fP, int \fIalen\fP,
.B long *\fIenclen\fP) char **\fIs\fP, long *\fIenclen\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

10
docs/ares_expand_string.3
Unescape View File

@ -18,11 +18,11 @@
ares_expand_string \- Expand a length encoded string ares_expand_string \- Expand a length encoded string
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_expand_string(const unsigned char *\fIencoded\fP, int ares_expand_string(const unsigned char *\fIencoded\fP,
.B const unsigned char *\fIabuf\fP, int \fIalen\fP, unsigned char **\fIs\fP, const unsigned char *\fIabuf\fP, int \fIalen\fP,
.B long *\fIenclen\fP) unsigned char **\fIs\fP, long *\fIenclen\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_free_data.3
Unescape View File

@ -19,11 +19,9 @@
ares_free_data \- Free data allocated by several c-ares functions ares_free_data \- Free data allocated by several c-ares functions
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B void ares_free_data(void *\fIdataptr\fP) void ares_free_data(void *\fIdataptr\fP)
.PP
.B cc file.c -lcares
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP

6
docs/ares_free_hostent.3
Unescape View File

@ -18,9 +18,9 @@
ares_free_hostent \- Free host structure allocated by ares functions ares_free_hostent \- Free host structure allocated by ares functions
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B void ares_free_hostent(struct hostent *\fIhost\fP) void ares_free_hostent(struct hostent *\fIhost\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

6
docs/ares_free_string.3
Unescape View File

@ -18,9 +18,9 @@
ares_free_string \- Free strings allocated by ares functions ares_free_string \- Free strings allocated by ares functions
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B void ares_free_string(void *\fIstr\fP) void ares_free_string(void *\fIstr\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fIares_free_string(3)\fP function frees a string allocated by an ares The \fIares_free_string(3)\fP function frees a string allocated by an ares

11
docs/ares_get_servers.3
Unescape View File

@ -19,10 +19,13 @@
ares_get_servers, ares_get_servers_ports \- Retrieve name servers from an initialized ares_channel ares_get_servers, ares_get_servers_ports \- Retrieve name servers from an initialized ares_channel
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_get_servers(ares_channel \fIchannel\fP, struct ares_addr_node **\fIservers\fP) int ares_get_servers(ares_channel \fIchannel\fP,
.B int ares_get_servers_ports(ares_channel \fIchannel\fP, struct ares_addr_port_node **\fIservers\fP) struct ares_addr_node **\fIservers\fP)
int ares_get_servers_ports(ares_channel \fIchannel\fP,
struct ares_addr_port_node **\fIservers\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_get_servers(3)\fP function retrieves name servers configuration The \fBares_get_servers(3)\fP function retrieves name servers configuration

18
docs/ares_getaddrinfo.3
Unescape View File

@ -18,14 +18,16 @@
ares_getaddrinfo \- Initiate a host query by name and service ares_getaddrinfo \- Initiate a host query by name and service
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef void (*ares_addrinfo_callback)(void *\fIarg\fP, int \fIstatus\fP, typedef void (*ares_addrinfo_callback)(void *\fIarg\fP, int \fIstatus\fP,
.B int \fItimeouts\fP, struct ares_addrinfo *\fIresult\fP) int \fItimeouts\fP,
.PP struct ares_addrinfo *\fIresult\fP)
.B void ares_getaddrinfo(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B const char* \fIservice\fP, const struct ares_addrinfo_hints *\fIhints\fP, void ares_getaddrinfo(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B ares_addrinfo_callback \fIcallback\fP, void *\fIarg\fP) const char* \fIservice\fP,
const struct ares_addrinfo_hints *\fIhints\fP,
ares_addrinfo_callback \fIcallback\fP, void *\fIarg\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

17
docs/ares_gethostbyaddr.3
Unescape View File

@ -18,14 +18,15 @@
ares_gethostbyaddr \- Initiate a host query by address ares_gethostbyaddr \- Initiate a host query by address
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef void (*ares_host_callback)(void *\fIarg\fP, int \fIstatus\fP, typedef void (*ares_host_callback)(void *\fIarg\fP, int \fIstatus\fP,
.B int \fItimeouts\fP, struct hostent *\fIhostent\fP) int \fItimeouts\fP,
.PP struct hostent *\fIhostent\fP)
.B void ares_gethostbyaddr(ares_channel \fIchannel\fP, const void *\fIaddr\fP,
.B int \fIaddrlen\fP, int \fIfamily\fP, ares_host_callback \fIcallback\fP, void ares_gethostbyaddr(ares_channel \fIchannel\fP, const void *\fIaddr\fP,
.B void *\fIarg\fP) int \fIaddrlen\fP, int \fIfamily\fP,
ares_host_callback \fIcallback\fP, void *\fIarg\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

16
docs/ares_gethostbyname.3
Unescape View File

@ -18,13 +18,15 @@
ares_gethostbyname \- Initiate a host query by name ares_gethostbyname \- Initiate a host query by name
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef void (*ares_host_callback)(void *\fIarg\fP, int \fIstatus\fP, typedef void (*ares_host_callback)(void *\fIarg\fP, int \fIstatus\fP,
.B int \fItimeouts\fP, struct hostent *\fIhostent\fP) int \fItimeouts\fP,
.PP struct hostent *\fIhostent\fP)
.B void ares_gethostbyname(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B int \fIfamily\fP, ares_host_callback \fIcallback\fP, void *\fIarg\fP) void ares_gethostbyname(ares_channel \fIchannel\fP, const char *\fIname\fP,
int \fIfamily\fP, ares_host_callback \fIcallback\fP,
void *\fIarg\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_gethostbyname_file.3
Unescape View File

@ -18,10 +18,10 @@
ares_gethostbyname_file \- Lookup a name in the system's hosts file ares_gethostbyname_file \- Lookup a name in the system's hosts file
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_gethostbyname_file(ares_channel \fIchannel\fP, const char *\fIname\fP, int ares_gethostbyname_file(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B int \fIfamily\fP, struct hostent **host) int \fIfamily\fP, struct hostent **host)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

17
docs/ares_getnameinfo.3
Unescape View File

@ -18,14 +18,15 @@
ares_getnameinfo \- Address-to-nodename translation in protocol-independent manner ares_getnameinfo \- Address-to-nodename translation in protocol-independent manner
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef void (*ares_nameinfo_callback)(void *\fIarg\fP, int \fIstatus\fP, typedef void (*ares_nameinfo_callback)(void *\fIarg\fP, int \fIstatus\fP,
.B int \fItimeouts\fP, char *\fInode\fP, char *\fIservice\fP) int \fItimeouts\fP, char *\fInode\fP,
.PP char *\fIservice\fP)
.B void ares_getnameinfo(ares_channel \fIchannel\fP, const struct sockaddr *\fIsa\fP,
.B ares_socklen_t \fIsalen\fP, int \fIflags\fP, ares_nameinfo_callback \fIcallback\fP, void ares_getnameinfo(ares_channel \fIchannel\fP, const struct sockaddr *\fIsa\fP,
.B void *\fIarg\fP) ares_socklen_t \fIsalen\fP, int \fIflags\fP,
ares_nameinfo_callback \fIcallback\fP, void *\fIarg\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_getsock.3
Unescape View File

@ -18,10 +18,10 @@
ares_getsock \- get socket descriptors to wait on ares_getsock \- get socket descriptors to wait on
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_getsock(ares_channel \fIchannel\fP, ares_socket_t *\fIsocks\fP, int ares_getsock(ares_channel \fIchannel\fP, ares_socket_t *\fIsocks\fP,
.B int \fInumsocks\fP); int \fInumsocks\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_inet_ntop.3
Unescape View File

@ -18,10 +18,10 @@
ares_inet_ntop \- convert a network format address to presentation format ares_inet_ntop \- convert a network format address to presentation format
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B const char * const char *ares_inet_ntop(int \fIaf\fP, const void *\fIsrc\fP, char *\fIdst\fP,
.B ares_inet_ntop(int af, const void *src, char *dst, ares_socklen_t size); ares_socklen_t \fIsize\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
This is a portable version with the identical functionality of the commonly This is a portable version with the identical functionality of the commonly

6
docs/ares_inet_pton.3
Unescape View File

@ -18,9 +18,9 @@
ares_inet_pton \- convert an IPv4 or IPv6 address from text to binary form ares_inet_pton \- convert an IPv4 or IPv6 address from text to binary form
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B const char *ares_inet_pton(int af, const char *src, void *dst); const char *ares_inet_pton(int \fIaf\fP, const char *\fIsrc\fP, void *\fIdst\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
This is a portable version with the identical functionality of the commonly This is a portable version with the identical functionality of the commonly

10
docs/ares_mkquery.3
Unescape View File

@ -18,11 +18,11 @@
ares_mkquery \- Compose a single-question DNS query buffer ares_mkquery \- Compose a single-question DNS query buffer
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_mkquery(const char *\fIname\fP, int \fIdnsclass\fP, int \fItype\fP, int ares_mkquery(const char *\fIname\fP, int \fIdnsclass\fP, int \fItype\fP,
.B unsigned short \fIid\fP, int \fIrd\fP, unsigned char **\fIbuf\fP, unsigned short \fIid\fP, int \fIrd\fP, unsigned char **\fIbuf\fP,
.B int *\fIbuflen\fP) int *\fIbuflen\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
Deprecated function. See \fIares_create_query(3)\fP instead! Deprecated function. See \fIares_create_query(3)\fP instead!

10
docs/ares_parse_a_reply.3
Unescape View File

@ -18,11 +18,11 @@
ares_parse_a_reply \- Parse a reply to a DNS query of type A ares_parse_a_reply \- Parse a reply to a DNS query of type A
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_a_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, int ares_parse_a_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP,
.B struct hostent **\fIhost\fP, struct hostent **\fIhost\fP,
.B struct ares_addrttl *\fIaddrttls\fP, int *\fInaddrttls\fP); struct ares_addrttl *\fIaddrttls\fP, int *\fInaddrttls\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

10
docs/ares_parse_aaaa_reply.3
Unescape View File

@ -18,11 +18,11 @@
ares_parse_aaaa_reply \- Parse a reply to a DNS query of type AAAA ares_parse_aaaa_reply \- Parse a reply to a DNS query of type AAAA
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_aaaa_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, int ares_parse_aaaa_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP,
.B struct hostent **\fIhost\fP, struct hostent **\fIhost\fP,
.B struct ares_addr6ttl *\fIaddrttls\fP, int *\fInaddrttls\fP); struct ares_addr6ttl *\fIaddrttls\fP, int *\fInaddrttls\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

9
docs/ares_parse_mx_reply.3
Unescape View File

@ -17,11 +17,10 @@
.SH NAME .SH NAME
ares_parse_mx_reply \- Parse a reply to a DNS query of type MX ares_parse_mx_reply \- Parse a reply to a DNS query of type MX
.SH SYNOPSIS .SH SYNOPSIS
.nf #include <ares.h>
.B #include <ares.h>
.PP int ares_parse_mx_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
.B int ares_parse_mx_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, struct ares_mx_reply** \fImx_out\fP);
.B struct ares_mx_reply** \fImx_out\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_parse_naptr_reply.3
Unescape View File

@ -18,10 +18,10 @@
ares_parse_naptr_reply \- Parse a reply to a DNS query of type NAPTR ares_parse_naptr_reply \- Parse a reply to a DNS query of type NAPTR
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_naptr_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, int ares_parse_naptr_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
.B struct ares_naptr_reply** \fInaptr_out\fP); struct ares_naptr_reply** \fInaptr_out\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_parse_ns_reply.3
Unescape View File

@ -18,10 +18,10 @@
ares_parse_ns_reply \- Parse a reply to a DNS query of type NS into a hostent ares_parse_ns_reply \- Parse a reply to a DNS query of type NS into a hostent
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_ns_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, int ares_parse_ns_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP,
.B struct hostent **\fIhost\fP); struct hostent **\fIhost\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

10
docs/ares_parse_ptr_reply.3
Unescape View File

@ -18,11 +18,11 @@
ares_parse_ptr_reply \- Parse a reply to a DNS query of type PTR into a hostent ares_parse_ptr_reply \- Parse a reply to a DNS query of type PTR into a hostent
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_ptr_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, int ares_parse_ptr_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP,
.B const void *\fIaddr\fP, int \fIaddrlen\fP, int \fIfamily\fP, const void *\fIaddr\fP, int \fIaddrlen\fP,
.B struct hostent **\fIhost\fP); int \fIfamily\fP, struct hostent **\fIhost\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_parse_soa_reply.3
Unescape View File

@ -18,10 +18,10 @@
ares_parse_soa_reply \- Parse a reply to a DNS query of type SOA ares_parse_soa_reply \- Parse a reply to a DNS query of type SOA
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_soa_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, int ares_parse_soa_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
.B struct ares_soa_reply** \fIsoa_out\fP); struct ares_soa_reply** \fIsoa_out\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_parse_srv_reply.3
Unescape View File

@ -18,10 +18,10 @@
ares_parse_srv_reply \- Parse a reply to a DNS query of type SRV ares_parse_srv_reply \- Parse a reply to a DNS query of type SRV
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_srv_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, int ares_parse_srv_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
.B struct ares_srv_reply** \fIsrv_out\fP); struct ares_srv_reply** \fIsrv_out\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

14
docs/ares_parse_txt_reply.3
Unescape View File

@ -18,13 +18,13 @@
ares_parse_txt_reply \- Parse a reply to a DNS query of type TXT ares_parse_txt_reply \- Parse a reply to a DNS query of type TXT
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_txt_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, int ares_parse_txt_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
.B struct ares_txt_reply **\fItxt_out\fP); struct ares_txt_reply **\fItxt_out\fP);
.PP
.B int ares_parse_txt_reply_ext(const unsigned char* \fIabuf\fP, int \fIalen\fP, int ares_parse_txt_reply_ext(const unsigned char* \fIabuf\fP, int \fIalen\fP,
.B struct ares_txt_ext **\fItxt_out\fP); struct ares_txt_ext **\fItxt_out\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

8
docs/ares_parse_uri_reply.3
Unescape View File

@ -18,10 +18,10 @@
ares_parse_uri_reply \- Parse a reply to a DNS query of type URI ares_parse_uri_reply \- Parse a reply to a DNS query of type URI
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_parse_uri_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP, int ares_parse_uri_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
.B struct ares_uri_reply** \fIuri_out\fP); struct ares_uri_reply** \fIuri_out\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

17
docs/ares_query.3
Unescape View File

@ -18,14 +18,15 @@
ares_query \- Initiate a single-question DNS query ares_query \- Initiate a single-question DNS query
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP, typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP,
.B int \fItimeouts\fP, unsigned char *\fIabuf\fP, int \fIalen\fP) int \fItimeouts\fP, unsigned char *\fIabuf\fP,
.PP int \fIalen\fP)
.B void ares_query(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B int \fIdnsclass\fP, int \fItype\fP, ares_callback \fIcallback\fP, void ares_query(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B void *\fIarg\fP) int \fIdnsclass\fP, int \fItype\fP,
ares_callback \fIcallback\fP, void *\fIarg\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

7
docs/ares_save_options.3
Unescape View File

@ -18,9 +18,10 @@
ares_save_options \- Save configuration values obtained from initialized ares_channel ares_save_options \- Save configuration values obtained from initialized ares_channel
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_save_options(ares_channel \fIchannel\fP, struct ares_options *\fIoptions\fP, int *\fIoptmask\fP) int ares_save_options(ares_channel \fIchannel\fP,
struct ares_options *\fIoptions\fP, int *\fIoptmask\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_save_options(3)\fP function saves the channel data identified by The \fBares_save_options(3)\fP function saves the channel data identified by

17
docs/ares_search.3
Unescape View File

@ -18,14 +18,15 @@
ares_search \- Initiate a DNS query with domain search ares_search \- Initiate a DNS query with domain search
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP, typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP,
.B int \fItimeouts\fP, unsigned char *\fIabuf\fP, int \fIalen\fP) int \fItimeouts\fP, unsigned char *\fIabuf\fP,
.PP int \fIalen\fP)
.B void ares_search(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B int \fIdnsclass\fP, int \fItype\fP, ares_callback \fIcallback\fP, void ares_search(ares_channel \fIchannel\fP, const char *\fIname\fP,
.B void *\fIarg\fP) int \fIdnsclass\fP, int \fItype\fP,
ares_callback \fIcallback\fP, void *\fIarg\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

15
docs/ares_send.3
Unescape View File

@ -18,13 +18,14 @@
ares_send \- Initiate a DNS query ares_send \- Initiate a DNS query
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP, typedef void (*ares_callback)(void *\fIarg\fP, int \fIstatus\fP,
.B int \fItimeouts\fP, unsigned char *\fIabuf\fP, int \fIalen\fP) int \fItimeouts\fP, unsigned char *\fIabuf\fP,
.PP int \fIalen\fP)
.B void ares_send(ares_channel \fIchannel\fP, const unsigned char *\fIqbuf\fP,
.B int \fIqlen\fP, ares_callback \fIcallback\fP, void *\fIarg\fP) void ares_send(ares_channel \fIchannel\fP, const unsigned char *\fIqbuf\fP,
int \fIqlen\fP, ares_callback \fIcallback\fP, void *\fIarg\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

6
docs/ares_set_local_dev.3
Unescape View File

@ -18,9 +18,9 @@
ares_set_local_dev \- Bind to a specific network device when creating sockets. ares_set_local_dev \- Bind to a specific network device when creating sockets.
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B void ares_set_local_dev(ares_channel \fIchannel\fP, const char* \fIlocal_dev_name\fP) void ares_set_local_dev(ares_channel \fIchannel\fP, const char* \fIlocal_dev_name\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_set_local_dev\fP function causes all future sockets The \fBares_set_local_dev\fP function causes all future sockets

6
docs/ares_set_local_ip4.3
Unescape View File

@ -18,9 +18,9 @@
ares_set_local_ip4 \- Set local IPv4 address outgoing requests. ares_set_local_ip4 \- Set local IPv4 address outgoing requests.
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B void ares_set_local_ip4(ares_channel \fIchannel\fP, unsigned int \fIlocal_ip\fP) void ares_set_local_ip4(ares_channel \fIchannel\fP, unsigned int \fIlocal_ip\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_set_local_ip4\fP function sets the IP address for outbound The \fBares_set_local_ip4\fP function sets the IP address for outbound

14
docs/ares_set_local_ip6.3
Unescape View File

@ -18,15 +18,15 @@
ares_set_local_ip6 \- Set local IPv6 address outgoing requests. ares_set_local_ip6 \- Set local IPv6 address outgoing requests.
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B void ares_set_local_ip6(ares_channel \fIchannel\fP, const unsigned char* \fIlocal_ip6\fP) void ares_set_local_ip6(ares_channel \fIchannel\fP, const unsigned char* \fIlocal_ip6\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_set_local_ip6\fP function sets the IPv6 address for outbound The \fBares_set_local_ip6\fP function sets the IPv6 address for outbound IPv6
IPv6 requests. The parameter \fIlocal_ip6\fP is specified in network byte requests. The parameter \fIlocal_ip6\fP is specified in network byte order.
order. This allows users to specify outbound interfaces when used on This allows users to specify outbound interfaces when used on multi-homed
multi-homed systems. The local_ip6 argument must be 16 bytes in length. systems. The \fIlocal_ip6\fP argument must be 16 bytes in length.
.SH SEE ALSO .SH SEE ALSO
.BR ares_set_local_ip4 (3) .BR ares_set_local_ip4 (3)
.SH NOTES .SH NOTES

11
docs/ares_set_servers.3
Unescape View File

@ -18,10 +18,13 @@
ares_set_servers, ares_set_servers_ports \- Initialize an ares_channel name servers configuration ares_set_servers, ares_set_servers_ports \- Initialize an ares_channel name servers configuration
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_set_servers(ares_channel \fIchannel\fP, struct ares_addr_node *\fIservers\fP) int ares_set_servers(ares_channel \fIchannel\fP,
.B int ares_set_servers_ports(ares_channel \fIchannel\fP, struct ares_addr_port_node *\fIservers\fP) struct ares_addr_node *\fIservers\fP)
int ares_set_servers_ports(ares_channel \fIchannel\fP,
struct ares_addr_port_node *\fIservers\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_set_servers(3)\fP function initializes name servers configuration The \fBares_set_servers(3)\fP function initializes name servers configuration

9
docs/ares_set_servers_csv.3
Unescape View File

@ -18,10 +18,11 @@
ares_set_servers_csv, ares_set_servers_ports_csv \- Set list of DNS servers to be used. ares_set_servers_csv, ares_set_servers_ports_csv \- Set list of DNS servers to be used.
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_set_servers_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP) int ares_set_servers_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP)
.B int ares_set_servers_ports_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP)
int ares_set_servers_ports_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_set_servers_csv\fP and \fBares_set_servers_ports_csv\fPfunctions set The \fBares_set_servers_csv\fP and \fBares_set_servers_ports_csv\fPfunctions set

14
docs/ares_set_socket_callback.3
Unescape View File

@ -4,15 +4,15 @@
ares_set_socket_callback \- Set a socket creation callback ares_set_socket_callback \- Set a socket creation callback
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef int (*ares_sock_create_callback)(ares_socket_t \fIsocket_fd\fP, typedef int (*ares_sock_create_callback)(ares_socket_t \fIsocket_fd\fP,
int \fItype\fP, int \fItype\fP,
void *\fIuserdata\fP) void *\fIuserdata\fP)
.PP
.B void ares_set_socket_callback(ares_channel \fIchannel\fP, void ares_set_socket_callback(ares_channel \fIchannel\fP,
ares_sock_create_callback \fIcallback\fP, ares_sock_create_callback \fIcallback\fP,
void *\fIuserdata\fP) void *\fIuserdata\fP)
.PP .PP
.B cc file.c -lcares .B cc file.c -lcares
.fi .fi

16
docs/ares_set_socket_configure_callback.3
Unescape View File

@ -4,17 +4,15 @@
ares_set_socket_configure_callback \- Set a socket configuration callback ares_set_socket_configure_callback \- Set a socket configuration callback
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B typedef int (*ares_sock_config_callback)(ares_socket_t \fIsocket_fd\fP, typedef int (*ares_sock_config_callback)(ares_socket_t \fIsocket_fd\fP,
int \fItype\fP, int \fItype\fP,
void *\fIuserdata\fP) void *\fIuserdata\fP)
.PP
.B void ares_set_socket_configure_callback(ares_channel \fIchannel\fP, void ares_set_socket_configure_callback(ares_channel \fIchannel\fP,
ares_sock_config_callback \fIcallback\fP, ares_sock_config_callback \fIcallback\fP,
void *\fIuserdata\fP) void *\fIuserdata\fP)
.PP
.B cc file.c -lcares
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP

25
docs/ares_set_socket_functions.3
Unescape View File

@ -4,21 +4,20 @@
ares_set_socket_functions \- Set socket io callbacks ares_set_socket_functions \- Set socket io callbacks
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B struct ares_socket_functions {
ares_socket_t(*\fIasocket\fP)(int, int, int, void *);
int(*\fIaclose\fP)(ares_socket_t, void *);
int(*\fIaconnect\fP)(ares_socket_t, const struct sockaddr *, ares_socklen_t, void *);
ares_ssize_t(*\fIarecvfrom\fP)(ares_socket_t, void *, size_t, int, struct sockaddr *, ares_socklen_t *, void *);
ares_ssize_t(*\fIasendv\fP)(ares_socket_t, const struct iovec *, int, void *);
};
.PP struct ares_socket_functions {
.B void ares_set_socket_functions(ares_channel \fIchannel\fP, ares_socket_t (*\fIasocket\fP)(int, int, int, void *);
const struct ares_socket_functions * \fIfunctions\fP, int (*\fIaclose\fP)(ares_socket_t, void *);
void *\fIuser_data\fP); int (*\fIaconnect\fP)(ares_socket_t, const struct sockaddr *, ares_socklen_t, void *);
ares_ssize_t (*\fIarecvfrom\fP)(ares_socket_t, void *, size_t, int,
struct sockaddr *, ares_socklen_t *, void *);
ares_ssize_t (*\fIasendv\fP)(ares_socket_t, const struct iovec *, int, void *);
};
void ares_set_socket_functions(ares_channel \fIchannel\fP,
const struct ares_socket_functions * \fIfunctions\fP,
void *\fIuser_data\fP);
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP

6
docs/ares_set_sortlist.3
Unescape View File

@ -16,9 +16,9 @@
ares_set_sortlist \- Initialize an ares_channel sortlist configuration ares_set_sortlist \- Initialize an ares_channel sortlist configuration
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B int ares_set_sortlist(ares_channel \fIchannel\fP, const char *\fIsortstr\fP) int ares_set_sortlist(ares_channel \fIchannel\fP, const char *\fIsortstr\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The \fBares_set_sortlist(3)\fP function initializes an address sortlist configuration The \fBares_set_sortlist(3)\fP function initializes an address sortlist configuration

6
docs/ares_strerror.3
Unescape View File

@ -18,9 +18,9 @@
ares_strerror \- Get the description of an ares library error code ares_strerror \- Get the description of an ares library error code
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <ares.h> #include <ares.h>
.PP
.B const char *ares_strerror(int \fIcode\fP) const char *ares_strerror(int \fIcode\fP)
.fi .fi
.SH DESCRIPTION .SH DESCRIPTION
The The

Write Preview
Loading…
Cancel
Save