commit a11f68e8a177e91313e91e741acda33792543af2
parent b80974c5d1d28b5bc0e6971da6d0cf7a403e5898
Author: Job Bautista <jobbautista9@protonmail.com>
Date: Fri, 14 Aug 2020 19:13:49 +0800
Update svkbd description based on svkbd's README.md
Replaced instances of svkbd-en with svkbd-mobile-intl, which is the new default
Added a list of layouts
Expanded the Usage section
Added a short description of svkbd
Credits to svkbd developers for the original README.md where this change is based on
Diffstat:
1 file changed, 51 insertions(+), 8 deletions(-)
diff --git a/tools.suckless.org/x/svkbd/index.md b/tools.suckless.org/x/svkbd/index.md
@@ -1,5 +1,5 @@
-SVKBD
-=====
+SVKBD: Simple Virtual Keyboard
+=================================
This is a simple virtual keyboard, intended to be used in environments,
where no keyboard is available.
@@ -9,25 +9,49 @@ Installation
$ make
$ make install
-This will create by default `svkbd-en`, which is svkbd using an English
-keyboard layout. You can create svkbd for additional layouts by doing:
+This will create by default `svkbd-mobile-intl`, which is svkbd using an international
+keyboard layout with multiple layers and overlays, and optimised for mobile devices.
+
+You can create svkbd for additional layouts by doing:
$ make LAYOUT=$layout
This will take the file `layout.$layout.h` and create `svkbd-$layout`.
`make install` will then pick up the new file and install it accordingly.
+Layouts
+---------
+
+The following layouts are available:
+
+* **Mobile Layouts:**
+ * ``mobile-intl`` - A small international layout optimised for mobile devices. This layout consists of multiple layers which
+ can be switched on the fly, and overlays that appear on long-press of certain keys, adding input ability for
+ diacritics and other variants, as well as some emoji. The layers are:
+ * a basic qwerty layer
+ * a layer for numeric input, arrows, and punctuation
+ * a layer for function keys, media keys, and arrows
+ * a cyrillic layer (ЙЦУКЕН)
+ * a dialer/numeric layer
+ * ``mobile-plain`` - This is a plain layout with only a qwerty layer and numeric/punctuation layer. It was
+ originally made for [sxmo](https://sr.ht/~mil/Sxmo/).
+* **Traditional layouts**:
+ * ``en`` - An english layout without layers (QWERTY)
+ * ``de`` - A german layout (QWERTZ)
+ * ``ru`` - A russian layout (ЙЦУКЕН)
+ * ``sh`` - A serbo-croatian layout using latin script (QWERTZ)
+
Usage
-----
- $ svkbd-en
+ $ svkbd-mobile-intl
This will open svkbd at the bottom of the screen, showing the default
-English layout.
+international layout.
- $ svkbd-en -d
+ $ svkbd-mobile-intl -d
-This tells svkbd-en to announce itself being a dock window, which then
+This tells svkbd to announce itself being a dock window, which then
is managed differently between different window managers. If using dwm
and the dock patch, then this will make svkbd being managed by dwm and
some space of the screen being reserved for it.
@@ -37,6 +61,25 @@ some space of the screen being reserved for it.
This will start svkbd-en with a size of 400x200 and at the upper left
window corner.
+For layouts that consist of multiple layers, you can enable layers on program start through either the ``-l`` flag or
+through the ``SVKBD_LAYERS`` environment variable. They both take a comma separated list of layer names (as defined in
+your ``layout.*.h``). Use the ``↺`` button in the bottom-left to cycle through all the layers.
+
+Some layouts come with overlays that will show when certain keys are hold pressed for a longer time. For
+example, a long press on the ``a`` key will enable an overview showing all kinds of diacritic combinations for ``a``.
+
+Overlay functionality interferes with the ability to hold a key and have it outputted repeatedly. You can disable
+overlay functionality with the ``-O`` flag or by setting the environment variable ``SVKBD_ENABLEOVERLAYS=0``. There is
+also a key on the function layer of the keyboard itself to enable/disable this behaviour on the fly. Its label shows
+``≅`` when the overlay functionality is enabled and ``≇`` when not.
+
+Notes
+---------
+
+This virtual keyboard does not actually modify the X keyboard layout, the ``mobile-intl``, ``mobile-plain`` and ``en`` layouts simply rely on a standard US QWERTY layout (setxkbmap us) being activated, the other layouts (``de``, ``ru``, ``sh``) require their respective XKB keymaps to be active.
+
+If you use another XKB layout you will get unpredictable output that does not match the labels on the virtual keycaps!
+
Repository
----------
