aec52d4709db3f95bfa6fd004a09d25300de0e4f
[people/ms/network.git] / man / network-dns-server.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN"
3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <refentry id="network-dns-server">
6         <refentryinfo>
7                 <title>network-dns-server</title>
8                 <productname>network</productname>
9
10                 <authorgroup>
11                         <author>
12                                 <contrib>Developer</contrib>
13                                 <firstname>Michael</firstname>
14                                 <surname>Tremer</surname>
15                                 <email>michael.tremer@ipfire.org</email>
16                         </author>
17                 </authorgroup>
18         </refentryinfo>
19
20         <refmeta>
21                 <refentrytitle>network-dns-server</refentrytitle>
22                 <manvolnum>8</manvolnum>
23         </refmeta>
24
25         <refnamediv>
26                 <refname>network-dns-server</refname>
27                 <refpurpose>Network Configuration Control Program</refpurpose>
28         </refnamediv>
29
30         <refsynopsisdiv>
31                 <cmdsynopsis>
32                         <command>network dns-server <arg choice="plain">[add|remove]</arg> <arg choice="plain">SERVER</arg> [<arg choice="plain">PRIORITY</arg>]</command>
33                 </cmdsynopsis>
34
35                 <cmdsynopsis>
36                         <command>network dns-server <arg choice="plain">[list|update]</arg></command>
37                 </cmdsynopsis>
38         </refsynopsisdiv>
39
40         <refsect1>
41                 <title>Description</title>
42
43                 <para>
44                         With help of the <command>dns-server</command> subcommand, you will
45                         be able to configure the local DNS configuration.
46                         DNS is short for Domain Name System.
47                 </para>
48                 <para>
49                         You may add and remove DNS servers as well as view the settings.
50                 </para>
51         </refsect1>
52
53         <refsect1>
54                 <title>Commands</title>
55
56                 <para>
57                         The following commands are understood:
58                 </para>
59
60                 <variablelist>
61                         <varlistentry>
62                                 <term>
63                                         <command>
64                                                 add
65                                                 <replaceable>SERVER</replaceable>
66                                                 [<replaceable>PRIORITY</replaceable>]
67                                         </command>
68                                 </term>
69
70                                 <listitem>
71                                         <para>
72                                                 A new DNS server may be added to the list by the
73                                                 <command>add</command> command. A priority that will
74                                                 rank the server my optionally be given.
75                                         </para>
76                                         <para>
77                                                 <replaceable>SERVER</replaceable> must be a valid IP address
78                                                 and <replaceable>PRIORITY</replaceable> must be a positive
79                                                 integer number. The smaller this number, the higher is
80                                                 is the rank of the server.
81                                         </para>
82                                 </listitem>
83                         </varlistentry>
84
85                         <varlistentry>
86                                 <term>
87                                         <command>
88                                                 remove
89                                                 <replaceable>SERVER</replaceable>
90                                         </command>
91                                 </term>
92
93                                 <listitem>
94                                         <para>
95                                                 The given server will be removed from the list of
96                                                 DNS servers.
97                                         </para>
98                                 </listitem>
99                         </varlistentry>
100
101                         <varlistentry>
102                                 <term>
103                                         <command>list</command>
104                                 </term>
105
106                                 <listitem>
107                                         <para>
108                                                 Shows a list of all servers that are currently in use.
109                                         </para>
110                                 </listitem>
111                         </varlistentry>
112
113                         <varlistentry>
114                                 <term>
115                                         <command>update</command>
116                                 </term>
117
118                                 <listitem>
119                                         <para>
120                                                 This command will re-create the system's configuration
121                                                 files. It should not be required to use this command
122                                                 very often.
123                                         </para>
124                                 </listitem>
125                         </varlistentry>
126                 </variablelist>
127         </refsect1>
128
129         <refsect1>
130                 <title>Variables</title>
131
132                 <para>
133                         These variables may be set by using the <citerefentry>
134                                 <refentrytitle>network-settings</refentrytitle>
135                                 <manvolnum>8</manvolnum>
136                         </citerefentry> command.
137                 </para>
138
139                 <variablelist>
140                         <varlistentry>
141                                 <term>
142                                         <varname>DNS_USE_LOCAL_RESOLVER</varname>=[<emphasis>true</emphasis>|false]
143                                 </term>
144
145                                 <listitem>
146                                         <para>
147                                                 This option defines whether the local DNS resolver should
148                                                 be used or not.
149                                         </para>
150                                         <para>
151                                                 Basically, the option adds localhost to the list of
152                                                 nameservers in <citerefentry>
153                                                         <refentrytitle>resolv.conf</refentrytitle>
154                                                         <manvolnum>5</manvolnum>
155                                                 </citerefentry>.
156                                         </para>
157                                 </listitem>
158                         </varlistentry>
159
160                         <varlistentry>
161                                 <term>
162                                         <varname>DNS_SEARCH_DOMAINS</varname>=
163                                 </term>
164
165                                 <listitem>
166                                         <para>
167                                                 This setting configures the search domains for DNS queries
168                                                 made by the local system.
169                                         </para>
170                                 </listitem>
171                         </varlistentry>
172
173                         <varlistentry>
174                                 <term>
175                                         <varname>DNS_RANDOMIZE</varname>=[true|<emphasis>false</emphasis>]
176                                 </term>
177
178                                 <listitem>
179                                         <para>
180                                                 This option will break the DNS server ranks and will query
181                                                 them in a random order which is useful to load-balance
182                                                 multiple DNS servers.
183                                         </para>
184                                 </listitem>
185                         </varlistentry>
186                 </variablelist>
187         </refsect1>
188
189         <refsect1>
190                 <title>See Also</title>
191
192                 <para>
193                         <citerefentry>
194                                 <refentrytitle>network</refentrytitle>
195                                 <manvolnum>8</manvolnum>
196                         </citerefentry>,
197                         <citerefentry>
198                                 <refentrytitle>network-settings</refentrytitle>
199                                 <manvolnum>8</manvolnum>
200                         </citerefentry>
201                 </para>
202         </refsect1>
203 </refentry>