58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
DeforaOS Keyboard
|
|
=================
|
|
|
|
About Keyboard
|
|
--------------
|
|
|
|
This program emulates a physical keyboard by providing a virtual interface on
|
|
screen. It currently supports four modes:
|
|
* docked, where it will occupy the bottom of the screen;
|
|
* popup, likewise as a popup window;
|
|
* windowed, where it can be found in the system tray (the default)
|
|
* embedded, which outputs its window ID for inclusion within another program.
|
|
|
|
Additionally, it can be piloted through its companion tool, `desktopctl(1)`.
|
|
|
|
Keyboard is part of the DeforaOS Project, found at https://www.defora.org/.
|
|
|
|
Compiling Keyboard
|
|
------------------
|
|
|
|
The current requirements for compiling Keyboard are as follows:
|
|
* Gtk+ 2.4 or later, or Gtk+ 3.0 or later
|
|
* DeforaOS libDesktop
|
|
* an implementation of `make`
|
|
* gettext (libintl) for translations
|
|
|
|
With these installed, the following command should be enough to compile Keyboard
|
|
on most systems:
|
|
|
|
$ make
|
|
|
|
The following command will then install Keyboard:
|
|
|
|
$ make install
|
|
|
|
To install (or package) Keyboard in a different location:
|
|
|
|
$ make clean
|
|
$ make PREFIX="/another/prefix" install
|
|
|
|
Keyboard also supports `DESTDIR`, to be installed in a staging directory; for
|
|
instance:
|
|
|
|
$ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install
|
|
|
|
On some systems, the Makefiles shipped can be re-generated accordingly thanks to
|
|
the DeforaOS configure tool.
|
|
|
|
The compilation process supports a number of options, such as PREFIX and DESTDIR
|
|
for packaging and portability, or OBJDIR for compilation outside of the source
|
|
tree.
|
|
|
|
Distributing Keyboard
|
|
---------------------
|
|
|
|
DeforaOS Keyboard is subject to the terms of the 2-clause BSD license. Please
|
|
see the `COPYING` file for more information.
|