source: networking/netutils/networkmanager-systemd.xml@ f81638e

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

Begin merging Christophers work into systemd branch part 1.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@13486 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="udev-extras"/> (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="systemd"/> (for Logind), 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-systemdsystemunitdir=no &amp;&amp;
136make</userinput></screen>
137
138 <para>
139 An already active graphical session with bus address is necessary to run
140 the tests. To test the results, issue: <command>make check</command>.
141 </para>
142
143 <para>
144 Now, as the <systemitem class="username">root</systemitem> user:
145 </para>
146
147<screen role="root"><userinput>make install</userinput></screen>
148
149 </sect2>
150
151 <sect2 role="commands">
152 <title>Command Explanations</title>
153
154 <para>
155 <parameter>--with-nmtui</parameter>: This parameter enables build of
156 <command>nmtui</command>.
157 </para>
158
159 <para>
160 <parameter>--with-systemdsystemunitdir=no</parameter>: This parameter is
161 used for sysv init systems. If you use systemd, replace "no" by the
162 proper directory.
163 </para>
164
165 <para>
166 <parameter>--disable-ppp</parameter>: This parameter disables parameteral
167 <application>PPP</application> support in
168 <application>NetworkManager</application>.
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
194 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
204 minimal configuration file must be present. Such file is not
205 installed with <command>make install</command>. Issue following
206 command as the
207 <systemitem class="username">root</systemitem> user to create
208 minimal <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>Boot Script</title>
227
228 <para>
229 To automatically start the <command>NetworkManager</command> daemon when the
230 system is rebooted, install the
231 <filename>/etc/rc.d/init.d/networkmanager</filename> bootscript from the
232 <xref linkend="bootscripts"/> package.
233 </para>
234
235 <indexterm zone="NetworkManager NetworkManager-init">
236 <primary sortas="f-NetworkManager">NetworkManager</primary>
237 </indexterm>
238
239<screen role="root"><userinput>make install-networkmanager</userinput></screen>
240
241 </sect3>
242
243 </sect2>
244
245 <sect2 role="content">
246 <title>Contents</title>
247
248 <segmentedlist>
249 <segtitle>Installed Programs</segtitle>
250 <segtitle>Installed Libraries</segtitle>
251 <segtitle>Installed Directories</segtitle>
252
253 <seglistitem>
254 <seg>
255 NetworkManager, nm-avahi-autoipd.action, nm-dhcp-helper,
256 nm-dispatcher, nm-online, nmcli, and, hardlinked to each other:
257 nmtui, nmtui-connect, nmtui-edit, and nmtui-hostname
258 </seg>
259 <seg>
260 libnm-glib.so, libnm-glib-vpn.so, libnm-util.so, and
261 modules under /usr/lib/NetworkManager
262 </seg>
263 <seg>
264 /etc/NetworkManager,
265 /usr/include/libnm-glib,
266 /usr/include/NetworkManager,
267 /usr/lib/NetworkManager,
268 /usr/share/doc/NetworkManager,
269 /usr/share/gtk-doc/html/libnm-glib,
270 /usr/share/gtk-doc/html/libnm-util,
271 /usr/share/gtk-doc/html/NetworkManager,
272 /var/lib/NetworkManager, and
273 /var/run/NetworkManager
274 </seg>
275 </seglistitem>
276 </segmentedlist>
277
278 <variablelist>
279 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
280 <?dbfo list-presentation="list"?>
281 <?dbhtml list-presentation="table"?>
282
283 <varlistentry id="nmcli">
284 <term><command>nmcli</command></term>
285 <listitem>
286 <para>
287 is a command-line tool for controlling
288 <application>NetworkManager</application>
289 and getting its status.
290 </para>
291 <indexterm zone="NetworkManager nmcli">
292 <primary sortas="b-nmcli">nmcli</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="nm-online">
298 <term><command>nm-online</command></term>
299 <listitem>
300 <para>
301 is a utility to find out whether you are online.
302 </para>
303 <indexterm zone="NetworkManager nm-online">
304 <primary sortas="b-nm-online">nm-online</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="nmtui">
310 <term><command>nmtui</command></term>
311 <listitem>
312 <para>
313 interactive ncurses based interface for
314 <application>nmcli</application>.
315 </para>
316 <indexterm zone="NetworkManager nmtui">
317 <primary sortas="b-nmtui">nmtui</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="nmtui-connect">
323 <term><command>nmtui-connect</command></term>
324 <listitem>
325 <para>
326 interactive ncurses based interface connection activate/deactivate.
327 </para>
328 <indexterm zone="NetworkManager nmtui-connect">
329 <primary sortas="b-nmtui-connect">nmtui-connect</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="nmtui-edit">
335 <term><command>nmtui-edit</command></term>
336 <listitem>
337 <para>
338 interactive ncurses based interface connection editor.
339 </para>
340 <indexterm zone="NetworkManager nmtui-edit">
341 <primary sortas="b-nmtui-edit">nmtui-edit</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="nmtui-hostname">
347 <term><command>nmtui-hostname</command></term>
348 <listitem>
349 <para>
350 interactive ncurses based interface hostname editor.
351 </para>
352 <indexterm zone="NetworkManager nmtui-hostname">
353 <primary sortas="b-nmtui-hostname">nmtui-hostname</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="NetworkManager-prog">
359 <term><command>NetworkManager</command></term>
360 <listitem>
361 <para>
362 is the network management daemon.
363 </para>
364 <indexterm zone="NetworkManager NetworkManager-prog">
365 <primary sortas="b-NetworkManager">NetworkManager</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="libnm-glib">
371 <term><filename class="libraryfile">libnm-glib.so</filename></term>
372 <listitem>
373 <para>
374 contains functions used by <application>NetworkManager</application>.
375 </para>
376 <indexterm zone="NetworkManager libnm-glib">
377 <primary sortas="c-libnm-glib">libnm-glib.so</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="libnm-glib-vpn">
383 <term><filename class="libraryfile">libnm-glib-vpn.so</filename></term>
384 <listitem>
385 <para>
386 contains functions used by <application>NetworkManager</application>
387 VPN plugins.
388 </para>
389 <indexterm zone="NetworkManager libnm-glib-vpn">
390 <primary sortas="c-libnm-glib-vpn">libnm-glib-vpn.so</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="libnm-util">
396 <term><filename class="libraryfile">libnm-util.so</filename></term>
397 <listitem>
398 <para>
399 contains functions used by <application>NetworkManager</application>
400 utils.
401 </para>
402 <indexterm zone="NetworkManager libnm-util">
403 <primary sortas="c-libnm-util">libnm-util.so</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 </variablelist>
409
410 </sect2>
411
412</sect1>
Note: See TracBrowser for help on using the repository browser.