source: networking/netutils/networkmanager.xml@ c3c3cbf

systemd-13485
Last change on this file since c3c3cbf was 027c7d7, checked in by DJ Lucas <dj@…>, 9 years ago

Merge Chapter 16 from trunk.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16879 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 14.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY NetworkManager-download-http
8 "&gnome-download-http;/NetworkManager/1.0/NetworkManager-&NetworkManager-version;.tar.xz">
9 <!ENTITY NetworkManager-download-ftp
10 "&gnome-download-ftp;/NetworkManager/1.0/NetworkManager-&NetworkManager-version;.tar.xz">
11 <!ENTITY NetworkManager-md5sum "a8f54460a4708efd840358f32d0968fd">
12 <!ENTITY NetworkManager-size "3.4 MB">
13 <!ENTITY NetworkManager-buildsize "358 MB (with tests)">
14 <!ENTITY NetworkManager-time "2.5 SBU (with tests)">
15]>
16
17<sect1 id="NetworkManager" xreflabel="NetworkManager-&NetworkManager-version;">
18 <?dbhtml filename="networkmanager.html"?>
19
20 <sect1info>
21 <othername>$LastChangedBy$</othername>
22 <date>$Date$</date>
23 </sect1info>
24
25 <title>NetworkManager-&NetworkManager-version;</title>
26
27 <indexterm zone="NetworkManager">
28 <primary sortas="a-NetworkManager">NetworkManager</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to NetworkManager</title>
33
34 <para>
35 <application>NetworkManager</application> is a set of co-operative
36 tools that make networking simple and straightforward. Whether WiFi, wired,
37 3G, or Bluetooth, NetworkManager allows you to quickly move from one network
38 to another: Once a network has been configured and joined once, it can be
39 detected and re-joined automatically the next time it's available.
40 </para>
41
42 &lfs78_checked;
43
44 <note>
45 <para>
46 Make sure that you disable the <command>systemd-networkd</command> service
47 or configure it not to manage the interfaces you want to manage with
48 <application>NetworkManager</application>.
49 </para>
50 </note>
51
52 <bridgehead renderas="sect3">Package Information</bridgehead>
53 <itemizedlist spacing="compact">
54 <listitem>
55 <para>
56 Download (HTTP): <ulink url="&NetworkManager-download-http;"/>
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download (FTP): <ulink url="&NetworkManager-download-ftp;"/>
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Download MD5 sum: &NetworkManager-md5sum;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Download size: &NetworkManager-size;
72 </para>
73 </listitem>
74 <listitem>
75 <para>
76 Estimated disk space required: &NetworkManager-buildsize;
77 </para>
78 </listitem>
79 <listitem>
80 <para>
81 Estimated build time: &NetworkManager-time;
82 </para>
83 </listitem>
84 </itemizedlist>
85
86 <bridgehead renderas="sect3">NetworkManager Dependencies</bridgehead>
87
88 <bridgehead renderas="sect4">Required</bridgehead>
89 <para role="required">
90 <xref linkend="dbus-glib"/>,
91 <xref linkend="libgudev"/>,
92 <xref linkend="libndp"/>,
93 <xref linkend="libnl"/>, and
94 <xref linkend="nss"/>
95 </para>
96
97 <bridgehead renderas="sect4">Recommended</bridgehead>
98 <para role="recommended">
99<!-- <xref linkend="consolekit"/>, -->
100 <xref linkend="dhcpcd"/> or
101 <xref linkend="dhcp"/> (client only),
102 <xref linkend="gobject-introspection"/>,
103 <xref linkend="iptables"/>,
104 <xref linkend="libsoup"/>,
105 <xref linkend="newt"/> (for <command>nmtui</command>),
106 <xref linkend="polkit"/>,
107 <xref linkend="systemd"/>,
108 <xref linkend="upower"/>,
109 <xref linkend="vala"/>, and
110 <xref linkend="wpa_supplicant"/> (built with D-Bus support),
111 </para>
112
113 <bridgehead renderas="sect4">Optional</bridgehead>
114 <para role="optional">
115 <xref linkend="bluez"/> (runtime),
116 <xref linkend="gtk-doc"/>,
117 <xref linkend="ModemManager"/>,
118 <xref linkend="pygobject3"/>,
119 <xref linkend="qt4"/>,
120 <xref linkend="valgrind"/>,
121 <ulink url="http://libteam.org/">libteam</ulink>,
122 <ulink url="https://www.samba.org/ftp/ppp/">PPP</ulink> and
123 <ulink url="https://www.roaringpenguin.com/products/pppoe">RP-PPPoE</ulink>
124 </para>
125
126 <para condition="html" role="usernotes">User Notes:
127 <ulink url="&blfs-wiki;/NetworkManager"/>
128 </para>
129 </sect2>
130
131 <sect2 role="installation">
132 <title>Installation of NetworkManager</title>
133
134 <para>
135 Install <application>NetworkManager</application> by running the
136 following commands:
137 </para>
138
139<screen><userinput>./configure --prefix=/usr \
140 --sysconfdir=/etc \
141 --localstatedir=/var \
142 --with-nmtui \
143 --disable-ppp \
144 --with-session-tracking=systemd \
145 --with-systemdsystemunitdir=/lib/systemd/system \
146 --docdir=/usr/share/doc/NetworkManager-&NetworkManager-version; &amp;&amp;
147make</userinput></screen>
148
149 <para>
150 An already active graphical session with bus address is necessary to run
151 the tests. To test the results, issue: <command>make check</command>.
152 </para>
153
154 <para>
155 Now, as the <systemitem class="username">root</systemitem> user:
156 </para>
157
158<screen role="root"><userinput>make install</userinput></screen>
159
160 </sect2>
161
162 <sect2 role="commands">
163 <title>Command Explanations</title>
164
165 <para>
166 <parameter>--with-nmtui</parameter>: This switch enables building
167 of the <command>nmtui</command> program. Remove it if you have
168 not installed <xref linkend="newt"/>.
169 </para>
170
171 <para>
172 <parameter>--disable-ppp</parameter>: This switch disables
173 <application>PPP</application> support in
174 <application>NetworkManager</application>. Remove it if you have
175 installed <application>PPP</application>.
176 </para>
177
178 <para>
179 <parameter>--with-session-tracking=systemd</parameter>: This switch
180 is used to set <command>systemd-logind</command> as the default
181 program for session tracking.
182 </para>
183
184 <para>
185 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
186 This switch is used to set the correct installation directory for
187 systemd units.
188 </para>
189
190 <para>
191 <option>--enable-gtk-doc</option>: Use this switch if you have installed
192 <xref linkend="gtk-doc"/> and wish to build the API manuals.
193 </para>
194
195 <para>
196 <option>--without-iptables</option>: Use this switch if you don't have
197 <application>Iptables</application> installed.
198 </para>
199
200 </sect2>
201
202 <sect2 role="configuration">
203 <title>Configuring NetworkManager</title>
204
205 <sect3 id="NetworkManager-config">
206 <title>Config Files</title>
207 <para>
208 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
209 </para>
210
211 <indexterm zone="NetworkManager NetworkManager-config">
212 <primary sortas="e-etc-NetworkManager-NetworkManager.conf">
213 /etc/NetworkManager/NetworkManager.conf</primary>
214 </indexterm>
215
216 </sect3>
217
218 <sect3><title>Configuration Information</title>
219
220 <para>
221 For <application>NetworkManager</application> to work, at least a
222 minimal configuration file must be present. Such file is not
223 installed with <command>make install</command>. Issue the following
224 command as the
225 <systemitem class="username">root</systemitem> user to create a
226 minimal <filename>NetworkManager.conf</filename> file:
227 </para>
228
229<screen role="root"><userinput>cat &gt;&gt; /etc/NetworkManager/NetworkManager.conf &lt;&lt; "EOF"
230<literal>[main]
231plugins=keyfile</literal>
232EOF</userinput></screen>
233
234 <para>
235 You can add <option>dns=none</option> to suppress changes to
236 <filename>/etc/resolv.conf</filename>. See
237 <command>man 5 NetworkManager.conf</command>
238 for any additional options.
239 </para>
240
241 </sect3>
242
243 <sect3 id="NetworkManager-init">
244 <title>Systemd Units</title>
245
246 <para>
247 To start the <command>NetworkManager</command> daemon at boot, enable
248 the previously installed systemd unit by running the following command
249 as the <systemitem class="username">root</systemitem> user:
250 </para>
251
252 <indexterm zone="NetworkManager NetworkManager-init">
253 <primary sortas="f-NetworkManager">NetworkManager</primary>
254 </indexterm>
255
256<screen role="root"><userinput>systemctl enable NetworkManager</userinput></screen>
257
258 <para>
259 <application>NetworkManager</application> also ships a systemd unit
260 called <filename>NetworkManager-wait-online.service</filename> which
261 can be used to prevent services that require network connectivity
262 from starting until <application>NetworkManager</application> has
263 established the connection. To enable it, run the following command
264 as the <systemitem class="username">root</systemitem> user:
265 </para>
266
267<screen role="root"><userinput>systemctl enable NetworkManager-wait-online</userinput></screen>
268
269 </sect3>
270
271 </sect2>
272
273 <sect2 role="content">
274 <title>Contents</title>
275
276 <segmentedlist>
277 <segtitle>Installed Programs</segtitle>
278 <segtitle>Installed Libraries</segtitle>
279 <segtitle>Installed Directories</segtitle>
280
281 <seglistitem>
282 <seg>
283 NetworkManager, nmcli, nm-online, and, hardlinked to each other:
284 nmtui, nmtui-connect, nmtui-edit, and nmtui-hostname
285 </seg>
286 <seg>
287 libnm-glib.so, libnm-glib-vpn.so, libnm.so, libnm-util.so, and
288 modules under /usr/lib/NetworkManager
289 </seg>
290 <seg>
291 /etc/NetworkManager,
292 /usr/include/{libnm,libnm-glib,NetworkManager},
293 /usr/lib/NetworkManager,
294 /usr/share/doc/NetworkManager-&NetworkManager-version;,
295 /usr/share/gtk-doc/html/{libnm,libnm-glib,libnm-util,NetworkManager},
296 and
297 /var/{lib,run}/NetworkManager
298 </seg>
299 </seglistitem>
300 </segmentedlist>
301
302 <variablelist>
303 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
304 <?dbfo list-presentation="list"?>
305 <?dbhtml list-presentation="table"?>
306
307 <varlistentry id="nmcli">
308 <term><command>nmcli</command></term>
309 <listitem>
310 <para>
311 is a command-line tool for controlling
312 <application>NetworkManager</application>
313 and getting its status.
314 </para>
315 <indexterm zone="NetworkManager nmcli">
316 <primary sortas="b-nmcli">nmcli</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="nm-online">
322 <term><command>nm-online</command></term>
323 <listitem>
324 <para>
325 is a utility to find out whether you are online.
326 </para>
327 <indexterm zone="NetworkManager nm-online">
328 <primary sortas="b-nm-online">nm-online</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="nmtui">
334 <term><command>nmtui</command></term>
335 <listitem>
336 <para>
337 interactive ncurses based interface for
338 <application>nmcli</application>.
339 </para>
340 <indexterm zone="NetworkManager nmtui">
341 <primary sortas="b-nmtui">nmtui</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="nmtui-connect">
347 <term><command>nmtui-connect</command></term>
348 <listitem>
349 <para>
350 interactive ncurses based interface connection activate/deactivate.
351 </para>
352 <indexterm zone="NetworkManager nmtui-connect">
353 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="nmtui-edit">
359 <term><command>nmtui-edit</command></term>
360 <listitem>
361 <para>
362 interactive ncurses based interface connection editor.
363 </para>
364 <indexterm zone="NetworkManager nmtui-edit">
365 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="nmtui-hostname">
371 <term><command>nmtui-hostname</command></term>
372 <listitem>
373 <para>
374 interactive ncurses based interface hostname editor.
375 </para>
376 <indexterm zone="NetworkManager nmtui-hostname">
377 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="NetworkManager-prog">
383 <term><command>NetworkManager</command></term>
384 <listitem>
385 <para>
386 is the network management daemon.
387 </para>
388 <indexterm zone="NetworkManager NetworkManager-prog">
389 <primary sortas="b-NetworkManager">NetworkManager</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="libnm-glib">
395 <term><filename class="libraryfile">libnm-glib.so</filename></term>
396 <listitem>
397 <para>
398 contains functions used by <application>NetworkManager</application>.
399 </para>
400 <indexterm zone="NetworkManager libnm-glib">
401 <primary sortas="c-libnm-glib">libnm-glib.so</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405
406 <varlistentry id="libnm-glib-vpn">
407 <term><filename class="libraryfile">libnm-glib-vpn.so</filename></term>
408 <listitem>
409 <para>
410 contains functions used by <application>NetworkManager</application>
411 VPN plugins.
412 </para>
413 <indexterm zone="NetworkManager libnm-glib-vpn">
414 <primary sortas="c-libnm-glib-vpn">libnm-glib-vpn.so</primary>
415 </indexterm>
416 </listitem>
417 </varlistentry>
418
419 <varlistentry id="libnm-util">
420 <term><filename class="libraryfile">libnm-util.so</filename></term>
421 <listitem>
422 <para>
423 contains functions used by <application>NetworkManager</application>
424 utils.
425 </para>
426 <indexterm zone="NetworkManager libnm-util">
427 <primary sortas="c-libnm-util">libnm-util.so</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 </variablelist>
433
434 </sect2>
435
436</sect1>
Note: See TracBrowser for help on using the repository browser.