summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1998-08-07 18:07:36 (GMT)
committerGuido van Rossum <guido@python.org>1998-08-07 18:07:36 (GMT)
commitcdf6af12330cea3d6d5fd21c5a77015a83291858 (patch)
treee9c093852507ca1a62412352e050c8aad0a918a1
parent96e11029b88fe73d9e3b400abd3825aa9fc019ef (diff)
downloadcpython-cdf6af12330cea3d6d5fd21c5a77015a83291858.zip
cpython-cdf6af12330cea3d6d5fd21c5a77015a83291858.tar.gz
cpython-cdf6af12330cea3d6d5fd21c5a77015a83291858.tar.bz2
Document gethostbyname_ex().
-rw-r--r--Doc/lib/libsocket.tex13
1 files changed, 12 insertions, 1 deletions
diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
index 4a1558e..47a2914 100644
--- a/Doc/lib/libsocket.tex
+++ b/Doc/lib/libsocket.tex
@@ -98,7 +98,18 @@ for a few symbols, default values are provided.
\begin{funcdesc}{gethostbyname}{hostname}
Translate a host name to IP address format. The IP address is
returned as a string, e.g., \code{'100.50.200.5'}. If the host name
-is an IP address itself it is returned unchanged.
+is an IP address itself it is returned unchanged. See
+\code{gethostbyname_ex} for a more complete interface.
+\end{funcdesc}
+
+\begin{funcdesc}{gethostbyname_ex}{hostname}
+Translate a host name to IP address format, extended interface.
+Return a triple \code{(hostname, aliaslist, ipaddrlist)} where
+\code{hostname} is the primary host name responding to the given
+\var{ip_address}, \code{aliaslist} is a (possibly empty) list of
+alternative host names for the same address, and \code{ipaddrlist} is
+a list of IP addresses for the same interface on the same
+host (often but not always a single address).
\end{funcdesc}
\begin{funcdesc}{gethostname}{}