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