11Maliit
2+ ======
23
34Maliit provides a flexible and cross-platform input method framework. It has a
45plugin-based client-server architecture where applications act as clients and
56communicate with the Maliit server via input context plugins. The communication
6- link currently uses D-Bus. Maliit is an open source framework (LGPL 2) with
7- open source plugins (BSD).
8-
9- This is the Maliit framework. For a virtual keyboard, see
10- https://github.com/maliit/keyboard .
11-
7+ link currently uses D-Bus. Maliit is an open source framework (LGPL 2.1) with
8+ a production-quality [ keyboard plugin] ( https://github.com/maliit/keyboard ) (LGPL 3.0).
129
1310Installing
11+ ----------
1412
15- Qt5 must be installed to build the Maliit framework. At a terminal, run:
13+ Qt 5 must be installed to build the Maliit framework. At a terminal, run:
1614
15+ ```
1716mkdir build
1817cd build
1918cmake -DCMAKE_INSTALL_PREFIX=/usr ..
2019make
2120make install
22-
23- Run qmake HELP=1 to get more information about build options.
24-
21+ ```
2522
2623Running
24+ -------
2725
2826Set Maliit as the Qt and GTK+ input context:
2927
28+ ```
3029export QT_IM_MODULE=Maliit
3130export GTK_IM_MODULE=Maliit
31+ ```
3232
3333Start the server:
3434
35+ ```
3536maliit-server
37+ ```
3638
3739Note that a compositing window manager and a D-Bus session bus are required to
3840use Maliit.
3941
4042Test with the provided example applications:
4143
44+ ```
4245maliit-exampleapp-plainqt # for Qt
4346maliit-exampleapp-gtk2 # for Gtk2
4447maliit-exampleapp-gtk3 # for Gtk3
48+ ```
4549
4650Double-tap on the input field, and an input method (usually a virtual keyboard)
4751should be shown. Note that an input method plugin, such as the Maliit keyboard
@@ -52,17 +56,20 @@ to work.
5256NETWORK TRANSPARENCY
5357
5458On one computer run:
59+ ```
5560maliit-server -allow-anonymous -override-address tcp:host=xxx.xxx.xxx.xxx,port=yyyyy
61+ ```
5662
5763Any valid dbus address is supported. Using -allow-anonymous must only be done on
5864a trusted network. If using a method with authentication, the -allow-anonymous flag
5965may be dropped.
6066
6167On another computer:
68+ ```
6269MALIIT_SERVER_ADDRESS=tcp:host=xxx.xxx.xxx.xxx,port=yyyyy
6370export MALIIT_SERVER_ADDRESS
6471maliit-exampleapp-plainqt (or maliit-exampleapp-gtk{2,3})
72+ ```
6573
6674Where xxx.xxx.xxx.xxx is IP address of computer where maliit-server is ran
6775and yyyyy is port number < 65536.
68-
0 commit comments