source: networking/netutils/networkmanager-systemd.xml@ 7de9746

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

Begin merging Christophers work into systemd branch part 4.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@13491 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 13.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/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="gtk-doc"/>,
105 <xref linkend="qt4"/>,
106 <xref linkend="valgrind"/>,
107 <xref linkend="wpa_supplicant"/> (built with D-Bus support),
108 <ulink url="http://libteam.org/">libteam</ulink>, and
109 <ulink url="http://www.freedesktop.org/software/ModemManager/">
110 ModemManager</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 <para>
122 If <xref linkend="qt4"/> and <xref linkend="qt5"/> are installed, you
123 need to choose <application>Qt4</application> with
124 <command>source setqt4</command>, before starting. Install
125 <application>NetworkManager</application> by running the following
126 commands:
127 </para>
128
129<screen><userinput>./configure --prefix=/usr \
130 --sysconfdir=/etc \
131 --localstatedir=/var \
132 --with-nmtui \
133 --disable-ppp \
134 --with-systemdsystemunitdir=no &amp;&amp;
135make</userinput></screen>
136
137 <para>
138 An already active graphical session with bus address is necessary to run
139 the tests. To test the results, issue: <command>make check</command>.
140 </para>
141
142 <para>
143 Now, as the <systemitem class="username">root</systemitem> user:
144 </para>
145
146<screen role="root"><userinput>make install</userinput></screen>
147
148 </sect2>
149
150 <sect2 role="commands">
151 <title>Command Explanations</title>
152
153 <para>
154 <parameter>--with-nmtui</parameter>: This parameter enables build of
155 <command>nmtui</command>.
156 </para>
157
158 <para>
159 <parameter>--with-systemdsystemunitdir=no</parameter>: This parameter is
160 used for sysv init systems. If you use systemd, replace "no" by the
161 proper directory.
162 </para>
163
164 <para>
165 <parameter>--disable-ppp</parameter>: This parameter disables parameteral
166 <application>PPP</application> support in
167 <application>NetworkManager</application>.
168 </para>
169
170 <para>
171 <option>--enable-gtk-doc</option>: Use this switch if you have installed
172 <xref linkend="gtk-doc"/> and wish to build the API manuals.
173 </para>
174
175 <para>
176 <option>--without-iptables</option>: Use this switch if you don't have
177 <application>Iptables</application> installed.
178 </para>
179
180 </sect2>
181
182 <sect2 role="configuration">
183 <title>Configuring NetworkManager</title>
184
185 <sect3 id="NetworkManager-config">
186 <title>Config Files</title>
187 <para>
188 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
189 </para>
190
191 <indexterm zone="NetworkManager NetworkManager-config">
192 <primary
193 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
203 minimal configuration file must be present. Such file is not
204 installed with <command>make install</command>. Issue following
205 command as the
206 <systemitem class="username">root</systemitem> user to create
207 minimal <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>Boot Script</title>
226
227 <para>
228 To automatically start the <command>NetworkManager</command> daemon when the
229 system is rebooted, install the
230 <filename>/etc/rc.d/init.d/networkmanager</filename> bootscript from the
231 <xref linkend="bootscripts"/> package.
232 </para>
233
234 <indexterm zone="NetworkManager NetworkManager-init">
235 <primary sortas="f-NetworkManager">NetworkManager</primary>
236 </indexterm>
237
238<screen role="root"><userinput>make install-networkmanager</userinput></screen>
239
240 </sect3>
241
242 </sect2>
243
244 <sect2 role="content">
245 <title>Contents</title>
246
247 <segmentedlist>
248 <segtitle>Installed Programs</segtitle>
249 <segtitle>Installed Libraries</segtitle>
250 <segtitle>Installed Directories</segtitle>
251
252 <seglistitem>
253 <seg>
254 NetworkManager, nm-avahi-autoipd.action, nm-dhcp-helper,
255 nm-dispatcher, nm-online, nmcli, and, hardlinked to each other:
256 nmtui, nmtui-connect, nmtui-edit, and nmtui-hostname
257 </seg>
258 <seg>
259 libnm-glib.so, libnm-glib-vpn.so, libnm-util.so, and
260 modules under /usr/lib/NetworkManager
261 </seg>
262 <seg>
263 /etc/NetworkManager,
264 /usr/include/libnm-glib,
265 /usr/include/NetworkManager,
266 /usr/lib/NetworkManager,
267 /usr/share/doc/NetworkManager,
268 /usr/share/gtk-doc/html/libnm-glib,
269 /usr/share/gtk-doc/html/libnm-util,
270 /usr/share/gtk-doc/html/NetworkManager,
271 /var/lib/NetworkManager, and
272 /var/run/NetworkManager
273 </seg>
274 </seglistitem>
275 </segmentedlist>
276
277 <variablelist>
278 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
279 <?dbfo list-presentation="list"?>
280 <?dbhtml list-presentation="table"?>
281
282 <varlistentry id="nmcli">
283 <term><command>nmcli</command></term>
284 <listitem>
285 <para>
286 is a command-line tool for controlling
287 <application>NetworkManager</application>
288 and getting its status.
289 </para>
290 <indexterm zone="NetworkManager nmcli">
291 <primary sortas="b-nmcli">nmcli</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="nm-online">
297 <term><command>nm-online</command></term>
298 <listitem>
299 <para>
300 is a utility to find out whether you are online.
301 </para>
302 <indexterm zone="NetworkManager nm-online">
303 <primary sortas="b-nm-online">nm-online</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="nmtui">
309 <term><command>nmtui</command></term>
310 <listitem>
311 <para>
312 interactive ncurses based interface for
313 <application>nmcli</application>.
314 </para>
315 <indexterm zone="NetworkManager nmtui">
316 <primary sortas="b-nmtui">nmtui</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="nmtui-connect">
322 <term><command>nmtui-connect</command></term>
323 <listitem>
324 <para>
325 interactive ncurses based interface connection activate/deactivate.
326 </para>
327 <indexterm zone="NetworkManager nmtui-connect">
328 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="nmtui-edit">
334 <term><command>nmtui-edit</command></term>
335 <listitem>
336 <para>
337 interactive ncurses based interface connection editor.
338 </para>
339 <indexterm zone="NetworkManager nmtui-edit">
340 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="nmtui-hostname">
346 <term><command>nmtui-hostname</command></term>
347 <listitem>
348 <para>
349 interactive ncurses based interface hostname editor.
350 </para>
351 <indexterm zone="NetworkManager nmtui-hostname">
352 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="NetworkManager-prog">
358 <term><command>NetworkManager</command></term>
359 <listitem>
360 <para>
361 is the network management daemon.
362 </para>
363 <indexterm zone="NetworkManager NetworkManager-prog">
364 <primary sortas="b-NetworkManager">NetworkManager</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="libnm-glib">
370 <term><filename class="libraryfile">libnm-glib.so</filename></term>
371 <listitem>
372 <para>
373 contains functions used by <application>NetworkManager</application>.
374 </para>
375 <indexterm zone="NetworkManager libnm-glib">
376 <primary sortas="c-libnm-glib">libnm-glib.so</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="libnm-glib-vpn">
382 <term><filename class="libraryfile">libnm-glib-vpn.so</filename></term>
383 <listitem>
384 <para>
385 contains functions used by <application>NetworkManager</application>
386 VPN plugins.
387 </para>
388 <indexterm zone="NetworkManager libnm-glib-vpn">
389 <primary sortas="c-libnm-glib-vpn">libnm-glib-vpn.so</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="libnm-util">
395 <term><filename class="libraryfile">libnm-util.so</filename></term>
396 <listitem>
397 <para>
398 contains functions used by <application>NetworkManager</application>
399 utils.
400 </para>
401 <indexterm zone="NetworkManager libnm-util">
402 <primary sortas="c-libnm-util">libnm-util.so</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 </variablelist>
408
409 </sect2>
410
411</sect1>
Note: See TracBrowser for help on using the repository browser.