source: networking/netutils/networkmanager.xml@ f00d48bb

gnome
Last change on this file since f00d48bb was 5bc57bb, checked in by Christopher Gregory <cjg@…>, 10 years ago

Converted ntp rpcbind rsync samba wpa_supplicant avahi networkmanager and wicd pages to systemd

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/gnome@13414 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)
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"/>,
99 <xref linkend="upower"/>, and
100 <xref linkend="vala"/>
101 </para>
102
103 <bridgehead renderas="sect4">Optional</bridgehead>
104 <para role="optional">
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 <para>
123 If <xref linkend="qt4"/> and <xref linkend="qt5"/> are installed, you
124 need to choose <application>Qt4</application> with
125 <command>source setqt4</command>, before starting. Install
126 <application>NetworkManager</application> by running the following
127 commands:
128 </para>
129
130<screen><userinput>./configure --prefix=/usr \
131 --sysconfdir=/etc \
132 --localstatedir=/var \
133 --with-nmtui \
134 --disable-ppp \
135 --with-session-tracking=systemd \
136 --with-systemdsystemunitdir=/lib/systemd/system &amp;&amp;
137make</userinput></screen>
138
139 <para>
140 An already active graphical session with bus address is necessary to run
141 the tests. To test the results, issue: <command>make check</command>.
142 </para>
143
144 <para>
145 Now, as the <systemitem class="username">root</systemitem> user:
146 </para>
147
148<screen role="root"><userinput>make install</userinput></screen>
149
150 </sect2>
151
152 <sect2 role="commands">
153 <title>Command Explanations</title>
154
155 <para>
156 <parameter>--with-nmtui</parameter>: This parameter enables build of
157 <command>nmtui</command>.
158 </para>
159
160 <para>
161 <parameter>--with-systemdsystemunitdir=/lib/systemd/system</parameter>: This parameter is
162 used to specifiy the correct location for the systemd unit files.
163 </para>
164
165 <para>
166 <parameter>--with-session-tracking=systemd</parameter>: This parameter
167 enables the use of systemd-logind for session tracking.
168 </para>
169
170 <para>
171 <parameter>--disable-ppp</parameter>: This parameter disables parameteral
172 <application>PPP</application> support in
173 <application>NetworkManager</application>.
174 </para>
175
176 <para>
177 <option>--enable-gtk-doc</option>: Use this switch if you have installed
178 <xref linkend="gtk-doc"/> and wish to build the API manuals.
179 </para>
180
181 <para>
182 <option>--without-iptables</option>: Use this switch if you don't have
183 <application>Iptables</application> installed.
184 </para>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring NetworkManager</title>
190
191 <sect3 id="NetworkManager-config">
192 <title>Config Files</title>
193 <para>
194 <filename>/etc/NetworkManager/NetworkManager.conf</filename>
195 </para>
196
197 <indexterm zone="NetworkManager NetworkManager-config">
198 <primary
199 sortas="e-etc-NetworkManager-NetworkManager.conf">
200 /etc/NetworkManager/NetworkManager.conf</primary>
201 </indexterm>
202
203 </sect3>
204
205 <sect3><title>Configuration Information</title>
206
207 <para>
208 For <application>NetworkManager</application> to work, at least
209 minimal configuration file must be present. Such file is not
210 installed with <command>make install</command>. Issue following
211 command as the
212 <systemitem class="username">root</systemitem> user to create
213 minimal <filename>NetworkManager.conf</filename> file:
214 </para>
215
216<screen role="root"><userinput>cat &gt;&gt; /etc/NetworkManager/NetworkManager.conf &lt;&lt; "EOF"
217<literal>[main]
218plugins=keyfile</literal>
219EOF</userinput></screen>
220
221 <para>
222 You can add <option>dns=none</option> to suppress changes to
223 <filename>/etc/resolv.conf</filename>. See
224 <command>man 5 NetworkManager.conf</command>
225 for any additional options.
226 </para>
227
228 </sect3>
229
230 <sect3 id="NetworkManager-init-systemd">
231 <title>Systemd Unit File</title>
232
233 <para>
234 This package will automatically install systemd units if systemd is detected.
235 To enable the NetworkManager daemon, issue the following command as the
236 <systemitem class="username">root</systemitem> user:
237 </para>
238
239 <indexterm zone="NetworkManager NetworkManager-init-systemd">
240 <primary sortas="f-NetworkManager">NetworkManager</primary>
241 </indexterm>
242
243<screen role="root"><userinput>systemctl enable NetworkManager</userinput></screen>
244
245 <para>
246 The other systemd unit that this package provides is NetworkManager-wait-online.service
247 which can be used to block programs that require connectivity (depending on the systemd network.target)
248 from starting untill the network interfaces have been configured.
249 </para>
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-avahi-autoipd.action, nm-dhcp-helper,
266 nm-dispatcher, nm-online, nmcli, and, hardlinked to each other:
267 nmtui, nmtui-connect, nmtui-edit, and nmtui-hostname
268 </seg>
269 <seg>
270 libnm-glib.so, libnm-glib-vpn.so, libnm-util.so, and
271 modules under /usr/lib/NetworkManager
272 </seg>
273 <seg>
274 /etc/NetworkManager,
275 /usr/include/libnm-glib,
276 /usr/include/NetworkManager,
277 /usr/lib/NetworkManager,
278 /usr/share/doc/NetworkManager,
279 /usr/share/gtk-doc/html/libnm-glib,
280 /usr/share/gtk-doc/html/libnm-util,
281 /usr/share/gtk-doc/html/NetworkManager,
282 /var/lib/NetworkManager, and
283 /var/run/NetworkManager
284 </seg>
285 </seglistitem>
286 </segmentedlist>
287
288 <variablelist>
289 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
290 <?dbfo list-presentation="list"?>
291 <?dbhtml list-presentation="table"?>
292
293 <varlistentry id="nmcli">
294 <term><command>nmcli</command></term>
295 <listitem>
296 <para>
297 is a command-line tool for controlling
298 <application>NetworkManager</application>
299 and getting its status.
300 </para>
301 <indexterm zone="NetworkManager nmcli">
302 <primary sortas="b-nmcli">nmcli</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="nm-online">
308 <term><command>nm-online</command></term>
309 <listitem>
310 <para>
311 is a utility to find out whether you are online.
312 </para>
313 <indexterm zone="NetworkManager nm-online">
314 <primary sortas="b-nm-online">nm-online</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="nmtui">
320 <term><command>nmtui</command></term>
321 <listitem>
322 <para>
323 interactive ncurses based interface for
324 <application>nmcli</application>.
325 </para>
326 <indexterm zone="NetworkManager nmtui">
327 <primary sortas="b-nmtui">nmtui</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="nmtui-connect">
333 <term><command>nmtui-connect</command></term>
334 <listitem>
335 <para>
336 interactive ncurses based interface connection activate/deactivate.
337 </para>
338 <indexterm zone="NetworkManager nmtui-connect">
339 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="nmtui-edit">
345 <term><command>nmtui-edit</command></term>
346 <listitem>
347 <para>
348 interactive ncurses based interface connection 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 interactive ncurses based interface hostname 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.