spiegel-keyman/linux

Keyman for Linux

Projects

• kmflcomp - KMFL keyboard compiler
• libkmfl - core library
• ibus-kmfl - IBUS integration to use KMFL
• ibus-keyman - IBUS integration to use .kmx Keyman keyboards
• scim_kmfl_imengine - deprecated SCIM engine to use KMFL

See license information about licensing.

Linux Requirements/Setup

• It is helpful to be using the packages.sil.org repo

• Install packages required for building and developing KMFL and Keyman for Linux sudo apt install cdbs debhelper libx11-dev autotools-dev build-essential devtools dh-autoreconf flex bison libibus-1.0-dev python3-setuptools meson libjson-glib-dev libgtk-3-dev libxml2-utils help2man python3-lxml python3-magic python3-numpy python3-pil python3-pip python3-requests python3-requests-cache python3 python3-gi gir1.2-webkit-3.0 dconf-cli

Compiling from Command Line

Build script

Installing for ibus to use ibus-kmfl or ibus-keyman

• The process to build and install everything is:

  • make reconf to create the build system and set the version
  • make fullbuild to configure and build
  • sudo make install to install to /usr/local

• Some of the files must be installed to /usr/share/ so make install must be run as sudo.

• To do this run sudo make install

  • This will install to /usr/local

    • and /usr/share/ibus/component/kmfl.xml and /usr/share/kmfl/icons
    • and /usr/share/ibus/component/keyman.xml and /usr/share/keyman/icons

  • If you already have the ibus-kmfl package installed then it will move the file /usr/share/ibus/component/kmfl.xml to /usr/share/doc/ibus-kmfl/

  • If you already have the ibus-keyman package installed then it will move the file /usr/share/ibus/component/keyman.xml to /usr/share/doc/ibus-keyman/

    • run sudo make uninstall to uninstall everything and put it back again

Tmp install

Used by TC for validating PRs

Run make tmpinstall to build and install keyboardprocessor, kmflcomp, libkmfl, ibus-kmfl and ibus-keyman to /tmp/kmfl

This is only for testing the build, not for running ibus-kmfl or ibus-keyman in ibus

Manually

• libkmfl requires kmfl.h header from kmflcomp
• ibus-kfml requires kmfl.h and headers and lib from libkmfl
• ibus-keyman requires headers and lib from keyboardprocessor

So

• kmflcomp must be built and installed before libkmfl
• libkmfl must be built and installed before ibus-kmfl
• keyboardprocessor must be built before ibus-keyman

For each project run ./configure && make && make install.

You may prefer to create a different directory to build in and run configure from there e.g.

mkdir ../build-kmflcomp; cd ../build-kmflcomp ../kmflcomp/configure make make install

The install of ibus-kmfl doesn't install everything to the correct location for it to be used - to be fixed

Continuous integration

Teamcity PR builds will run make tmpinstall Master builds run make tmpinstall and create source packages Nightly builds upload the most recent new master build to https://downloads.keyman.com

Building packages

Jenkins now continuously builds Debian packages on every commit to master Periodically test packages will be uploaded to https://launchpad.net/~keymanapp/+archive/ubuntu/keyman-daily

Launchpad

This section is primarily for "Keyman for Linux" team members, and not needed for general building.

1. If you don't have one, create an account at https://launchpad.net
2. Request to join the "Keyman for Linux" team.
3. Create a GPG key and associate it to your launchpad account
4. Set the following environment variables in your ~/.profile or ~/.bashrc (so you don't have to set them every time)
   export GPGKEY=[key_id] using the key_id of your GPG key
   DEBEMAIL="your.email.address@example.org"
DEBFULLNAME="Firstname Lastname"
export DEBEMAIL DEBFULLNAME

To upload the packages to launchpad, run the following script from the linux/ directory:

./scripts/launchpad.sh [UPLOAD="yes"] [TIER="<tier>"] [PROJECT="<project>"] [DIST="<dist>"] [PACKAGEVERSION="<version>"]

Parameters
UPLOAD="yes" do the dput for real
TIER="<tier>" alpha, beta, or stable, default beta
PROJECT="<project>" only upload this project
DIST="<dist>" only upload for this distribution
PACKAGEVERSION="<version>" normally use the default so don't specify it. But if you change packaging and run another upload you need to increment the number at the end of PACKAGEVERSION. e.g. next one is 1~sil2 then 1~sil3...

Refer to https://help.launchpad.net/Packaging/PPA/Uploading for troubleshooting and setting up for dput upload.

Testing

Tests to be created as there are no current tests

Running Keyman for Linux

Setting up Ibus

Ibus should be running on a default install of Ubuntu

You may want to install extra packages to get other ibus input methods e.g ibus-unikey for VN

Run ibus restart after installing any of them

Getting a Keyman keyboard

• There are some kmfl keyboards available on packages.sil.org. Search for "kmfl-keyboard". These will also install the ibus-kmfl package.

• You can find more .kmn source keyboards at the Keyboards repo. They may or may not currently work with KMFL.

• The .kmn file should be put in /usr/share/kmfl or ~/.kmfl, preferably ~/.kmfl

  • TODO: let ibus-kmfl find keyboards in /usr/local/share/kmfl as well

• After installing a Keyman keyboard you need to run ibus restart so that ibus will look for it. (TODO: double check this)

Activating a Keyman keyboard

GNOME3 (bionic default)

• Click the connection/sound/shutdown section in the top right. Then the tools icon for Settings.

• In Language and Region click + to add a keyboard.

• Click the 3 dots expander then search for "Other" and click it

• The Keyman keyboards should be listed here to choose

• Use Win-space to switch between keyboards.

Unity (xenial default)

• Run Text Entry
• Click + to add a keyboard.
• In Choose an input source search for "Other" or the keyboard name, or "Ibus" to find Keyman keyboards.

Check Show current input source in the menu bar to see what keyboard you are using and have a menu for keyboards.

Use Win-space to switch between keyboards.

Cinnamon (wasta xenial default)

• Open Menu and find IBus Preferencesand run it
• Make sure Show icon on system tray is checked
• Select the tab Input Method.
• Click Add to add a keyman keyboard.
• Click the 3 dots expander then search for "Other" and click it
• The Keyman keyboards should be listed here to choose

MATE (alternative)

• Open System-> Preferences -> Other -> IBus Preferences.
• Make sure Show icon on system tray is checked
• Select the tab Input Method.
• Click Add to add a keyman keyboard.
• Click the 3 dots expander then search for "Other" and click it
• The Keyman keyboards should be listed here to choose