Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bfabiszewski committed Sep 27, 2016
1 parent 961cfce commit 00b9df5
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 12 deletions.
9 changes: 0 additions & 9 deletions README

This file was deleted.

48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# \# kterm

This is a simple GTK+ terminal emulator with embedded virtual keyboard. It is based on VteTerminal library. Some initial settings may be defined in [kterm.conf](kterm.conf) file. Keyboard layouts are defined in [xml config](layouts/keyboard.xml) files. The keyboard config files follow the same rules as matchbox keyboard configs (backward compatible with kterm 1.x which used embedded matchbox keyboard).

Kterm has been developed for Kindle Touch. It is reported to also work on Paperwhites. Generally it should work on any platform which supports GTK+, either version 2 or 3.

On Kindle menu pops up on two fingers tap in the terminal window. On other devices on right button mouse click.

* [Keyboard XML config](layouts/keyboard.xml) **\<nodes\>** and **attributes**:
* **\<layout\>** - layout
* **\<row\>** - row
* **\<space\>** - empty spacer
* **\<key\>** - key, attributes:
* **extended** = [true|false], *optional*, if true only visible in landscape mode, defaults to false;
* **fill** = [true|false], *optional*, if true button will expand to use all available space, defaults to false;
* **width** = [width in kterm units], *optional*, 1000 is standard width, 2000 will be double width key and so on; defaults to 1000;
* **obey-caps** = [true|false], *optional*, should button change on caps lock press, defaults to false;
* **\<default\>** - default variant (no modifier)
* **\<shifted\>** - shifted variant (shift/caps lock modifier pressed)
* **\<mod1\>** - mod1 variant (mod1 modifier pressed)
* **\<mod2\>** - mod2 variant (mod2 modifier pressed)
* **\<mod3\>** - mod3 variant (mod3 modifier pressed)
* attributes for all variant nodes (default, shifted, …):
* **display** = [character|image\:/path/to/image], *required*, character to display or image path (absolute must start with slash, otherwise relative to config);
* **action** = [character|special name|modifier\:name], *required for keys with image label, modifiers, special buttons*, character sent to terminal, name of special action, or name of modifier, defaults to *display* attribute value;


* Command line options:
```
$ ./kterm -h
Usage: kterm [OPTIONS]
-c <0|1> color scheme (0 light, 1 dark)
-d debug mode
-e <command> execute command in kterm
-E <var> set environment variable
-f <family> font family
-h show this message
-k <0|1> keyboard off/on
-l <path> keyboard layout config path
-s <size> font size
-v print version and exit
```

* Binary packages for Kindle Touch/Paperwhite are available at http://www.fabiszewski.net/kindle-terminal/

* GPL license


3 changes: 0 additions & 3 deletions layouts/keyboard-kt.xml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- default keyboard layout for kindle touch -->
<keyboard>
<options>
<!-- not yet implemented -->
</options>
<layout id="kt keyboard">
<row>
<key fill="true">
Expand Down

0 comments on commit 00b9df5

Please sign in to comment.