man: Convert network-device(8) to asciidoc
[people/ms/network.git] / man / network-dhcp.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-dhcp">
6         <refentryinfo>
7                 <title>network-dhcp</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-dhcp</refentrytitle>
22                 <manvolnum>8</manvolnum>
23         </refmeta>
24
25         <refnamediv>
26                 <refname>network-dhcp</refname>
27                 <refpurpose>Network Configuration Control Program</refpurpose>
28         </refnamediv>
29
30         <refsynopsisdiv>
31                 <cmdsynopsis>
32                         <command>network <arg choice="plain">[dhcpv6|dhcpv4]</arg> <arg choice="plain">command</arg> ...</command>
33                 </cmdsynopsis>
34         </refsynopsisdiv>
35
36         <refsect1>
37                 <title>Description</title>
38
39                 <para>
40                         With help of the <command>dhcp</command> commands it is possible to
41                         configure DHCP servers for IPv6 and IPv4.
42                 </para>
43         </refsect1>
44
45         <refsect1>
46                 <title>Commands</title>
47
48                 <para>
49                         The following commands are understood:
50                 </para>
51
52                 <variablelist>
53                         <varlistentry>
54                                 <term>
55                                         <command>start</command>
56                                 </term>
57
58                                 <listitem>
59                                         <para>
60                                                 Starts the DHCP service.
61                                         </para>
62                                 </listitem>
63                         </varlistentry>
64
65                         <varlistentry>
66                                 <term>
67                                         <command>stop</command>
68                                 </term>
69
70                                 <listitem>
71                                         <para>
72                                                 Stops the DHCP service.
73                                         </para>
74                                 </listitem>
75                         </varlistentry>
76
77                         <varlistentry>
78                                 <term>
79                                         <command>restart</command>
80                                 </term>
81
82                                 <listitem>
83                                         <para>
84                                                 Restarts the DHCP service immediately.
85                                         </para>
86                                 </listitem>
87                         </varlistentry>
88
89                         <varlistentry>
90                                 <term>
91                                         <command>reload</command>
92                                 </term>
93
94                                 <listitem>
95                                         <para>
96                                                 Reload the DHCP service configuration.
97                                         </para>
98                                 </listitem>
99                         </varlistentry>
100
101                         <varlistentry>
102                                 <term>
103                                         <command>show</command>
104                                 </term>
105
106                                 <listitem>
107                                         <para>
108                                                 Shows the DHCP configuration.
109                                         </para>
110                                 </listitem>
111                         </varlistentry>
112
113                         <varlistentry>
114                                 <term>
115                                         <command>subnet ...</command>
116                                 </term>
117
118                                 <listitem>
119                                         <para>
120                                                 Use this command to manage subnets.
121                                                 See <citerefentry>
122                                                         <refentrytitle>network-dhcp-subnet</refentrytitle>
123                                                         <manvolnum>8</manvolnum>
124                                                 </citerefentry> for details.
125                                         </para>
126                                 </listitem>
127                         </varlistentry>
128                 </variablelist>
129         </refsect1>
130
131         <refsect1>
132                 <title>See Also</title>
133
134                 <para>
135                         <citerefentry>
136                                 <refentrytitle>network</refentrytitle>
137                                 <manvolnum>8</manvolnum>
138                         </citerefentry>,
139                         <citerefentry>
140                                 <refentrytitle>network-dhcp-subnet</refentrytitle>
141                                 <manvolnum>8</manvolnum>
142                         </citerefentry>
143                 </para>
144         </refsect1>
145 </refentry>