Blame ares_set_servers_csv.3

Packit 514978
.\"
Packit 514978
.\" Copyright 2010 by Ben Greear <greearb@candelatech.com>
Packit 514978
.\"
Packit 514978
.\" Permission to use, copy, modify, and distribute this
Packit 514978
.\" software and its documentation for any purpose and without
Packit 514978
.\" fee is hereby granted, provided that the above copyright
Packit 514978
.\" notice appear in all copies and that both that copyright
Packit 514978
.\" notice and this permission notice appear in supporting
Packit 514978
.\" documentation, and that the name of M.I.T. not be used in
Packit 514978
.\" advertising or publicity pertaining to distribution of the
Packit 514978
.\" software without specific, written prior permission.
Packit 514978
.\" M.I.T. makes no representations about the suitability of
Packit 514978
.\" this software for any purpose.  It is provided "as is"
Packit 514978
.\" without express or implied warranty.
Packit 514978
.\"
Packit 514978
.TH ARES_SET_SERVERS_CSV 3 "30 June 2010"
Packit 514978
.SH NAME
Packit 514978
ares_set_servers_csv, ares_set_servers_ports_csv \- Set list of DNS servers to be used.
Packit 514978
.SH SYNOPSIS
Packit 514978
.nf
Packit 514978
.B #include <ares.h>
Packit 514978
.PP
Packit 514978
.B int ares_set_servers_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP)
Packit 514978
.B int ares_set_servers_ports_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP)
Packit 514978
.fi
Packit 514978
.SH DESCRIPTION
Packit 514978
The \fBares_set_servers_csv\fP and \fBares_set_servers_ports_csv\fPfunctions set
Packit 514978
the list of DNS servers that ARES will query.  The format of the servers option is:
Packit 514978
Packit 514978
host[:port][,host[:port]]...
Packit 514978
Packit 514978
For example:
Packit 514978
Packit 514978
192.168.1.100,192.168.1.101,3.4.5.6
Packit 514978
.PP
Packit 514978
The \fBares_set_servers_csv\fP function will ignore any port values specified in
Packit 514978
the input string, whereare the \fBares_set_servers_ports_csv\fP function will
Packit 514978
apply any specified port values as the UDP and TCP port to be used for that
Packit 514978
particular nameserver.
Packit 514978
Packit 514978
.SH RETURN VALUES
Packit 514978
.B ares_set_servers_csv(3)
Packit 514978
This function may return any of the following values:
Packit 514978
.TP 15
Packit 514978
.B ARES_SUCCESS
Packit 514978
The name servers configuration was successfully initialized.
Packit 514978
.TP 15
Packit 514978
.B ARES_ENOMEM
Packit 514978
The process's available memory was exhausted.
Packit 514978
.TP 15
Packit 514978
.B ARES_ENODATA
Packit 514978
The channel data identified by
Packit 514978
.IR channel
Packit 514978
was invalid.
Packit 514978
.TP 15
Packit 514978
.B ARES_ENOTINITIALIZED
Packit 514978
c-ares library initialization not yet performed.
Packit 514978
.SH SEE ALSO
Packit 514978
.BR ares_set_servers (3)
Packit 514978
.SH AVAILABILITY
Packit 514978
\fBares_set_servers_csv\fP was added in c-ares 1.7.2;
Packit 514978
\fBares_set_servers_ports_csv\fP was added in c-ares 1.11.0.
Packit 514978
.SH AUTHOR
Packit 514978
Ben Greear