summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSeonah Moon <seonah1.moon@samsung.com>2022-01-10 13:52:00 +0900
committerSeonah Moon <seonah1.moon@samsung.com>2022-01-10 13:52:16 +0900
commit450be02682da219c984870e56ac2c3098efbe68a (patch)
tree9d63f8326e88f5cd4b623309eb0ac4a918511d90 /docs
parentbff27be9aa171a5afc25df79cd652337aa1ecbb0 (diff)
downloadc-ares-450be02682da219c984870e56ac2c3098efbe68a.tar.gz
c-ares-450be02682da219c984870e56ac2c3098efbe68a.tar.bz2
c-ares-450be02682da219c984870e56ac2c3098efbe68a.zip
Imported Upstream version 1.18.1upstream/1.18.1
Change-Id: I5e47fe8a8445aff4c3382d9f334bd8a976ae15dd
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.in31
-rw-r--r--docs/Makefile.inc1
-rw-r--r--docs/acountry.12
-rw-r--r--docs/adig.14
-rw-r--r--docs/ahost.12
-rw-r--r--docs/ares_free_data.34
-rw-r--r--docs/ares_getaddrinfo.36
-rw-r--r--docs/ares_parse_uri_reply.381
8 files changed, 116 insertions, 15 deletions
diff --git a/docs/Makefile.in b/docs/Makefile.in
index 9ceca3a..b4e656e 100644
--- a/docs/Makefile.in
+++ b/docs/Makefile.in
@@ -1,7 +1,7 @@
-# Makefile.in generated by automake 1.16.2 from Makefile.am.
+# Makefile.in generated by automake 1.16.5 from Makefile.am.
# @configure_input@
-# Copyright (C) 1994-2020 Free Software Foundation, Inc.
+# Copyright (C) 1994-2021 Free Software Foundation, Inc.
# This Makefile.in is free software; the Free Software Foundation
# gives unlimited permission to copy and/or distribute it,
@@ -93,12 +93,18 @@ build_triplet = @build@
host_triplet = @host@
subdir = docs
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
-am__aclocal_m4_deps = $(top_srcdir)/m4/ax_code_coverage.m4 \
+am__aclocal_m4_deps = $(top_srcdir)/m4/ax_ac_append_to_file.m4 \
+ $(top_srcdir)/m4/ax_ac_print_to_file.m4 \
+ $(top_srcdir)/m4/ax_add_am_macro_static.m4 \
+ $(top_srcdir)/m4/ax_am_macros_static.m4 \
+ $(top_srcdir)/m4/ax_check_gnu_make.m4 \
+ $(top_srcdir)/m4/ax_code_coverage.m4 \
$(top_srcdir)/m4/ax_cxx_compile_stdcxx_11.m4 \
+ $(top_srcdir)/m4/ax_file_escapes.m4 \
+ $(top_srcdir)/m4/ax_require_defined.m4 \
$(top_srcdir)/m4/cares-compilers.m4 \
$(top_srcdir)/m4/cares-confopts.m4 \
$(top_srcdir)/m4/cares-functions.m4 \
- $(top_srcdir)/m4/cares-override.m4 \
$(top_srcdir)/m4/cares-reentrant.m4 \
$(top_srcdir)/m4/libtool.m4 $(top_srcdir)/m4/ltoptions.m4 \
$(top_srcdir)/m4/ltsugar.m4 $(top_srcdir)/m4/ltversion.m4 \
@@ -108,9 +114,7 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/ax_code_coverage.m4 \
$(top_srcdir)/m4/xc-lt-iface.m4 \
$(top_srcdir)/m4/xc-translit.m4 \
$(top_srcdir)/m4/xc-val-flgs.m4 \
- $(top_srcdir)/m4/zz40-xc-ovr.m4 \
- $(top_srcdir)/m4/zz50-xc-ovr.m4 \
- $(top_srcdir)/m4/zz60-xc-ovr.m4 $(top_srcdir)/acinclude.m4 \
+ $(top_srcdir)/m4/zz40-xc-ovr.m4 $(top_srcdir)/acinclude.m4 \
$(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
@@ -187,17 +191,22 @@ AWK = @AWK@
BUILD_SUBDIRS = @BUILD_SUBDIRS@
CARES_CFLAG_EXTRAS = @CARES_CFLAG_EXTRAS@
CARES_PRIVATE_LIBS = @CARES_PRIVATE_LIBS@
+CARES_RANDOM_FILE = @CARES_RANDOM_FILE@
CARES_VERSION_INFO = @CARES_VERSION_INFO@
CC = @CC@
CCDEPMODE = @CCDEPMODE@
CFLAGS = @CFLAGS@
CFLAG_CARES_SYMBOL_HIDING = @CFLAG_CARES_SYMBOL_HIDING@
CODE_COVERAGE_CFLAGS = @CODE_COVERAGE_CFLAGS@
+CODE_COVERAGE_CPPFLAGS = @CODE_COVERAGE_CPPFLAGS@
+CODE_COVERAGE_CXXFLAGS = @CODE_COVERAGE_CXXFLAGS@
CODE_COVERAGE_ENABLED = @CODE_COVERAGE_ENABLED@
-CODE_COVERAGE_LDFLAGS = @CODE_COVERAGE_LDFLAGS@
+CODE_COVERAGE_LIBS = @CODE_COVERAGE_LIBS@
CPP = @CPP@
CPPFLAGS = @CPPFLAGS@
CPPFLAG_CARES_STATICLIB = @CPPFLAG_CARES_STATICLIB@
+CSCOPE = @CSCOPE@
+CTAGS = @CTAGS@
CXX = @CXX@
CXXCPP = @CXXCPP@
CXXDEPMODE = @CXXDEPMODE@
@@ -212,6 +221,7 @@ ECHO_C = @ECHO_C@
ECHO_N = @ECHO_N@
ECHO_T = @ECHO_T@
EGREP = @EGREP@
+ETAGS = @ETAGS@
EXEEXT = @EXEEXT@
FGREP = @FGREP@
GCOV = @GCOV@
@@ -251,7 +261,6 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@
PACKAGE_URL = @PACKAGE_URL@
PACKAGE_VERSION = @PACKAGE_VERSION@
PATH_SEPARATOR = @PATH_SEPARATOR@
-RANDOM_FILE = @RANDOM_FILE@
RANLIB = @RANLIB@
SED = @SED@
SET_MAKE = @SET_MAKE@
@@ -289,6 +298,8 @@ host_cpu = @host_cpu@
host_os = @host_os@
host_vendor = @host_vendor@
htmldir = @htmldir@
+ifGNUmake = @ifGNUmake@
+ifnGNUmake = @ifnGNUmake@
includedir = @includedir@
infodir = @infodir@
install_sh = @install_sh@
@@ -353,6 +364,7 @@ MANPAGES = ares_cancel.3 \
ares_parse_soa_reply.3 \
ares_parse_srv_reply.3 \
ares_parse_txt_reply.3 \
+ ares_parse_uri_reply.3 \
ares_process.3 \
ares_query.3 \
ares_save_options.3 \
@@ -463,7 +475,6 @@ ctags CTAGS:
cscope cscopelist:
-
distdir: $(BUILT_SOURCES)
$(MAKE) $(AM_MAKEFLAGS) distdir-am
diff --git a/docs/Makefile.inc b/docs/Makefile.inc
index fbd7492..3aa62aa 100644
--- a/docs/Makefile.inc
+++ b/docs/Makefile.inc
@@ -37,6 +37,7 @@ MANPAGES = ares_cancel.3 \
ares_parse_soa_reply.3 \
ares_parse_srv_reply.3 \
ares_parse_txt_reply.3 \
+ ares_parse_uri_reply.3 \
ares_process.3 \
ares_query.3 \
ares_save_options.3 \
diff --git a/docs/acountry.1 b/docs/acountry.1
index 269ae1f..8c3aaea 100644
--- a/docs/acountry.1
+++ b/docs/acountry.1
@@ -25,7 +25,7 @@ Be more verbose. Print extra information.
.SH "REPORTING BUGS"
Report bugs to the c-ares mailing list:
.br
-\fBhttps://cool.haxx.se/mailman/listinfo/c-ares\fR
+\fBhttps://lists.haxx.se/listinfo/c-ares\fR
.SH "SEE ALSO"
.PP
adig(1), ahost(1).
diff --git a/docs/adig.1 b/docs/adig.1
index fa5c766..2056b95 100644
--- a/docs/adig.1
+++ b/docs/adig.1
@@ -42,7 +42,7 @@ Query records of specified type.
Possible values for type are
A (default), AAAA, AFSDB, ANY, AXFR, CNAME, GPOS, HINFO, ISDN, KEY, LOC, MAILA,
MAILB, MB, MD, MF, MG, MINFO, MR, MX, NAPTR, NS, NSAP, NSAP_PTR, NULL,
-PTR, PX, RP, RT, SIG, SOA, SRV, TXT, WKS, X25,
+PTR, PX, RP, RT, SIG, SOA, SRV, TXT, URI, WKS, X25,
.TP
\fB\-U\fR port
Use specified UDP port to connect to DNS server.
@@ -62,7 +62,7 @@ This compacted \fBbit-string\fR form is not supported by many DNS-servers.
.SH "REPORTING BUGS"
Report bugs to the c-ares mailing list:
.br
-\fBhttps://cool.haxx.se/mailman/listinfo/c-ares\fR
+\fBhttps://lists.haxx.se/listinfo/c-ares\fR
.SH "SEE ALSO"
.PP
acountry(1), ahost(1).
diff --git a/docs/ahost.1 b/docs/ahost.1
index 89a3920..430af82 100644
--- a/docs/ahost.1
+++ b/docs/ahost.1
@@ -36,7 +36,7 @@ or Android).
.SH "REPORTING BUGS"
Report bugs to the c-ares mailing list:
.br
-\fBhttps://cool.haxx.se/mailman/listinfo/c-ares\fR
+\fBhttps://lists.haxx.se/listinfo/c-ares\fR
.SH "SEE ALSO"
.PP
acountry(1), adig(1).
diff --git a/docs/ares_free_data.3 b/docs/ares_free_data.3
index f8a65b9..18e83ce 100644
--- a/docs/ares_free_data.3
+++ b/docs/ares_free_data.3
@@ -60,6 +60,10 @@ associated with those structures.
When used to free the data returned by ares_parse_soa_reply(3) this
will free the ares_soa_reply structure, along with any additional storage
associated with those structure.
+.B ares_parse_uri_reply(3)
+When used to free the data returned by ares_parse_uri_reply(3) this
+will free list of ares_uri_reply structures, along with any additional
+storage associated with those structure.
.SH RETURN VALUE
The ares_free_data() function does not return a value.
.SH AVAILABILITY
diff --git a/docs/ares_getaddrinfo.3 b/docs/ares_getaddrinfo.3
index 6cae0ff..33c8a50 100644
--- a/docs/ares_getaddrinfo.3
+++ b/docs/ares_getaddrinfo.3
@@ -127,13 +127,15 @@ On successful completion of the query, the callback argument
.I result
points to a
.B struct ares_addrinfo
-which contains two linked lists, one with resolved addresses and another with canonical names.
+which contains two linked lists, one with resolved addresses and another with canonical names.
+Also included is the official name of the host (analogous to gethostbyname() h_name).
.PP
.RS
.EX
struct ares_addrinfo {
struct ares_addrinfo_cname *cnames;
struct ares_addrinfo_node *nodes;
+ char *name;
};
.EE
.RE
@@ -187,6 +189,8 @@ The result is sorted according to RFC6724 except:
Please note that the function will attempt a connection
on each of the resolved addresses as per RFC6724.
+.SH AVAILABILITY
+This function was added in c-ares 1.16.0, released in March 2020.
.SH SEE ALSO
.BR ares_freeaddrinfo (3)
.SH AUTHOR
diff --git a/docs/ares_parse_uri_reply.3 b/docs/ares_parse_uri_reply.3
new file mode 100644
index 0000000..09da1a9
--- /dev/null
+++ b/docs/ares_parse_uri_reply.3
@@ -0,0 +1,81 @@
+.\"
+.\" Copyright 1998 by the Massachusetts Institute of Technology.
+.\"
+.\" Permission to use, copy, modify, and distribute this
+.\" software and its documentation for any purpose and without
+.\" fee is hereby granted, provided that the above copyright
+.\" notice appear in all copies and that both that copyright
+.\" notice and this permission notice appear in supporting
+.\" documentation, and that the name of M.I.T. not be used in
+.\" advertising or publicity pertaining to distribution of the
+.\" software without specific, written prior permission.
+.\" M.I.T. makes no representations about the suitability of
+.\" this software for any purpose. It is provided "as is"
+.\" without express or implied warranty.
+.\"
+.TH ARES_PARSE_URI_REPLY 3 "14 August 2020"
+.SH NAME
+ares_parse_uri_reply \- Parse a reply to a DNS query of type URI
+.SH SYNOPSIS
+.nf
+.B #include <ares.h>
+.PP
+.B int ares_parse_uri_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
+.B struct ares_uri_reply** \fIuri_out\fP);
+.fi
+.SH DESCRIPTION
+The
+.B ares_parse_uri_reply
+function parses the response to a query of type URI into a
+linked list of
+.I struct ares_uri_reply
+The parameters
+.I abuf
+and
+.I alen
+give the contents of the response. The result is stored in allocated
+memory and a pointer to it stored into the variable pointed to by
+.IR uri_out .
+It is the caller's responsibility to free the resulting
+.IR uri_out
+structure when it is no longer needed using the function
+.B ares_free_data
+.PP
+The structure
+.I ares_uri_reply
+contains the following fields:
+.sp
+.in +4n
+.nf
+struct ares_uri_reply {
+ struct ares_uri_reply *next;
+ unsigned short weight;
+ unsigned short priority;
+ char *uri;
+ int ttl;
+};
+.fi
+.in
+.PP
+.SH RETURN VALUES
+.B ares_parse_uri_reply
+can return any of the following values:
+.TP 15
+.B ARES_SUCCESS
+The response was successfully parsed.
+.TP 15
+.B ARES_EBADRESP
+The response was malformatted.
+.TP 15
+.B ARES_ENODATA
+The response did not contain an answer to the query.
+.TP 15
+.B ARES_ENOMEM
+Memory was exhausted.
+.SH AVAILABILITY
+
+.SH SEE ALSO
+.BR ares_query (3)
+.BR ares_free_data (3)
+.SH AUTHOR
+Written by Jan Petrasek <petrasek@tes.eu>