source: networking/netutils/networkmanager.xml@ e6e16c1

11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt 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 e6e16c1 was e6e16c1, checked in by Douglas R. Reno <renodr@…>, 3 years ago

Update to NetworkManager-1.30.4 and remove some stuff because of
merged-/usr
  • Property mode set to 100644
File size: 22.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/&NetworkManager-minor;/NetworkManager-&NetworkManager-version;.tar.xz">
9 <!ENTITY NetworkManager-download-ftp
10"&gnome-download-ftp;/NetworkManager/&NetworkManager-minor;/NetworkManager-&NetworkManager-version;.tar.xz">
11 <!ENTITY NetworkManager-md5sum "8ce53a38356864832f7f10ad46fcde27">
12 <!ENTITY NetworkManager-size "5.1 MB">
13 <!ENTITY NetworkManager-buildsize "739 MB (with tests)">
14 <!ENTITY NetworkManager-time "0.9 SBU (with tests, using parallelism=4)">
15]>
16
17<sect1 id="NetworkManager" xreflabel="NetworkManager-&NetworkManager-version;">
18 <?dbhtml filename="networkmanager.html"?>
19
20 <sect1info>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>NetworkManager-&NetworkManager-version;</title>
25
26 <indexterm zone="NetworkManager">
27 <primary sortas="a-NetworkManager">NetworkManager</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to NetworkManager</title>
32
33 <para>
34 <application>NetworkManager</application> is a set of co-operative
35 tools that make networking simple and straightforward. Whether you use WiFi,
36 wired, 3G, or Bluetooth, NetworkManager allows you to quickly move from
37 one network to another: Once a network has been configured and joined
38 once, it can be detected and re-joined automatically the next time it's
39 available.
40 </para>
41
42 &lfs101_checked;
43
44 <note revision="systemd">
45 <para>
46 Make sure that you disable the <command>systemd-networkd</command>
47 service or configure it not to manage the interfaces you want to manage
48 with <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="jansson"/> and
91 <xref linkend="libndp"/>
92 </para>
93
94 <bridgehead renderas="sect4">Recommended</bridgehead>
95 <para role="recommended">
96 <xref linkend="curl"/>,
97 <!--<xref linkend="dhcpcd"/> or
98 DHCPCD support is known to be broken with dhcpcd-9 -->
99 <xref role="nodep" linkend="dhcp"/> (client only),
100 <xref linkend="gobject-introspection"/>,
101 <xref linkend="iptables"/>,
102 <xref linkend="newt"/> (for <command>nmtui</command>),
103 <xref linkend="nss"/>,
104 <xref linkend="polkit"/>,
105 <xref linkend="pygobject3"/>,
106 <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
107 <phrase revision="systemd"><xref linkend="systemd"/>,</phrase>
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"/>,
116 <xref linkend="dbus-python"/> (for the test suite),
117 <!-- <xref linkend="firewalld"/> (For whenever firewalld is reintroduced) -->
118 <xref linkend="gnutls"/> (used if <xref linkend="nss"/> is not found),
119 <xref linkend="gtk-doc"/>,
120 <xref linkend="libpsl"/>,
121 <xref linkend="qt5"/> (for examples),
122 <xref linkend="ModemManager"/>,
123 <xref linkend="valgrind"/>,
124 <ulink url="http://www.thekelleys.org.uk/dnsmasq/doc.html">dnsmasq</ulink>,
125 <ulink url="https://firewalld.org/">firewalld</ulink>,
126 <ulink url="https://github.com/Distrotech/libaudit">libaudit</ulink>,
127 <ulink url="https://github.com/jpirko/libteam">libteam</ulink>,
128 <ulink url="&gnome-download-http;/mobile-broadband-provider-info/">mobile-broadband-provider-info</ulink>,
129 <ulink url="https://www.samba.org/ftp/ppp/">PPP</ulink>, and
130 <ulink url="https://dianne.skoll.ca/projects/rp-pppoe/">RP-PPPoE</ulink>
131 </para>
132
133 <para condition="html" role="usernotes">User Notes:
134 <ulink url="&blfs-wiki;/NetworkManager"/>
135 </para>
136 </sect2>
137
138 <sect2 role="kernel" id="NetworkManager-kernel">
139 <title>Kernel Configuration</title>
140
141 <para>
142 If you wish to run the tests, enable the following options in the
143 kernel configuration and recompile the kernel if necessary:
144 </para>
145
146 <!-- Ethernet Teaming support is potentially optional, but I didn't
147 run the tests again to test that. It was needed to convince one of
148 the Linux Platform tests to move farther along because otherwise
149 RTNETLINK would respond with an Error 95 - unknown device type.
150 This would cause the test to fail early on in the process. -->
151
152<screen><literal>Device Drivers ---&gt;
153 [*] Network device support [CONFIG_NETDEVICES] ---&gt;
154 [*] Bonding driver support [CONFIG_BONDING]
155 [*] Dummy net driver support [CONFIG_DUMMY]
156 [*] Ethernet team driver support [CONFIG_NET_TEAM]</literal></screen>
157
158 <indexterm zone="NetworkManager NetworkManager-kernel">
159 <primary sortas="d-NetworkManager">NetworkManager</primary>
160 </indexterm>
161 </sect2>
162
163 <sect2 role="installation">
164 <title>Installation of NetworkManager</title>
165
166 <para>
167 If <xref linkend="qt5"/> is installed and the Qt based
168 examples are desired, fix two meson.build files:
169 </para>
170
171<screen><userinput>sed -e 's/-qt4/-qt5/' \
172 -e 's/moc_location/host_bins/' \
173 -i examples/C/qt/meson.build &amp;&amp;
174
175sed -e 's/Qt/&amp;5/' \
176 -i meson.build</userinput></screen>
177
178 <para>
179 Fix a missing meson.build file for initrd hooks (not used in BLFS):
180 </para>
181
182<screen><userinput>sed '/initrd/d' -i src/core/meson.build</userinput></screen>
183
184 <para>
185 Fix the python scripts so that they use <application>Python
186 3</application>:
187 </para>
188
189<screen><userinput>grep -rl '^#!.*python$' | xargs sed -i '1s/python/&amp;3/'</userinput></screen>
190
191 <para>
192 Install <application>NetworkManager</application> by running the
193 following commands:
194 </para>
195
196<screen revision="sysv"><userinput>mkdir build &amp;&amp;
197cd build &amp;&amp;
198
199CXXFLAGS+="-O2 -fPIC" \
200meson --prefix /usr \
201 -Dlibaudit=no \
202 -Dlibpsl=false \
203 -Dnmtui=true \
204 -Dovs=false \
205 -Dppp=false \
206 -Dselinux=false \
207 -Dsession_tracking=elogind \
208 -Dmodem_manager=false \
209 -Dsystemdsystemunitdir=no \
210 -Dsystemd_journal=false \
211 -Dqt=false \
212 .. &amp;&amp;
213ninja</userinput></screen>
214
215<screen revision="systemd"><userinput>mkdir build &amp;&amp;
216cd build &amp;&amp;
217
218CXXFLAGS+="-O2 -fPIC" \
219meson --prefix /usr \
220 -Dlibaudit=no \
221 -Dlibpsl=false \
222 -Dnmtui=true \
223 -Dovs=false \
224 -Dppp=false \
225 -Dselinux=false \
226 -Dqt=false \
227 -Dsession_tracking=systemd \
228 -Dmodem_manager=false \
229 .. &amp;&amp;
230ninja</userinput></screen>
231
232 <para>
233 An already active graphical session
234 with a bus address is necessary to run the tests. To test the results,
235 as the root user, <!-- needs the "ip" command -->
236 issue: <command>ninja test</command>. Five tests,
237 <filename>test-l3cfg</filename>,
238 <filename>devices/test-acd</filename>,
239 <filename>platform/test-tc-linux</filename>,
240 <filename>platform/test-route-linux</filename>, and
241 <filename>platform/test-link-linux</filename>,
242 <!--<filename>platform/test-cleanup-linux</filename>,--> are known to fail.
243 </para>
244
245 <para>
246 Now, as the <systemitem class="username">root</systemitem> user:
247 </para>
248
249<screen role="root"><userinput>ninja install &amp;&amp;
250mv -v /usr/share/doc/NetworkManager{,-&NetworkManager-version;}</userinput></screen>
251
252 </sect2>
253
254 <sect2 role="commands">
255 <title>Command Explanations</title>
256
257 <para>
258 <envar>CXXFLAGS="-O2 -fPIC"</envar>: These compiler options are
259 necessary to build the Qt5 based examples.
260 </para>
261
262 <para>
263 <option>-Ddocs=true</option>: Use this switch to enable building
264 man pages and documentation if <xref linkend="gtk-doc"/> is installed.
265 </para>
266
267 <para>
268 <parameter>-Dnmtui=true</parameter>: This parameter enables building
269 <command>nmtui</command>.
270 </para>
271
272 <para revision="sysv">
273 <parameter>-Dsystemdsystemunitdir=no</parameter> and
274 <parameter>-Dsystemd_journal=false</parameter>: systemd is not
275 used for sysv init systems.
276 </para>
277
278 <para>
279 <!--<parameter>-Djson_validation=false</parameter>, no longer recognized -->
280 <parameter>-Dlibpsl=false</parameter> and
281 <parameter>-Dovs=false</parameter>: These switches disable building with the
282 respective libraries. Remove if you have the needed libraries installed.
283 </para>
284
285<!--
286 <para>
287 <parameter>-Dlibpsl=false</parameter>: This switch is required if
288 <application>libpsl</application> is not installed. Omit this switch if
289 you have built <application>libpsl</application>.
290 </para>
291-->
292
293 <para>
294 <parameter>-Dmodem_manager=false</parameter>: This switch is requried if
295 <application>ModemManager</application> is not installed. Omit if you
296 have built <application>ModemManager</application> and
297 <application>mobile-broadband-provider-info</application>.
298 </para>
299
300 <para revision="sysv">
301 <parameter>-Dsession_tracking=elogind</parameter>: This switch
302 is used to set <command>elogind</command> as the default
303 program for session tracking.
304 </para>
305
306 <para revision="systemd">
307 <parameter>-Dsession_tracking=systemd</parameter>: This switch
308 is used to set <command>systemd-logind</command> as the default
309 program for session tracking.
310 </para>
311
312 <para revision="systemd">
313 <parameter>-Dsystemdsystemunitdir=/lib/systemd/system</parameter>:
314 This switch is used to set the correct installation directory for
315 systemd units.
316 </para>
317
318 <para>
319 <parameter>-Dppp=false</parameter>: This parameter disables
320 <application>PPP</application> support in
321 <application>NetworkManager</application>.
322 </para>
323
324 <para>
325 <parameter>-Dlibaudit=no</parameter> and
326 <parameter>-Dselinux=false</parameter>: libaudit and SELinux are not used
327 in BLFS.
328 </para>
329
330 <para>
331 <parameter>-Dqt=false</parameter>: disables the
332 <application>QT</application> examples. Omit if you have
333 <application>QT</application> available and wish to install the examples.
334 </para>
335
336 </sect2>
337
338 <sect2 role="configuration">
339 <title>Configuring NetworkManager</title>
340
341 <sect3 id="NetworkManager-config">
342 <title>Config Files</title>
343 <para>
344 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
345 </para>
346
347 <indexterm zone="NetworkManager NetworkManager-config">
348 <primary
349 sortas="e-etc-NetworkManager-NetworkManager.conf">
350 /etc/NetworkManager/NetworkManager.conf</primary>
351 </indexterm>
352
353 </sect3>
354
355 <sect3><title>Configuration Information</title>
356
357 <para>
358 For <application>NetworkManager</application> to work, at least
359 a minimal configuration file must be present. Such a file is not
360 installed with <command>make install</command>. Issue the following
361 command as the <systemitem class="username">root</systemitem> user to
362 create a minimal <filename>NetworkManager.conf</filename> file:
363 </para>
364
365<screen role="root"><userinput>cat &gt;&gt; /etc/NetworkManager/NetworkManager.conf &lt;&lt; "EOF"
366<literal>[main]
367plugins=keyfile</literal>
368EOF</userinput></screen>
369
370 <para>
371 This file should not be modified directly by users of the system.
372 Instead, system specific changes should be made using configuration
373 files in the
374 <filename class="directory">/etc/NetworkManager/conf.d</filename>
375 directory.
376 </para>
377
378 <para>
379 To allow polkit to manage authorizations, add the following
380 configuration file:
381 </para>
382
383<screen role="root"><userinput>cat &gt; /etc/NetworkManager/conf.d/polkit.conf &lt;&lt; "EOF"
384<literal>[main]
385auth-polkit=true</literal>
386EOF</userinput></screen>
387
388 <para>
389 To use something other than the built-in dhcp client (recommended if
390 using only <command>nmcli</command>), use the following configuration
391 (valid values include either dhclient <!--dhcpcd --> or internal):
392 </para>
393
394<screen role="nodump"><userinput>cat &gt; /etc/NetworkManager/conf.d/dhcp.conf &lt;&lt; "EOF"
395<literal>[main]
396dhcp=</literal><replaceable>dhclient</replaceable>
397EOF</userinput></screen>
398
399 <para>
400 To prevent <application>NetworkManager</application> from updating the
401 <filename>/etc/resolv.conf</filename> file, add the following
402 configuration file:
403 </para>
404
405<screen role="nodump"><userinput>cat &gt; /etc/NetworkManager/conf.d/no-dns-update.conf &lt;&lt; "EOF"
406<literal>[main]
407dns=none</literal>
408EOF</userinput></screen>
409
410 <para>
411 For additional configuation options, see
412 <command>man 5 NetworkManager.conf</command>.
413 </para>
414
415 <para>
416 To allow regular users to configure network connections,
417 you should add them to the
418 <systemitem class="groupname">netdev</systemitem>
419 group, and create a <application>polkit</application> rule that grants
420 access. Run the following commands as the
421 <systemitem class="username">root</systemitem> user:
422 </para>
423
424<screen role="root"><userinput>groupadd -fg 86 netdev &amp;&amp;
425/usr/sbin/usermod -a -G netdev <replaceable>&lt;username&gt;</replaceable>
426
427cat &gt; /usr/share/polkit-1/rules.d/org.freedesktop.NetworkManager.rules &lt;&lt; "EOF"
428<literal>polkit.addRule(function(action, subject) {
429 if (action.id.indexOf("org.freedesktop.NetworkManager.") == 0 &amp;&amp; subject.isInGroup("netdev")) {
430 return polkit.Result.YES;
431 }
432});</literal>
433EOF</userinput></screen>
434
435 </sect3>
436
437 <sect3 id="NetworkManager-init">
438 <title><phrase revision="sysv">Boot Script</phrase>
439 <phrase revision="systemd">Systemd Unit</phrase></title>
440
441 <para revision="sysv">
442 To automatically start the <command>NetworkManager</command> daemon
443 when the system is rebooted, install the
444 <filename>/etc/rc.d/init.d/networkmanager</filename>bootscript from the
445 <xref linkend="bootscripts"/> package.
446 </para>
447
448 <para revision="systemd">
449 To start the <command>NetworkManager</command> daemon at boot, enable
450 the previously installed systemd unit by running the following command
451 as the <systemitem class="username">root</systemitem> user:
452 </para>
453
454 <note>
455 <para>
456 If using <application>Network Manager</application> to manage
457 an interface, any previous configuration for that interface should be
458 removed, and the interface brought down prior to starting
459 <application>Network Manager</application>.
460 </para>
461 </note>
462
463 <indexterm zone="NetworkManager NetworkManager-init">
464 <primary sortas="f-NetworkManager">NetworkManager</primary>
465 </indexterm>
466
467<screen role="root" revision="sysv"><userinput>make install-networkmanager</userinput></screen>
468
469<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager</userinput></screen>
470<!-- The below instruction is obsolete. NetworkManager-wait-online is now
471 enabled by default when enabling NetworkManager. -->
472<!--
473 <para revision="systemd">
474 <application>NetworkManager</application> also ships a systemd unit
475 called <filename>NetworkManager-wait-online.service</filename> which
476 can be used to prevent services that require network connectivity
477 from starting until <application>NetworkManager</application> has
478 established the connection. To enable it, run the following command
479 as the <systemitem class="username">root</systemitem> user:
480 </para>
481
482<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager-wait-online</userinput></screen>
483 -->
484 <!-- As such, let's now provide instructions on how to disable that
485 behavior, for those who wish to do so. -->
486 <para revision="systemd">
487 Starting in version 1.11.2 of <application>NetworkManager</application>,
488 a systemd unit named <filename>NetworkManager-wait-online.service</filename>
489 is enabled, which is used to prevent services that require network
490 connectivity from starting until <application>NetworkManager</application>
491 establishes a connection. To disable this behavior, run the following
492 command as the <systemitem class="username">root</systemitem> user:
493 </para>
494
495<screen role="root" revision="systemd"><userinput>systemctl disable NetworkManager-wait-online</userinput></screen>
496
497 </sect3>
498
499 </sect2>
500
501 <sect2 role="content">
502 <title>Contents</title>
503
504 <segmentedlist>
505 <segtitle>Installed Programs</segtitle>
506 <segtitle>Installed Libraries</segtitle>
507 <segtitle>Installed Directories</segtitle>
508
509 <seglistitem>
510 <seg>
511 NetworkManager, nmcli, nm-online, nmtui, and, symlinked to nmtui:
512 nmtui-connect, nmtui-edit, and nmtui-hostname
513 </seg>
514 <seg>
515 libnm.so
516 and several modules under /usr/lib/NetworkManager
517 </seg>
518 <seg>
519 /etc/NetworkManager,
520 /usr/include/libnm,
521 /usr/lib/NetworkManager,
522 /usr/share/doc/NetworkManager-&NetworkManager-version;,
523 /usr/share/gtk-doc/html/{libnm,NetworkManager}
524 (if the documentation is built),
525 and
526 /var/lib/NetworkManager
527 </seg>
528 <!-- A lot of libraries were removed here. We should verify compatibilty.
529 RESTORED AT 1.18.2 -renodr -->
530 </seglistitem>
531 </segmentedlist>
532
533 <variablelist>
534 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
535 <?dbfo list-presentation="list"?>
536 <?dbhtml list-presentation="table"?>
537
538 <varlistentry id="nmcli">
539 <term><command>nmcli</command></term>
540 <listitem>
541 <para>
542 is a command-line tool for controlling
543 <application>NetworkManager</application>
544 and getting its status
545 </para>
546 <indexterm zone="NetworkManager nmcli">
547 <primary sortas="b-nmcli">nmcli</primary>
548 </indexterm>
549 </listitem>
550 </varlistentry>
551
552 <varlistentry id="nm-online">
553 <term><command>nm-online</command></term>
554 <listitem>
555 <para>
556 is an utility to determine whether you are online
557 </para>
558 <indexterm zone="NetworkManager nm-online">
559 <primary sortas="b-nm-online">nm-online</primary>
560 </indexterm>
561 </listitem>
562 </varlistentry>
563
564 <varlistentry id="nmtui">
565 <term><command>nmtui</command></term>
566 <listitem>
567 <para>
568 is an interactive ncurses-based user interface for
569 <application>nmcli</application>
570 </para>
571 <indexterm zone="NetworkManager nmtui">
572 <primary sortas="b-nmtui">nmtui</primary>
573 </indexterm>
574 </listitem>
575 </varlistentry>
576
577 <varlistentry id="nmtui-connect">
578 <term><command>nmtui-connect</command></term>
579 <listitem>
580 <para>
581 is an interactive ncurses-based user interface to
582 activate/deactivate connections
583 </para>
584 <indexterm zone="NetworkManager nmtui-connect">
585 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
586 </indexterm>
587 </listitem>
588 </varlistentry>
589
590 <varlistentry id="nmtui-edit">
591 <term><command>nmtui-edit</command></term>
592 <listitem>
593 <para>
594 is an interactive ncurses-based user interface to edit connections
595 </para>
596 <indexterm zone="NetworkManager nmtui-edit">
597 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
598 </indexterm>
599 </listitem>
600 </varlistentry>
601
602 <varlistentry id="nmtui-hostname">
603 <term><command>nmtui-hostname</command></term>
604 <listitem>
605 <para>
606 is an interactive ncurses-based user interface to edit the hostname
607 </para>
608 <indexterm zone="NetworkManager nmtui-hostname">
609 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
610 </indexterm>
611 </listitem>
612 </varlistentry>
613
614 <varlistentry id="NetworkManager-prog">
615 <term><command>NetworkManager</command></term>
616 <listitem>
617 <para>
618 is the network management daemon
619 </para>
620 <indexterm zone="NetworkManager NetworkManager-prog">
621 <primary sortas="b-NetworkManager">NetworkManager</primary>
622 </indexterm>
623 </listitem>
624 </varlistentry>
625
626 <varlistentry id="libnm">
627 <term><filename class="libraryfile">libnm.so</filename></term>
628 <listitem>
629 <para>
630 contains functions used by <application>NetworkManager</application>
631 </para>
632 <indexterm zone="NetworkManager libnm">
633 <primary sortas="c-libnm">libnm.so</primary>
634 </indexterm>
635 </listitem>
636 </varlistentry>
637 </variablelist>
638
639 </sect2>
640
641</sect1>
Note: See TracBrowser for help on using the repository browser.