README

Maliit

Maliit provides a flexible and cross-platform input method framework. It has a
plugin-based client-server architecture where applications act as clients and
communicate with the Maliit server via input context plugins. The communication
link currently uses D-Bus. Maliit is an open source framework (LGPL 2) with
open source plugins (BSD).

This is the Maliit framework. For plugins, such as virtual keyboards, see
http://wiki.maliit.org/Plugins


Installing

Qt5 must be installed to build the Maliit framework. At a terminal, run:

qmake
make
make install

Run qmake HELP=1 to get more information about build options.


Running

Set Maliit as the Qt and GTK+ input context:

export QT_IM_MODULE=Maliit
export GTK_IM_MODULE=Maliit

Start the server:

maliit-server

Note that a compositing window manager and a D-Bus session bus are required to
use Maliit.

Test with the provided example applications:

maliit-exampleapp-plainqt # for Qt
maliit-exampleapp-gtk2 # for Gtk2
maliit-exampleapp-gtk3 # for Gtk3

Double-tap on the input field, and an input method (usually a virtual keyboard)
should be shown. Note that an input method plugin, such as the Maliit keyboard
from the maliit-plugins package, must be installed for the example applications
to work.

Resources

Wiki: http://wiki.maliit.org/
IRC: #maliit on chat.freenode.net
Announcement mailing list: maliit-announce@lists.maliit.org
Discussion mailing list: maliit-discuss@lists.maliit.org


NETWORK TRANSPARENCY

On one computer run:
maliit-server -allow-anonymous -override-address tcp:host=xxx.xxx.xxx.xxx,port=yyyyy

Any valid dbus address is supported. Using -allow-anonymous must only be done on
a trusted network. If using a method with authentication, the -allow-anonymous flag
may be dropped.

On another computer:
MALIIT_SERVER_ADDRESS=tcp:host=xxx.xxx.xxx.xxx,port=yyyyy
export MALIIT_SERVER_ADDRESS
maliit-exampleapp-plainqt (or maliit-exampleapp-gtk{2,3})

Where xxx.xxx.xxx.xxx is IP address of computer where maliit-server is ran
and yyyyy is port number < 65536.