source: archive/wicd.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 12.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 wicd-download-http "https://launchpad.net/wicd/&wicd-major-version;/&wicd-version;/+download/wicd-&wicd-version;.tar.gz">
8 <!ENTITY wicd-download-ftp " ">
9 <!ENTITY wicd-md5sum "aaa2e9f5320849e0b5d053099a6f0007">
10 <!ENTITY wicd-size "536 KB">
11 <!ENTITY wicd-buildsize "4.2 MB">
12 <!ENTITY wicd-time "less than 0.1 SBU">
13]>
14
15<sect1 id="wicd" xreflabel="Wicd-&wicd-version;">
16 <?dbhtml filename="wicd.html"?>
17
18
19 <title>Wicd-&wicd-version;</title>
20
21 <indexterm zone="wicd">
22 <primary sortas="a-wicd">wicd</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Wicd</title>
27
28 <para><application>Wicd</application> is a network manager written in
29 Python. It simplifies network setup by automatically detecting and
30 connecting to wireless and wired networks. Wicd includes support for WPA
31 authentication and DHCP configuration. It provides Curses- and GTK-based
32 graphical frontends for user-friendly control. An excellent KDE-based
33 frontend is also available
34 <ulink url="http://projects.kde.org/projects/extragear/network/wicd-kde">
35 http://projects.kde.org/projects/extragear/network/wicd-kde</ulink>.
36 </para>
37
38 &lfs83_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>Download (HTTP): <ulink url="&wicd-download-http;"/></para>
44 </listitem>
45 <listitem>
46 <para>Download (FTP): <ulink url="&wicd-download-ftp;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download MD5 sum: &wicd-md5sum;</para>
50 </listitem>
51 <listitem>
52 <para>Download size: &wicd-size;</para>
53 </listitem>
54 <listitem>
55 <para>Estimated disk space required: &wicd-buildsize;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated build time: &wicd-time;</para>
59 </listitem>
60 </itemizedlist>
61
62 <bridgehead renderas="sect3">Wicd Dependencies</bridgehead>
63
64 <bridgehead renderas="sect4">Required</bridgehead>
65 <para role="required">
66 <xref linkend="python2"/>,
67 <xref linkend="dbus-python"/>,
68 <xref linkend="wireless_tools"/>, and
69 <xref linkend="net-tools"/>
70 (Wicd needs <command>mii-tool</command> from this package)
71 </para>
72
73 <bridgehead renderas="sect4">Recommended</bridgehead>
74 <para role="recommended">
75 <xref linkend="pygtk"/> (for the GTK frontend),
76 <xref linkend="wpa_supplicant"/> (for WPA support), and
77 <xref linkend="dhcpcd"/> or <xref linkend="dhcp"/> (for DHCP support)
78 </para>
79
80 <bridgehead renderas="sect4">Optional</bridgehead>
81 <para role="optional">
82 <xref linkend="pm-utils"/> (for suspend/resume integration),
83 <ulink url="http://urwid.org/">Urwid</ulink>
84 (for the Curses-based frontend), and
85 <ulink url="http://babel.edgewall.org/">Babel</ulink>
86 (for internationalization)
87 </para>
88
89 <para condition="html" role="usernotes">User Notes:
90 <ulink url="&blfs-wiki;/wicd"/></para>
91
92 </sect2>
93
94 <sect2 role="installation">
95 <title>Installation of Wicd</title>
96
97 <para>Install <application>Wicd</application> by running the following
98 commands:</para>
99
100<screen revision="sysv"><userinput>sed -e "/wpath.logrotate\|wpath.systemd/d" \
101 -e "/detection failed/ a\ self.init='init/default/wicd'" \
102 -i.orig setup.py &amp;&amp;
103
104rm po/*.po &amp;&amp;
105
106python setup.py configure --no-install-kde \
107 --no-install-acpi \
108 --no-install-pmutils \
109 --no-install-init \
110 --no-install-gnome-shell-extensions \
111 --docdir=/usr/share/doc/wicd-&wicd-version;</userinput></screen>
112
113<screen revision="systemd"><userinput>sed -e "/detection failed/ a\ self.init='init/default/wicd'" \
114 -i.orig setup.py &amp;&amp;
115
116rm po/*.po &amp;&amp;
117
118python setup.py configure --no-install-kde \
119 --no-install-acpi \
120 --no-install-pmutils \
121 --no-install-init \
122 --no-install-gnome-shell-extensions \
123 --docdir=/usr/share/doc/wicd-&wicd-version;</userinput></screen>
124
125 <para>This package does not come with a test suite.</para>
126
127 <para>Now, as the <systemitem class="username">root</systemitem> user,
128 install the package:</para>
129
130<screen role="root"><userinput>python setup.py install</userinput></screen>
131
132 </sect2>
133
134 <sect2 role="commands">
135 <title>Command Explanations</title>
136
137 <para revision="sysv"><command>sed -e ... -i setup.py</command>: The first
138 expression in this <command>sed</command> command prevents installation of
139 logrotate and systemd configuration files. You may omit it if you use these
140 utilities. The second one fixes building with BLFS.</para>
141
142 <para revision="systemd"><command>sed ... -i.orig setup.py</command>: Fix
143 and issue while building with BLFS.</para>
144
145 <para><command>rm po/*.po</command>: This command removes the international
146 messages associated with this package. The command is required unless Babel
147 is installed. If it is installed, po/ast.po still needs to be removed in
148 order for the build to complete.</para>
149
150 <para><parameter>--no-install-kde</parameter>: Prevent installation of an
151 autostart desktop file for KDE. If you use KDE, you should instead install
152 the
153 <ulink url="http://projects.kde.org/projects/extragear/network/wicd-kde">Wicd
154 KDE Client</ulink>.</para>
155
156 <para><parameter>--no-install-acpi</parameter>: Prevent installation of
157 <command>suspend</command> and <command>resume</command> scripts for acpid.
158 Omit this option if you use acpid.</para>
159
160 <para><parameter>--no-install-pmutils</parameter>: Prevent installation of
161 hooks for pm-utils. Omit this option if you use pm-utils.</para>
162
163 <para revision="sysv"><parameter>--no-install-init</parameter>: Prevent
164 installation of any init scripts, as a bootscript is installed later in the
165 instructions.</para>
166
167 <para revision="systemd"><parameter>--no-install-init</parameter>: Prevent
168 installation of service files twice. They are installed as a part of
169 the sed to setup.py.</para>
170
171 <para><parameter>--no-install-gnome-shell-extensions</parameter>: Prevent
172 installation of the respective extensions. Remove this switch, if you are
173 using Gnome Shell.</para>
174
175 <para><option>--wicdgroup=<replaceable>&lt;group&gt;</replaceable></option>:
176 The group that will have permission to use the Wicd client (default is the
177 <systemitem class="groupname">users</systemitem> group).</para>
178
179 </sect2>
180
181 <sect2 role="configuration">
182 <title>Configuring Wicd</title>
183
184 <sect3 id="wicd-config">
185 <title>Config Files</title>
186
187 <para><filename>/etc/wicd/manager-settings.conf</filename>,
188 <filename>/etc/wicd/wired-settings.conf</filename> and
189 <filename>/etc/wicd/wireless-settings.conf</filename></para>
190
191 </sect3>
192
193 <sect3 id="wicd-init">
194 <title>Configuration Information</title>
195
196 <note revision="systemd">
197 <para>
198 Make sure that you disable the <command>systemd-networkd</command>
199 service or configure it not to manage the interfaces you want to
200 manage with <application>Wicd</application>.
201 </para>
202 </note>
203
204 <para revision="sysv">To automatically start Wicd at boot time, you need
205 to first install the Wicd bootscript,
206 <filename>/etc/rc.d/init.d/wicd</filename> included in the <xref
207 linkend="bootscripts"/> package (as user <systemitem
208 class="username">root</systemitem>):</para>
209
210 <indexterm zone="wicd wicd-init" revision="sysv">
211 <primary sortas="f-wicd">wicd (bootscript)</primary>
212 </indexterm>
213
214 <screen role='root' revision="sysv"><userinput>make install-wicd</userinput></screen>
215
216 <para revision="sysv">Since Wicd will now handle all configuration of
217 network devices, the network bootscript installed by LFS should be
218 disabled. This can be achieved by either removing any
219 <filename>S*network</filename> and <filename>K*network</filename>
220 symlinks in the <filename>/etc/rc*.d</filename> directories or by setting
221 <literal>ONBOOT=no</literal> in any
222 <filename>/etc/sysconfig/ifconfig.*</filename> files.</para>
223
224 <para revision="systemd">To enable wicd at boot time, as the
225 <systemitem class="username">root</systemitem> user, run:</para>
226
227 <screen role='root' revision="systemd"><userinput>systemctl enable wicd</userinput></screen>
228
229 <para>No manual configuration of Wicd is needed if you use the graphical
230 frontends. If you are only going to use Wicd from command-line, you can
231 configure it using the configuration files in
232 <filename>/etc/wicd</filename>. For a list of available options, look at
233 the man-pages for: wicd-manager-settings.conf, wicd-wired-settings.conf
234 and wicd-wireless-settings.conf.</para>
235
236 <para>Be sure to add all users who are to have rights to open and close
237 network connections with Wicd to the
238 <systemitem class="groupname">users</systemitem> group (or the group
239 specified with the <option>--wicdgroup</option> configuration
240 option).</para>
241
242 </sect3>
243
244 </sect2>
245
246 <sect2 role="content">
247 <title>Contents</title>
248
249 <segmentedlist>
250 <segtitle>Installed Programs</segtitle>
251 <segtitle>Installed Libraries</segtitle>
252 <segtitle>Installed Directories</segtitle>
253
254 <seglistitem>
255 <seg>wicd, wicd-cli, wicd-client, wicd-curses (not functional if <ulink
256 url="http://urwid.org/">Urwid</ulink> is not installed), and
257 wicd-gtk</seg>
258 <seg>None</seg>
259 <seg>/{etc,usr/share,var/lib,var/log,var/run}/wicd,
260 /usr/lib/python2.7/site-packages/wicd and
261 /usr/share/doc/wicd-&wicd-version;</seg>
262 </seglistitem>
263 </segmentedlist>
264
265 <variablelist>
266 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
267 <?dbfo list-presentation="list"?>
268 <?dbhtml list-presentation="table"?>
269
270 <varlistentry id="wicdd">
271 <term><command>wicd</command></term>
272 <listitem>
273 <para>is the wicd daemon.</para>
274 <indexterm zone="wicd wicdd">
275 <primary sortas="b-wicdd">wicd</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="wicd-cli">
281 <term><command>wicd-cli</command></term>
282 <listitem>
283 <para>is a command line interface for configuring the wicd daemon.</para>
284 <indexterm zone="wicd wicd-cli">
285 <primary sortas="b-wicd-cli">wicd-cli</primary>
286 </indexterm>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry id="wicd-client">
291 <term><command>wicd-client</command></term>
292 <listitem>
293 <para>is the wicd client. This script attempts to automatically choose
294 the relevant configuration interface.</para>
295 <indexterm zone="wicd wicd-client">
296 <primary sortas="b-wicd-client">wicd-client</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="wicd-curses">
302 <term><command>wicd-curses</command></term>
303 <listitem>
304 <para>is a curses interface for configuring the wicd daemon.</para>
305 <indexterm zone="wicd wicd-curses">
306 <primary sortas="b-wicd-curses">wicd-curses</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="wicd-gtk">
312 <term><command>wicd-gtk</command></term>
313 <listitem>
314 <para>is a GTK interface for configuring the wicd daemon</para>
315 <indexterm zone="wicd wicd-gtk">
316 <primary sortas="b-wicd-gtk">wicd-gtk</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 </variablelist>
322
323 </sect2>
324
325</sect1>
Note: See TracBrowser for help on using the repository browser.