source: networking/netutils/networkmanager-systemd.xml@ 99673f0

systemd-13485
Last change on this file since 99673f0 was ae2aab61, checked in by Douglas R. Reno <renodr@…>, 9 years ago

Add some more short descriptions by Denis.
Update to cups-filters-1.0.74
Update to poppler-0.35.0
Update to cups-2.1.0
Update to colord-1.2.12
Update to libgusb-0.2.6
Update to udisks-2.1.6
Update to gnome-themes-standard-3.16.2
Update to gnome-backgrounds-3.16.0
Update to caribou-0.4.18.1
Update to iso-codes-3.61
Update to NetworkManager-1.0.6
Update to bluez-5.34
Update to telepathy-logger-0.8.1

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16382 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 14.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.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 "00f5f9ec09725a9f9b99366853c6f730">
12 <!ENTITY NetworkManager-size "3.2 MB">
13 <!ENTITY NetworkManager-buildsize "357 MB">
14 <!ENTITY NetworkManager-time "2.6 SBU">
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 &lfs77_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="dhcpcd"/> or
100 <xref linkend="dhcp"/> (client only),
101 <xref linkend="gobject-introspection"/>,
102 <xref linkend="iptables"/>,
103 <xref linkend="libsoup"/>,
104 <xref linkend="newt"/> (for <command>nmtui</command>),
105 <xref linkend="polkit"/>,
106 <xref linkend="systemd"/> and
107 <xref linkend="vala"/>
108 </para>
109
110 <bridgehead renderas="sect4">Optional</bridgehead>
111 <para role="optional">
112 <xref linkend="bluez"/> (runtime),
113 <xref linkend="gtk-doc"/>,
114 <xref linkend="ModemManager"/>,
115 <xref linkend="pygobject3"/>,
116 <xref linkend="qt4"/>,
117 <xref linkend="valgrind"/>,
118 <xref linkend="wpa_supplicant"/> (built with D-Bus support),
119 <ulink url="http://libteam.org/">libteam</ulink>,
120 <ulink url="https://www.samba.org/ftp/ppp/">PPP</ulink> and
121 <ulink url="https://www.roaringpenguin.com/products/pppoe">RP-PPPoE</ulink>
122 </para>
123
124 <para condition="html" role="usernotes">User Notes:
125 <ulink url="&blfs-wiki;/NetworkManager"/>
126 </para>
127 </sect2>
128
129 <sect2 role="installation">
130 <title>Installation of NetworkManager</title>
131
132<screen><userinput>./configure --prefix=/usr \
133 --sysconfdir=/etc \
134 --localstatedir=/var \
135 --disable-ppp \
136 --with-nmtui \
137 --with-session-tracking=systemd \
138 --with-systemdsystemunitdir=/lib/systemd/system \
139 --docdir=/usr/share/doc/NetworkManager-&NetworkManager-version; &amp;&amp;
140make</userinput></screen>
141
142 <para>
143 An already active graphical session with bus address is necessary to run
144 the tests. To test the results, issue: <command>make check</command>.
145 </para>
146
147 <para>
148 Now, as the <systemitem class="username">root</systemitem> user:
149 </para>
150
151<screen role="root"><userinput>make install</userinput></screen>
152
153 </sect2>
154
155 <sect2 role="commands">
156 <title>Command Explanations</title>
157
158 <para>
159 <parameter>--disable-ppp</parameter>: This switch disables
160 <application>PPP</application> support in
161 <application>NetworkManager</application> because
162 <application>PPP</application> isn't part of BLFS.
163 </para>
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>--with-session-tracking=systemd</parameter>: This switch
173 is used to set <command>systemd-logind</command> as the default
174 program for session tracking.
175 </para>
176
177 <para>
178 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>:
179 This switch is used to set the correct installation directory for
180 systemd units.
181 </para>
182
183 <para>
184 <option>--enable-gtk-doc</option>: Use this switch if you have installed
185 <xref linkend="gtk-doc"/> and wish to build the API manuals.
186 </para>
187
188 <para>
189 <option>--without-iptables</option>: Use this switch if you don't have
190 <application>Iptables</application> installed.
191 </para>
192
193 </sect2>
194
195 <sect2 role="configuration">
196 <title>Configuring NetworkManager</title>
197
198 <sect3 id="NetworkManager-config">
199 <title>Config Files</title>
200 <para>
201 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
202 </para>
203
204 <indexterm zone="NetworkManager NetworkManager-config">
205 <primary sortas="e-etc-NetworkManager-NetworkManager.conf">
206 /etc/NetworkManager/NetworkManager.conf</primary>
207 </indexterm>
208
209 </sect3>
210
211 <sect3><title>Configuration Information</title>
212
213 <para>
214 For <application>NetworkManager</application> to work, at least a
215 basic configuration file must be present. Such file is not
216 installed with <command>make install</command>. Run the following
217 command as the
218 <systemitem class="username">root</systemitem> user to create a
219 basic <filename>NetworkManager.conf</filename> file:
220 </para>
221
222<screen role="root"><userinput>cat &gt;&gt; /etc/NetworkManager/NetworkManager.conf &lt;&lt; "EOF"
223<literal>[main]
224plugins=keyfile</literal>
225EOF</userinput></screen>
226
227 <para>
228 You can add <option>dns=none</option> to suppress changes to
229 <filename>/etc/resolv.conf</filename>. See
230 <command>man 5 NetworkManager.conf</command>
231 for any additional options.
232 </para>
233
234 </sect3>
235
236 <sect3 id="NetworkManager-init">
237 <title>Systemd Units</title>
238
239 <para>
240 To start the <command>NetworkManager</command> daemon at boot, enable
241 the previously installed systemd unit by running the following command
242 as the <systemitem class="username">root</systemitem> user:
243 </para>
244
245 <indexterm zone="NetworkManager NetworkManager-init">
246 <primary sortas="f-NetworkManager">NetworkManager</primary>
247 </indexterm>
248
249<screen role="root"><userinput>systemctl enable NetworkManager</userinput></screen>
250
251 <para>
252 <application>NetworkManager</application> also ships a systemd unit
253 called <filename>NetworkManager-wait-online.service</filename> which
254 can be used to prevent services that require network connectivity
255 from starting until <application>NetworkManager</application> has
256 established the connection. To enable it, run the following command
257 as the <systemitem class="username">root</systemitem> user:
258 </para>
259
260<screen role="root"><userinput>systemctl enable NetworkManager-wait-online</userinput></screen>
261
262 </sect3>
263
264 </sect2>
265
266 <sect2 role="content">
267 <title>Contents</title>
268
269 <segmentedlist>
270 <segtitle>Installed Programs</segtitle>
271 <segtitle>Installed Libraries</segtitle>
272 <segtitle>Installed Directories</segtitle>
273
274 <seglistitem>
275 <seg>
276 NetworkManager, nmcli, nm-online, nmtui, nmtui-connect,
277 nmtui-edit, and nmtui-hostname
278 </seg>
279 <seg>
280 libnm.so, libnm-glib.so, libnm-glib-vpn.so, and libnm-util.so
281 </seg>
282 <seg>
283 /etc/NetworkManager,
284 /usr/include/{libnm,libnm-glib,NetworkManager},
285 /usr/lib/NetworkManager,
286 /usr/share/doc/NetworkManager-&NetworkManager-version;,
287 /usr/share/gtk-doc/html/{libnm,libnm-glib,libnm-util},
288 /usr/share/gtk-doc/html/NetworkManager,
289 /var/lib/NetworkManager, and
290 /var/run/NetworkManager
291 </seg>
292 </seglistitem>
293 </segmentedlist>
294
295 <variablelist>
296 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
297 <?dbfo list-presentation="list"?>
298 <?dbhtml list-presentation="table"?>
299
300 <varlistentry id="nmcli">
301 <term><command>nmcli</command></term>
302 <listitem>
303 <para>
304 is a command-line tool for controlling
305 <application>NetworkManager</application>
306 and getting its status.
307 </para>
308 <indexterm zone="NetworkManager nmcli">
309 <primary sortas="b-nmcli">nmcli</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="nm-online">
315 <term><command>nm-online</command></term>
316 <listitem>
317 <para>
318 is a utility to find out whether you are online.
319 </para>
320 <indexterm zone="NetworkManager nm-online">
321 <primary sortas="b-nm-online">nm-online</primary>
322 </indexterm>
323 </listitem>
324 </varlistentry>
325
326 <varlistentry id="nmtui">
327 <term><command>nmtui</command></term>
328 <listitem>
329 <para>
330 is an interactive ncurses based interface for
331 <application>nmcli</application>.
332 </para>
333 <indexterm zone="NetworkManager nmtui">
334 <primary sortas="b-nmtui">nmtui</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="nmtui-connect">
340 <term><command>nmtui-connect</command></term>
341 <listitem>
342 <para>
343 is an interactive ncurses based interface connection
344 activate/deactivate.
345 </para>
346 <indexterm zone="NetworkManager nmtui-connect">
347 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="nmtui-edit">
353 <term><command>nmtui-edit</command></term>
354 <listitem>
355 <para>
356 is an interactive ncurses based interface connection
357 editor.
358 </para>
359 <indexterm zone="NetworkManager nmtui-edit">
360 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
361 </indexterm>
362 </listitem>
363 </varlistentry>
364
365 <varlistentry id="nmtui-hostname">
366 <term><command>nmtui-hostname</command></term>
367 <listitem>
368 <para>
369 is an interactive ncurses based interface hostname
370 editor.
371 </para>
372 <indexterm zone="NetworkManager nmtui-hostname">
373 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="NetworkManager-prog">
379 <term><command>NetworkManager</command></term>
380 <listitem>
381 <para>
382 is the network management daemon.
383 </para>
384 <indexterm zone="NetworkManager NetworkManager-prog">
385 <primary sortas="b-NetworkManager">NetworkManager</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="libnm-glib">
391 <term><filename class="libraryfile">libnm-glib.so</filename></term>
392 <listitem>
393 <para>
394 contains functions used by <application>NetworkManager</application>.
395 </para>
396 <indexterm zone="NetworkManager libnm-glib">
397 <primary sortas="c-libnm-glib">libnm-glib.so</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="libnm-glib-vpn">
403 <term><filename class="libraryfile">libnm-glib-vpn.so</filename></term>
404 <listitem>
405 <para>
406 contains functions used by <application>NetworkManager</application>
407 VPN plugins.
408 </para>
409 <indexterm zone="NetworkManager libnm-glib-vpn">
410 <primary sortas="c-libnm-glib-vpn">libnm-glib-vpn.so</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="libnm-util">
416 <term><filename class="libraryfile">libnm-util.so</filename></term>
417 <listitem>
418 <para>
419 contains functions used by <application>NetworkManager</application>
420 utils.
421 </para>
422 <indexterm zone="NetworkManager libnm-util">
423 <primary sortas="c-libnm-util">libnm-util.so</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 </variablelist>
429
430 </sect2>
431
432</sect1>
Note: See TracBrowser for help on using the repository browser.