Document socket.getfqdn().

This commit is contained in:
Fred Drake 2000-08-16 14:21:42 +00:00
parent b526e5fa99
commit 5772c86816
1 changed files with 12 additions and 4 deletions

View File

@ -101,6 +101,16 @@ those symbols that are defined in the \UNIX{} header files are defined;
for a few symbols, default values are provided. for a few symbols, default values are provided.
\end{datadesc} \end{datadesc}
\begin{funcdesc}{getfqdn}{\optional{name}}
Return a fully qualified domain name for \var{name}.
If \var{name} is omitted or empty, it is interpreted as the local
host. To find the fully qualified name, the hostname returned by
\function{gethostbyaddr()} is checked, then aliases for the host, if
available. The first name which includes a period is selected. In
case no fully qualified domain name is available, the hostname is
returned.
\end{funcdesc}
\begin{funcdesc}{gethostbyname}{hostname} \begin{funcdesc}{gethostbyname}{hostname}
Translate a host name to IP address format. The IP address is 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 returned as a string, e.g., \code{'100.50.200.5'}. If the host name
@ -134,10 +144,8 @@ responding to the given \var{ip_address}, \var{aliaslist} is a
(possibly empty) list of alternative host names for the same address, (possibly empty) list of alternative host names for the same address,
and \var{ipaddrlist} is a list of IP addresses for the same interface and \var{ipaddrlist} is a list of IP addresses for the same interface
on the same host (most likely containing only a single address). on the same host (most likely containing only a single address).
To find the fully qualified domain name, check \var{hostname} and the To find the fully qualified domain name, use the function
items of \var{aliaslist} for an entry containing at least one period. \function{getfqdn()}.
An implementation of this algorithm can be found in the module
\module{smtplib} in form of the \function{make_fqdn()} function.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{getprotobyname}{protocolname} \begin{funcdesc}{getprotobyname}{protocolname}