source: general/genutils/ibus.xml

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

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 9.9 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 ibus-download-http "https://github.com/ibus/ibus/releases/download/&ibus-version;/ibus-&ibus-version;.tar.gz">
8 <!ENTITY ibus-download-ftp " ">
9 <!ENTITY ibus-md5sum "3590d33fbd84e041acb75fcee818b504">
10 <!ENTITY ibus-size "3.6 MB">
11 <!ENTITY ibus-buildsize "66 MB (add 3 MB for tests)">
12 <!ENTITY ibus-time "0.2 SBU (Using parallelism=4; add 0.6 SBU for tests)">
13
14 <!ENTITY ucd-download-http "https://www.unicode.org/Public/zipped/14.0.0/UCD.zip">
15]>
16
17<sect1 id="ibus" xreflabel="ibus-&ibus-version;">
18 <?dbhtml filename="ibus.html"?>
19
20
21 <title>ibus-&ibus-version;</title>
22
23 <indexterm zone="ibus">
24 <primary sortas="a-ibus">ibus</primary>
25 </indexterm>
26
27 <sect2 role="package">
28 <title>Introduction to ibus</title>
29
30 <para>
31 <application>ibus</application> is an Intelligent Input Bus. It is a new
32 input framework for the Linux OS. It provides a fully featured and user
33 friendly input method user interface.
34 </para>
35
36 &lfs112_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&ibus-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&ibus-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &ibus-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &ibus-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &ibus-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &ibus-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">Optional Download</bridgehead>
73
74 <bridgehead renderas="sect4">Unicode Character Database</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>
78 Download: <ulink url="&ucd-download-http;"> &ucd-download-http;</ulink>
79 (Unicode Character Database)
80 </para>
81 </listitem>
82 </itemizedlist>
83
84 <bridgehead renderas="sect3">ibus Dependencies</bridgehead>
85
86 <bridgehead renderas="sect4">Required</bridgehead>
87 <para role="required">
88 <xref linkend="dconf"/>,
89 <xref linkend="iso-codes"/>, and
90 <xref linkend="vala"/>
91 </para>
92
93 <bridgehead renderas="sect4">Recommended</bridgehead>
94 <para role="recommended">
95 <xref linkend="gobject-introspection"/>,
96 <xref linkend="gtk2"/>, and
97 <xref linkend="libnotify"/>
98 </para>
99
100 <bridgehead renderas="sect4">Optional</bridgehead>
101 <para role="optional">
102 <xref linkend="gtk3"/> (to build IM module for it),
103 <xref linkend="gtk4"/> (to build IM module for it),
104 <xref linkend="dbus-python"/> and
105 <xref linkend="pygobject3"/> (both to build the Python support library),
106 <xref linkend="gtk-doc"/>,
107 <xref linkend="pyxdg" role="runtime"/>
108 (runtime, for the <command>ibus-setup</command>), and
109 <xref linkend="libxkbcommon"/>,
110 <xref linkend="wayland"/> (both to build the Wayland support programs), and
111 <ulink url="https://www.joypixels.com/">EmojiOne</ulink>
112 </para>
113
114 <para condition="html" role="usernotes">
115 User Notes: <ulink url="&blfs-wiki;/ibus"/>
116 </para>
117 </sect2>
118
119 <sect2 role="installation">
120 <title>Installation of ibus</title>
121
122 <para>
123 If the optional Unicode Character Database was downloaded, install it
124 now as the <systemitem class="username">root</systemitem> user:
125 </para>
126
127<screen role="root"><userinput>mkdir -p /usr/share/unicode/ucd &amp;&amp;
128unzip -uo ../UCD.zip -d /usr/share/unicode/ucd</userinput></screen>
129
130 <note>
131 <para>
132 Be sure to also remove the --disable-unicode-dict in
133 the configure step below.
134 </para>
135 </note>
136
137 <para>
138 Fix an issue with deprecated schema entries:</para>
139
140<screen><userinput>sed -i 's@/desktop/ibus@/org/freedesktop/ibus@g' \
141 data/dconf/org.freedesktop.ibus.gschema.xml</userinput></screen>
142
143 <para>
144 Install <application>ibus</application> by running the following
145 commands:
146 </para>
147
148<screen revision='sysv'><userinput>./configure --prefix=/usr \
149 --sysconfdir=/etc \
150 --disable-python2 \
151 --disable-emoji-dict \
152 --disable-unicode-dict \
153 --disable-systemd-services &amp;&amp;
154rm -f tools/main.c &amp;&amp;
155make</userinput></screen>
156
157<screen revision='systemd'><userinput>./configure --prefix=/usr \
158 --sysconfdir=/etc \
159 --disable-python2 \
160 --disable-emoji-dict \
161 --disable-unicode-dict &amp;&amp;
162rm -f tools/main.c &amp;&amp;
163make</userinput></screen>
164
165 <para>
166 To test the results, issue: <command>make -k check</command>.
167 The test named ibus-compose fails because it uses some locales
168 not installed in LFS.
169 The test named ibus-keypress is known to fail in a Wayland based desktop
170 environment.
171 The test named test-override-ibus.py is known to fail if Python
172 support library is enabled.
173 </para>
174
175 <para>
176 Now, as the <systemitem class="username">root</systemitem> user:
177 </para>
178
179<screen role="root"><userinput>make install &amp;&amp;
180gzip -dfv /usr/share/man/man{{1,5}/ibus*.gz,5/00-upstream-settings.5.gz}</userinput></screen>
181
182 </sect2>
183
184 <sect2 role="commands">
185 <title>Command Explanations</title>
186
187 <para>
188 <parameter>--disable-emoji-dict</parameter>: This switch disables the
189 use of emoticon dictionaries. Omit if you installed the optional
190 package.
191 </para>
192
193 <para>
194 <parameter>--disable-unicode-dict</parameter>: This switch disables the use
195 of unicode dictionaries. Omit if you installed the optional
196 Unicode Character Database.
197 </para>
198
199 <para>
200 <command>rm -f tools/main.c</command>: This command removes a generated
201 file that was not removed when packaging.
202 </para>
203
204 <para>
205 <option>--disable-gtk2</option>: This switch disables building
206 the <application>GTK+ 2</application> immodule. Use it if
207 you have not installed <application>GTK+ 2</application>.
208 </para>
209
210 <para>
211 <option>--enable-gtk4</option>: This switch enables building
212 the <application>GTK 4</application> immodule. Use it if
213 you have installed <application>GTK 4</application>.
214 </para>
215
216 <para>
217 <option>--enable-python-library</option>: This switch enables
218 building the <application>Python</application> support
219 library. Use it if you have installed the optional dependencies.
220 </para>
221
222 <para>
223 <option>--enable-wayland</option>: This switch enables building
224 the <application>Wayland</application> support programs.
225 Use it if you have installed the optional dependencies.
226 </para>
227
228 <para>
229 <option>--with-python=python3</option>: This switch makes
230 the <command>configure</command> script look for
231 <application>Python 3</application>. Use it if you want
232 to build the <application>Python 3</application> support
233 library alongside the <application>Python 2</application>
234 one.
235 </para>
236
237 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
238 href="../../xincludes/gtk-doc-rebuild.xml"/>
239
240 <para>
241 <command>gzip -dfv ...</command>: Decompress installed man pages
242 in accordance with other man pages.
243 </para>
244
245 </sect2>
246
247 <sect2 role="content">
248 <title>Contents</title>
249
250 <segmentedlist>
251 <segtitle>Installed Programs</segtitle>
252 <segtitle>Installed Library</segtitle>
253 <segtitle>Installed Directories</segtitle>
254
255 <seglistitem>
256 <seg>
257 ibus,
258 ibus-daemon, and
259 ibus-setup
260 </seg>
261 <seg>
262 libibus-1.0.so and
263 im-ibus.so (<application>GTK+ Immodule</application>)
264 </seg>
265 <seg>
266 /etc/dconf/db/ibus.d,
267 /usr/include/ibus-1.0,
268 /usr/share/gtk-doc/html/ibus, and
269 /usr/share/ibus
270 </seg>
271 </seglistitem>
272 </segmentedlist>
273
274 <variablelist>
275 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
276 <?dbfo list-presentation="list"?>
277 <?dbhtml list-presentation="table"?>
278
279 <varlistentry id="ibus-daemon">
280 <term><command>ibus-daemon</command></term>
281 <listitem>
282 <para>
283 is the Intelligent Input Bus Daemon
284 </para>
285 <indexterm zone="ibus ibus-daemon">
286 <primary sortas="b-ibus-daemon">ibus-daemon</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="ibus-setup">
292 <term><command>ibus-setup</command></term>
293 <listitem>
294 <para>
295 is the <application>GTK+</application> program used to configure
296 the <command>ibus-daemon</command>
297 </para>
298 <indexterm zone="ibus ibus-setup">
299 <primary sortas="b-ibus-setup">ibus-setup</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="libibus-1.0">
305 <term><filename class="libraryfile">libibus-1.0.so</filename></term>
306 <listitem>
307 <para>
308 contains the <application>ibus</application> API functions
309 </para>
310 <indexterm zone="ibus libibus-1.0">
311 <primary sortas="c-libibus-1.0">libibus-1.0.so</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 </variablelist>
317
318 </sect2>
319
320</sect1>
Note: See TracBrowser for help on using the repository browser.