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