source: networking/netutils/networkmanager-systemd.xml@ 7744d8a

systemd-11177
Last change on this file since 7744d8a was 7744d8a, checked in by Krejzi <krejzi@…>, 10 years ago

Link to ModemManager in the book instead of using external link.

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