batman-adv: Add documentation.

[people/ms/network.git] / man / network-dns-server.8.in

.TH network-dns-server 8 "22 Jun 2012" "@VERSION@" "network man page"

.SH NAME
network-dns-server \- Network Configuration Control Program

.SH SYNOPSIS
\fBnetwork [OPTIONS] dns-server [add|remove] <server> [<priority>]\fR
.P
\fBnetwork [OPTIONS] dns-server list\fR
.P
\fBnetwork [OPTIONS] dns-server update\fR

.SH DESCRIPTION
With help of the \fBdns-server\fR subcommand, you will be able to configure the
local DNS configuration. DNS is short for \fBDomain Name System\fR.
.PP
You may add and remove DNS servers as well as view the settings.

.SH OPTIONS
The \fBnetwork dns-server\fR command offers various commands:

\fBadd <server> [<priority>]\fR
.RS 4
A new DNS server may be added to the list by the \fBadd\fR command. A priority that
will rank the server may optionally be given.
.PP
\fB<server>\fR must be a valid IP address and \fB<priority>\fR must be an integer.
The smaller the number, the higher is the rank of the server.
.RE
.PP

\fBremove <server>\fR
.RS 4
A server may be removed by this command where \fB<server>\fR must an IP address.
.RE
.PP

\fBlist\fR
.RS 4
Outputs a list of all servers that are currently in use.
.RE
.PP

\fBupdate\fR
.RS 4
This command will recreate the system's configuration file. It should not be
required to use this command very often.
.RE
.PP

.SH CONFIG OPTIONS
These options may be set with the \fBnetwork-config\fR(8) command:

\fBDNS_USE_LOCAL_RESOLVER\fR = [\fBtrue\fR|false]
.RS 4
This option defines whether the local DNS resolver should be used or not.
.PP
Basically, the option adds localhost to the list of nameservers in
\fBresolv.conf\fR(5).
.RE
.PP

\fBDNS_RANDOMIZE\fR = [true|\fBfalse\fR]
.RS 4
This option will break the DNS server ranks and will query them in a
random order which is useful to load-balance multiple DNS servers.
.RE
.PP

.SH SEE ALSO
network(8), network-config(8)

.SH AUTHOR
Michael Tremer (michael.tremer@ipfire.org)