source: networking/netutils/networkmanager-systemd.xml@ 10a6c8d

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

Merge some more of Christopher's work into systemd branch.

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