source: networking/netutils/networkmanager.xml@ f77c63d0

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 nosym 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 f77c63d0 was f77c63d0, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Update to dhcp-4.3.5
Update to dhcpcd-6.11.5
Update to NetworkManager-1.4.2
Update to network-manager-applet-1.4.2
Update to vala-0.34.1
Update to wpa_supplicant-2.6

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

  • Property mode set to 100644
File size: 16.1 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 "59b5b5585467756787c6cb535cbd306e">
12 <!ENTITY NetworkManager-size "3.6 MB">
13 <!ENTITY NetworkManager-buildsize "597 MB (with tests)">
14 <!ENTITY NetworkManager-time "3.1 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 &lfs7a_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="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 <phrase revision="sysv"><xref linkend="consolekit"/>,</phrase>
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 <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="gtk-doc"/>,
117 <xref linkend="qt5"/> (for examples),
118 <xref linkend="ModemManager"/>,
119 <phrase revision="systemd"><xref linkend="pygobject3"/>,</phrase>
120 <xref linkend="valgrind"/>,
121 <ulink url="http://www.thekelleys.org.uk/dnsmasq/doc.html">dnsmasq</ulink>,
122 <ulink url="http://libteam.org/">libteam</ulink>,
123 <ulink url="https://www.samba.org/ftp/ppp/">PPP</ulink>, and
124 <ulink url="https://www.roaringpenguin.com/products/pppoe">RP-PPPoE</ulink>
125 </para>
126
127 <para condition="html" role="usernotes">User Notes:
128 <ulink url="&blfs-wiki;/NetworkManager"/>
129 </para>
130 </sect2>
131
132 <sect2 role="installation">
133 <title>Installation of NetworkManager</title>
134
135 <para>If <xref linkend="qt5"/> is installed and the Qt based
136 examples are desired, fix the configure script:</para>
137
138<screen><userinput>sed -e '/Qt[CDN]/s/Qt/Qt5/g' \
139 -e 's/moc_location/host_bins/' \
140 -i configure</userinput></screen>
141
142 <para>
143 Install <application>NetworkManager</application> by running the
144 following commands:
145 </para>
146
147<screen revision="sysv"><userinput>CXXFLAGS="-O2 -fPIC" \
148./configure --prefix=/usr \
149 --sysconfdir=/etc \
150 --localstatedir=/var \
151 --with-nmtui \
152 --disable-ppp \
153 --with-systemdsystemunitdir=no \
154 --docdir=/usr/share/doc/network-manager-&NetworkManager-version; &amp;&amp;
155make</userinput></screen>
156
157<screen revision="systemd"><userinput>CXXFLAGS="-O2 -fPIC" \
158./configure --prefix=/usr \
159 --sysconfdir=/etc \
160 --localstatedir=/var \
161 --with-nmtui \
162 --disable-ppp \
163 --with-session-tracking=systemd \
164 --with-systemdsystemunitdir=/lib/systemd/system \
165 --docdir=/usr/share/doc/network-manager-&NetworkManager-version; &amp;&amp;
166make</userinput></screen>
167
168 <para>
169 An already active graphical session with bus address is necessary to run
170 the tests. To test the results, issue: <command>make check</command>.
171 </para>
172
173 <para>
174 Now, as the <systemitem class="username">root</systemitem> user:
175 </para>
176
177<screen role="root"><userinput>make install</userinput></screen>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para>
185 <envar>CXXFLAGS="-O2 -fPIC"</envar>: These compiler options are
186 necessary to build the Qt5 based examples.
187 </para>
188
189 <para>
190 <parameter>--with-nmtui</parameter>: This parameter enables build of
191 <command>nmtui</command>.
192 </para>
193
194 <para revision="systemd">
195 <parameter>--with-session-tracking=systemd</parameter>: This switch
196 is used to set <command>systemd-logind</command> as the default
197 program for session tracking.
198 </para>
199
200 <para revision="sysv">
201 <parameter>--with-systemdsystemunitdir=no</parameter>: This parameter is
202 used for sysv init systems. If you use systemd, replace "no" by the
203 proper directory.
204 </para>
205
206 <para revision="systemd">
207 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
208 This switch is used to set the correct installation directory for
209 systemd units.
210 </para>
211
212 <para>
213 <parameter>--disable-ppp</parameter>: This parameter disables parameteral
214 <application>PPP</application> support in
215 <application>NetworkManager</application>.
216 </para>
217
218 <para>
219 <option>--enable-gtk-doc</option>: Use this switch if you have installed
220 <xref linkend="gtk-doc"/> and wish to build the API manuals.
221 </para>
222
223 <para>
224 <option>--without-iptables</option>: Use this switch if you don't have
225 <application>Iptables</application> installed.
226 </para>
227
228 </sect2>
229
230 <sect2 role="configuration">
231 <title>Configuring NetworkManager</title>
232
233 <sect3 id="NetworkManager-config">
234 <title>Config Files</title>
235 <para>
236 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
237 </para>
238
239 <indexterm zone="NetworkManager NetworkManager-config">
240 <primary
241 sortas="e-etc-NetworkManager-NetworkManager.conf">
242 /etc/NetworkManager/NetworkManager.conf</primary>
243 </indexterm>
244
245 </sect3>
246
247 <sect3><title>Configuration Information</title>
248
249 <para>
250 For <application>NetworkManager</application> to work, at least
251 minimal configuration file must be present. Such file is not
252 installed with <command>make install</command>. Issue following
253 command as the
254 <systemitem class="username">root</systemitem> user to create
255 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 </sect3>
271
272 <sect3 id="NetworkManager-init">
273 <title><phrase revision="sysv">Boot Script</phrase>
274 <phrase revision="systemd">Systemd Unit</phrase></title>
275
276 <para revision="sysv">
277 To automatically start the <command>NetworkManager</command> daemon
278 when the system is rebooted, install the
279 <filename>/etc/rc.d/init.d/networkmanager</filename>bootscript from the
280 <xref linkend="bootscripts"/> package.
281 </para>
282
283 <para revision="systemd">
284 To start the <command>NetworkManager</command> daemon at boot, enable
285 the previously installed systemd unit by running the following command
286 as the <systemitem class="username">root</systemitem> user:
287 </para>
288
289 <indexterm zone="NetworkManager NetworkManager-init">
290 <primary sortas="f-NetworkManager">NetworkManager</primary>
291 </indexterm>
292
293<screen role="root" revision="sysv"><userinput>make install-networkmanager</userinput></screen>
294
295<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager</userinput></screen>
296
297 <para revision="systemd">
298 <application>NetworkManager</application> also ships a systemd unit
299 called <filename>NetworkManager-wait-online.service</filename> which
300 can be used to prevent services that require network connectivity
301 from starting until <application>NetworkManager</application> has
302 established the connection. To enable it, run the following command
303 as the <systemitem class="username">root</systemitem> user:
304 </para>
305
306<screen role="root" revision="systemd"><userinput>systemctl enable NetworkManager-wait-online</userinput></screen>
307
308 </sect3>
309
310 </sect2>
311
312 <sect2 role="content">
313 <title>Contents</title>
314
315 <segmentedlist>
316 <segtitle>Installed Programs</segtitle>
317 <segtitle>Installed Libraries</segtitle>
318 <segtitle>Installed Directories</segtitle>
319
320 <seglistitem>
321 <seg>
322 NetworkManager, nmcli, nm-online, and, hardlinked to each other:
323 nmtui, nmtui-connect, nmtui-edit, and nmtui-hostname
324 </seg>
325 <seg>
326 libnm-glib.so, libnm-glib-vpn.so, libnm.so, libnm-util.so, and
327 modules under /usr/lib/NetworkManager
328 </seg>
329 <seg>
330 /etc/NetworkManager,
331 /usr/include/{libnm,libnm-glib,NetworkManager},
332 /usr/lib/NetworkManager,
333 /usr/share/doc/NetworkManager-&NetworkManager-version;,
334 /usr/share/gtk-doc/html/{libnm,libnm-glib,libnm-util,NetworkManager},
335 and
336 /var/{lib,run}/NetworkManager
337 </seg>
338 </seglistitem>
339 </segmentedlist>
340
341 <variablelist>
342 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
343 <?dbfo list-presentation="list"?>
344 <?dbhtml list-presentation="table"?>
345
346 <varlistentry id="nmcli">
347 <term><command>nmcli</command></term>
348 <listitem>
349 <para>
350 is a command-line tool for controlling
351 <application>NetworkManager</application>
352 and getting its status.
353 </para>
354 <indexterm zone="NetworkManager nmcli">
355 <primary sortas="b-nmcli">nmcli</primary>
356 </indexterm>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry id="nm-online">
361 <term><command>nm-online</command></term>
362 <listitem>
363 <para>
364 is a utility to find out whether you are online.
365 </para>
366 <indexterm zone="NetworkManager nm-online">
367 <primary sortas="b-nm-online">nm-online</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="nmtui">
373 <term><command>nmtui</command></term>
374 <listitem>
375 <para>
376 is an interactive ncurses based interface for
377 <application>nmcli</application>.
378 </para>
379 <indexterm zone="NetworkManager nmtui">
380 <primary sortas="b-nmtui">nmtui</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="nmtui-connect">
386 <term><command>nmtui-connect</command></term>
387 <listitem>
388 <para>
389 is an interactive ncurses based interface connection to
390 activate/deactivate connections.
391 </para>
392 <indexterm zone="NetworkManager nmtui-connect">
393 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="nmtui-edit">
399 <term><command>nmtui-edit</command></term>
400 <listitem>
401 <para>
402 is an interactive ncurses based interface connection editor.
403 </para>
404 <indexterm zone="NetworkManager nmtui-edit">
405 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="nmtui-hostname">
411 <term><command>nmtui-hostname</command></term>
412 <listitem>
413 <para>
414 is an interactive ncurses based interface hostname editor.
415 </para>
416 <indexterm zone="NetworkManager nmtui-hostname">
417 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="NetworkManager-prog">
423 <term><command>NetworkManager</command></term>
424 <listitem>
425 <para>
426 is the network management daemon.
427 </para>
428 <indexterm zone="NetworkManager NetworkManager-prog">
429 <primary sortas="b-NetworkManager">NetworkManager</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="libnm-glib">
435 <term><filename class="libraryfile">libnm-glib.so</filename></term>
436 <listitem>
437 <para>
438 contains functions used by <application>NetworkManager</application>.
439 </para>
440 <indexterm zone="NetworkManager libnm-glib">
441 <primary sortas="c-libnm-glib">libnm-glib.so</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="libnm-glib-vpn">
447 <term><filename class="libraryfile">libnm-glib-vpn.so</filename></term>
448 <listitem>
449 <para>
450 contains functions used by <application>NetworkManager</application>
451 VPN plugins.
452 </para>
453 <indexterm zone="NetworkManager libnm-glib-vpn">
454 <primary sortas="c-libnm-glib-vpn">libnm-glib-vpn.so</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="libnm-util">
460 <term><filename class="libraryfile">libnm-util.so</filename></term>
461 <listitem>
462 <para>
463 contains functions used by <application>NetworkManager</application>
464 utils.
465 </para>
466 <indexterm zone="NetworkManager libnm-util">
467 <primary sortas="c-libnm-util">libnm-util.so</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 </variablelist>
473
474 </sect2>
475
476</sect1>
Note: See TracBrowser for help on using the repository browser.