source: networking/netutils/networkmanager.xml@ ab31930

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since ab31930 was ab31930, checked in by Bruce Dubbs <bdubbs@…>, 7 years ago

Update to NetworkManager-1.4.4.
Update to ModemManager-1.6.4.
Update to mariadb-10.1.20.

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