source: networking/netutils/networkmanager.xml@ 7ea3791

10.0 10.1 11.0 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 7ea3791 was 7ea3791, checked in by Tim Tassonis <stuff@…>, 4 years ago

Update to NetworkManager-1.10.6

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19972 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 18.6 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.10/NetworkManager-&NetworkManager-version;.tar.xz">
9 <!ENTITY NetworkManager-download-ftp
10 "&gnome-download-ftp;/NetworkManager/1.10/NetworkManager-&NetworkManager-version;.tar.xz">
11 <!ENTITY NetworkManager-md5sum "de3c7147a693da6f80eb22f126086a14">
12 <!ENTITY NetworkManager-size "3.9 MB">
13 <!ENTITY NetworkManager-buildsize "596 MB (with tests)">
14 <!ENTITY NetworkManager-time "2.6 SBU (with tests)">
15 <!-- Values with tests for this release were too miniscule to add in. -->
16]>
17
18<sect1 id="NetworkManager" xreflabel="NetworkManager-&NetworkManager-version;">
19 <?dbhtml filename="networkmanager.html"?>
20
21 <sect1info>
22 <othername>$LastChangedBy$</othername>
23 <date>$Date$</date>
24 </sect1info>
25
26 <title>NetworkManager-&NetworkManager-version;</title>
27
28 <indexterm zone="NetworkManager">
29 <primary sortas="a-NetworkManager">NetworkManager</primary>
30 </indexterm>
31
32 <sect2 role="package">
33 <title>Introduction to NetworkManager</title>
34
35 <para>
36 <application>NetworkManager</application> is a set of co-operative
37 tools that make networking simple and straightforward. Whether WiFi,
38 wired, 3G, or Bluetooth, NetworkManager allows you to quickly move from
39 one network to another: Once a network has been configured and joined
40 once, it can be detected and re-joined automatically the next time it's
41 available.
42 </para>
43
44 &lfs82_checked;
45
46 <note revision="systemd">
47 <para>
48 Make sure that you disable the <command>systemd-networkd</command>
49 service or configure it not to manage the interfaces you want to manage
50 with <application>NetworkManager</application>.
51 </para>
52 </note>
53
54 <bridgehead renderas="sect3">Package Information</bridgehead>
55 <itemizedlist spacing="compact">
56 <listitem>
57 <para>
58 Download (HTTP): <ulink url="&NetworkManager-download-http;"/>
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download (FTP): <ulink url="&NetworkManager-download-ftp;"/>
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Download MD5 sum: &NetworkManager-md5sum;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Download size: &NetworkManager-size;
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Estimated disk space required: &NetworkManager-buildsize;
79 </para>
80 </listitem>
81 <listitem>
82 <para>
83 Estimated build time: &NetworkManager-time;
84 </para>
85 </listitem>
86 </itemizedlist>
87
88 <bridgehead renderas="sect3">NetworkManager Dependencies</bridgehead>
89
90 <bridgehead renderas="sect4">Required</bridgehead>
91 <para role="required">
92 <xref linkend="dbus-glib"/>,
93 <xref linkend="libndp"/>,
94 <xref linkend="libnl"/>, and
95 <xref linkend="nss"/>
96 </para>
97
98 <bridgehead renderas="sect4">Recommended</bridgehead>
99 <para role="recommended">
100 <phrase revision="sysv"><xref linkend="consolekit"/>,</phrase>
101 <xref linkend="curl"/>,
102 <xref linkend="dhcpcd"/> or
103 <xref linkend="dhcp"/> (client only),
104 <xref linkend="gobject-introspection"/>,
105 <xref linkend="iptables"/>,
106 <xref linkend="newt"/> (for <command>nmtui</command>),
107 <xref linkend="polkit"/>,
108 <xref linkend="pygobject3"/>,
109 <phrase revision="systemd"><xref linkend="systemd"/>,</phrase>
110 <xref linkend="upower"/>,
111 <xref linkend="vala"/>, and
112 <xref linkend="wpa_supplicant"/> (built with D-Bus support),
113 </para>
114
115 <bridgehead renderas="sect4">Optional</bridgehead>
116 <para role="optional">
117 <xref linkend="bluez"/>,
118 <xref linkend="gtk-doc"/>,
119 <xref linkend="qt5"/> (for examples),
120 <xref linkend="ModemManager"/>,
121 <xref linkend="valgrind"/>,
122 <ulink url="http://www.thekelleys.org.uk/dnsmasq/doc.html">dnsmasq</ulink>,
123 <ulink url="http://www.digip.org/jansson/">Jansson</ulink>,
124 <ulink url="https://github.com/jpirko/libteam">libteam</ulink>,
125 <ulink url="https://github.com/rockdaboot/libpsl">libpsl</ulink>,
126 <ulink url="https://www.samba.org/ftp/ppp/">PPP</ulink>, and
127 <ulink url="https://www.roaringpenguin.com/products/pppoe">RP-PPPoE</ulink>
128 </para>
129
130 <para condition="html" role="usernotes">User Notes:
131 <ulink url="&blfs-wiki;/NetworkManager"/>
132 </para>
133 </sect2>
134
135 <sect2 role="installation">
136 <title>Installation of NetworkManager</title>
137
138 <para>If <xref linkend="qt5"/> is installed and the Qt based
139 examples are desired, fix the configure script:</para>
140
141<screen><userinput>sed -e '/Qt[CDN]/s/Qt/Qt5/g' \
142 -e 's/moc_location/host_bins/' \
143 -i configure</userinput></screen>
144
145 <para>
146 Install <application>NetworkManager</application> by running the
147 following commands:
148 </para>
149
150<screen revision="sysv"><userinput>CXXFLAGS="-O2 -fPIC" \
151./configure --prefix=/usr \
152 --sysconfdir=/etc \
153 --localstatedir=/var \
154 --with-nmtui \
155 --disable-ppp \
156 --disable-json-validation \
157 --disable-ovs \
158 --with-udev-dir=/lib/udev \
159 --with-systemdsystemunitdir=no \
160 --docdir=/usr/share/doc/network-manager-&NetworkManager-version; &amp;&amp;
161make</userinput></screen>
162
163<screen revision="systemd"><userinput>CXXFLAGS="-O2 -fPIC" \
164./configure --prefix=/usr \
165 --sysconfdir=/etc \
166 --localstatedir=/var \
167 --with-nmtui \
168 --disable-ppp \
169 --disable-json-validation \
170 --disable-ovs \
171 --with-udev-dir=/lib/udev \
172 --with-session-tracking=systemd \
173 --with-systemdsystemunitdir=/lib/systemd/system \
174 --docdir=/usr/share/doc/network-manager-&NetworkManager-version; &amp;&amp;
175make</userinput></screen>
176
177 <para>
178 An already active graphical session with bus address is necessary to run
179 the tests. To test the results, issue: <command>make check</command>.
180 </para>
181
182 <para>
183 Now, as the <systemitem class="username">root</systemitem> user:
184 </para>
185
186<screen role="root"><userinput>make install</userinput></screen>
187
188 </sect2>
189
190 <sect2 role="commands">
191 <title>Command Explanations</title>
192
193 <para>
194 <envar>CXXFLAGS="-O2 -fPIC"</envar>: These compiler options are
195 necessary to build the Qt5 based examples.
196 </para>
197
198 <para>
199 <parameter>--with-nmtui</parameter>: This parameter enables build of
200 <command>nmtui</command>.
201 </para>
202
203 <para revision="systemd">
204 <parameter>--with-session-tracking=systemd</parameter>: This switch
205 is used to set <command>systemd-logind</command> as the default
206 program for session tracking.
207 </para>
208
209 <para revision="sysv">
210 <parameter>--with-systemdsystemunitdir=no</parameter>: systemd is not
211 used for sysv init systems.
212 </para>
213
214 <para revision="systemd">
215 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
216 This switch is used to set the correct installation directory for
217 systemd units.
218 </para>
219
220 <para>
221 <parameter>--disable-ppp</parameter>: This parameter disables
222 <application>PPP</application> support in
223 <application>NetworkManager</application>.
224 </para>
225
226 <para>
227 <parameter>--disable-json-validation</parameter>: This parameter allows
228 building without <application>Jansson</application>, which is needed
229 for <quote>team</quote> configuration validation (team is one way
230 of bonding network interfaces for increased throughput).
231 </para>
232
233 <para>
234 <parameter>--disable-ovs</parameter>: This paramenter disables
235 <application>Open Virtual Switch</application> support because it
236 requires <application>Jansson</application> which is not available in
237 BLFS.
238 </para>
239
240 <para>
241 <option>--enable-gtk-doc</option>: Use this switch if you have installed
242 <xref linkend="gtk-doc"/> and wish to build the API manuals.
243 </para>
244
245 <para>
246 <option>--without-iptables</option>: Use this switch if you don't have
247 <application>Iptables</application> installed.
248 </para>
249
250 <para>
251 <option>--disable-introspection</option>: Use this switch if <xref
252 linkend="gobject-introspection"/> is installed and you want to build
253 without introspection support. This also removes the need for <xref
254 linkend="pygobject3"/>.
255 </para>
256
257 </sect2>
258
259 <sect2 role="configuration">
260 <title>Configuring NetworkManager</title>
261
262 <sect3 id="NetworkManager-config">
263 <title>Config Files</title>
264 <para>
265 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
266 </para>
267
268 <indexterm zone="NetworkManager NetworkManager-config">
269 <primary
270 sortas="e-etc-NetworkManager-NetworkManager.conf">
271 /etc/NetworkManager/NetworkManager.conf</primary>
272 </indexterm>
273
274 </sect3>
275
276 <sect3><title>Configuration Information</title>
277
278 <para>
279 For <application>NetworkManager</application> to work, at least
280 a minimal configuration file must be present. Such file is not
281 installed with <command>make install</command>. Issue the following
282 command as the <systemitem class="username">root</systemitem> user to
283 create minimal <filename>NetworkManager.conf</filename> file:
284 </para>
285
286<screen role="root"><userinput>cat &gt;&gt; /etc/NetworkManager/NetworkManager.conf &lt;&lt; "EOF"
287<literal>[main]
288plugins=keyfile</literal>
289EOF</userinput></screen>
290
291 <para>
292 You can add <option>dns=none</option> to suppress changes to
293 <filename>/etc/resolv.conf</filename>. See
294 <command>man 5 NetworkManager.conf</command>
295 for any additional options.
296 </para>
297
298 <para>
299 To allow regular users permission to configure network connections,
300 you should add them to the
301 <systemitem class="groupname">netdev</systemitem>
302 group, and create a <application>polkit</application> rule that grants
303 access. Run the following commands as the
304 <systemitem class="username">root</systemitem> user:
305 </para>
306
307<screen role="root"><userinput>groupadd -fg 86 netdev &amp;&amp;
308/usr/sbin/usermod -a -G netdev <replaceable>&lt;username&gt;</replaceable>
309
310cat &gt; /usr/share/polkit-1/rules.d/org.freedesktop.NetworkManager.rules &lt;&lt; "EOF"
311<literal>polkit.addRule(function(action, subject) {
312 if (action.id.indexOf("org.freedesktop.NetworkManager.") == 0 &amp;&amp; subject.isInGroup("netdev")) {
313 return polkit.Result.YES;
314 }
315});</literal>
316EOF</userinput></screen>
317
318 </sect3>
319
320 <sect3 id="NetworkManager-init">
321 <title><phrase revision="sysv">Boot Script</phrase>
322 <phrase revision="systemd">Systemd Unit</phrase></title>
323
324 <para revision="sysv">
325 To automatically start the <command>NetworkManager</command> daemon
326 when the system is rebooted, install the
327 <filename>/etc/rc.d/init.d/networkmanager</filename>bootscript from the
328 <xref linkend="bootscripts"/> package.
329 </para>
330
331 <para revision="systemd">
332 To start the <command>NetworkManager</command> daemon at boot, enable
333 the previously installed systemd unit by running the following command
334 as the <systemitem class="username">root</systemitem> user:
335 </para>
336
337 <note>
338 <para>
339 If using <application>Network Manager</application> to manage
340 an interface, any previous configuration for that interface should be
341 removed, and the interface brought down prior to starting
342 <application>Network Manager</application>.
343 </para>
344 </note>
345
346 <indexterm zone="NetworkManager NetworkManager-init">
347 <primary sortas="f-NetworkManager">NetworkManager</primary>
348 </indexterm>
349
350<screen role="root" revision="sysv"><userinput>make install-networkmanager</userinput></screen>
351
352<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager</userinput></screen>
353
354 <para revision="systemd">
355 <application>NetworkManager</application> also ships a systemd unit
356 called <filename>NetworkManager-wait-online.service</filename> which
357 can be used to prevent services that require network connectivity
358 from starting until <application>NetworkManager</application> has
359 established the connection. To enable it, run the following command
360 as the <systemitem class="username">root</systemitem> user:
361 </para>
362
363<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager-wait-online</userinput></screen>
364
365 </sect3>
366
367 </sect2>
368
369 <sect2 role="content">
370 <title>Contents</title>
371
372 <segmentedlist>
373 <segtitle>Installed Programs</segtitle>
374 <segtitle>Installed Libraries</segtitle>
375 <segtitle>Installed Directories</segtitle>
376
377 <seglistitem>
378 <seg>
379 NetworkManager, nmcli, nm-online, nmtui, and, symlinked to nmtui:
380 nmtui-connect, nmtui-edit, and nmtui-hostname
381 </seg>
382 <seg>
383 libnm-glib.so, libnm-glib-vpn.so, libnm.so, libnm-util.so, and
384 modules under /usr/lib/NetworkManager
385 </seg>
386 <seg>
387 /etc/NetworkManager,
388 /usr/include/{libnm,libnm-glib,NetworkManager},
389 /usr/lib/NetworkManager,
390 /usr/share/doc/NetworkManager-&NetworkManager-version;,
391 /usr/share/gtk-doc/html/{libnm,libnm-glib,libnm-util,NetworkManager}
392 (if the documentation is built),
393 and
394 /var/{lib,run}/NetworkManager
395 </seg>
396 </seglistitem>
397 </segmentedlist>
398
399 <variablelist>
400 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
401 <?dbfo list-presentation="list"?>
402 <?dbhtml list-presentation="table"?>
403
404 <varlistentry id="nmcli">
405 <term><command>nmcli</command></term>
406 <listitem>
407 <para>
408 is a command-line tool for controlling
409 <application>NetworkManager</application>
410 and getting its status.
411 </para>
412 <indexterm zone="NetworkManager nmcli">
413 <primary sortas="b-nmcli">nmcli</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="nm-online">
419 <term><command>nm-online</command></term>
420 <listitem>
421 <para>
422 is a utility to find out whether you are online.
423 </para>
424 <indexterm zone="NetworkManager nm-online">
425 <primary sortas="b-nm-online">nm-online</primary>
426 </indexterm>
427 </listitem>
428 </varlistentry>
429
430 <varlistentry id="nmtui">
431 <term><command>nmtui</command></term>
432 <listitem>
433 <para>
434 is an interactive ncurses based interface for
435 <application>nmcli</application>.
436 </para>
437 <indexterm zone="NetworkManager nmtui">
438 <primary sortas="b-nmtui">nmtui</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="nmtui-connect">
444 <term><command>nmtui-connect</command></term>
445 <listitem>
446 <para>
447 is an interactive ncurses based interface connection to
448 activate/deactivate connections.
449 </para>
450 <indexterm zone="NetworkManager nmtui-connect">
451 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="nmtui-edit">
457 <term><command>nmtui-edit</command></term>
458 <listitem>
459 <para>
460 is an interactive ncurses based interface connection editor.
461 </para>
462 <indexterm zone="NetworkManager nmtui-edit">
463 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
464 </indexterm>
465 </listitem>
466 </varlistentry>
467
468 <varlistentry id="nmtui-hostname">
469 <term><command>nmtui-hostname</command></term>
470 <listitem>
471 <para>
472 is an interactive ncurses based interface hostname editor.
473 </para>
474 <indexterm zone="NetworkManager nmtui-hostname">
475 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
476 </indexterm>
477 </listitem>
478 </varlistentry>
479
480 <varlistentry id="NetworkManager-prog">
481 <term><command>NetworkManager</command></term>
482 <listitem>
483 <para>
484 is the network management daemon.
485 </para>
486 <indexterm zone="NetworkManager NetworkManager-prog">
487 <primary sortas="b-NetworkManager">NetworkManager</primary>
488 </indexterm>
489 </listitem>
490 </varlistentry>
491
492 <varlistentry id="libnm-glib">
493 <term><filename class="libraryfile">libnm-glib.so</filename></term>
494 <listitem>
495 <para>
496 contains functions used by <application>NetworkManager</application>.
497 </para>
498 <indexterm zone="NetworkManager libnm-glib">
499 <primary sortas="c-libnm-glib">libnm-glib.so</primary>
500 </indexterm>
501 </listitem>
502 </varlistentry>
503
504 <varlistentry id="libnm-glib-vpn">
505 <term><filename class="libraryfile">libnm-glib-vpn.so</filename></term>
506 <listitem>
507 <para>
508 contains functions used by <application>NetworkManager</application>
509 VPN plugins.
510 </para>
511 <indexterm zone="NetworkManager libnm-glib-vpn">
512 <primary sortas="c-libnm-glib-vpn">libnm-glib-vpn.so</primary>
513 </indexterm>
514 </listitem>
515 </varlistentry>
516
517 <varlistentry id="libnm-util">
518 <term><filename class="libraryfile">libnm-util.so</filename></term>
519 <listitem>
520 <para>
521 contains functions used by <application>NetworkManager</application>
522 utilities.
523 </para>
524 <indexterm zone="NetworkManager libnm-util">
525 <primary sortas="c-libnm-util">libnm-util.so</primary>
526 </indexterm>
527 </listitem>
528 </varlistentry>
529
530 </variablelist>
531
532 </sect2>
533
534</sect1>
Note: See TracBrowser for help on using the repository browser.