]> git.eshelyaron.com Git - emacs.git/commitdiff
Add network-lookup-address-info description
authorRobert Pluim <rpluim@gmail.com>
Tue, 17 Jul 2018 11:11:57 +0000 (13:11 +0200)
committerRobert Pluim <rpluim@gmail.com>
Tue, 17 Jul 2018 11:11:57 +0000 (13:11 +0200)
* doc/lispref/processes.texi (Misc Network): Document
  network-lookup-address-info.

doc/lispref/processes.texi

index 447644022c5425618e1575e5c457a56d21770d79..557cd4678a34215b7561bf1e7806e5e4e663b65c 100644 (file)
@@ -2923,6 +2923,21 @@ If the vector does not include the port number, @var{p}, or if
 @code{:@var{p}} suffix.
 @end defun
 
+@defun network-lookup-address-info name &optional family
+This function is used to perform hostname lookups on @var{name}, which
+is expected to be an ASCII-only string, otherwise an error is
+signaled. Call @code{puny-encode-domain} on @var{name}
+first if you wish to lookup internationalized hostnames.
+
+If successful it returns a list of Lisp representations of network
+addresses (without port numbers), otherwise it returns @code{nil}.
+
+By default both IPv4 and IPv6 lookups are attempted.  The optional
+argument @var{family} controls this behavior, specifying the symbol
+@code{ipv4} or @code{ipv6} restricts lookups to IPv4 and IPv6
+respectively.
+@end defun
+
 @node Serial Ports
 @section Communicating with Serial Ports
 @cindex @file{/dev/tty}