svkbd

simple virtual keyboard
git clone git://git.suckless.org/svkbd
Log | Files | Refs | README | LICENSE

README.md (3667B)


      1 SVKBD: Simple Virtual Keyboard
      2 =================================
      3 
      4 This is a simple virtual keyboard, intended to be used in environments,
      5 where no keyboard is available.
      6 
      7 Installation
      8 ------------
      9 
     10 	$ make
     11 	$ make install
     12 
     13 This will create by default `svkbd-intl`, which is svkbd using an international
     14 layout with multiple layers and overlays, and optimised for mobile devices.
     15 
     16 You can create svkbd for additional layouts by doing:
     17 
     18 	$ make LAYOUT=$layout
     19 
     20 This will take the file `layout.$layout.h` and create `svkbd-$layout`.
     21 `make install` will then pick up the new file and install it accordingly.
     22 
     23 Layouts
     24 ---------
     25 
     26 The following layouts are available:
     27 
     28 * **Mobile Layouts:**
     29     * ``mobile-intl`` - A small international layout optimised for mobile devices. This layout consists of multiple layers which
     30         can be switched on the fly, and overlays that appear on long-press of certain keys, adding input ability for
     31         diacritics and other variants, as well as some emoji. The layers are:
     32         * a basic qwerty layer
     33         * a layer for numeric input, arrows, and punctuation
     34         * a layer for function keys, media keys, and arrows
     35         * a cyrillic layer (ЙЦУКЕН)
     36         * a dialer/numeric layer
     37     * ``mobile-plain`` - This is a plain layout with only a qwerty layer and numeric/punctuation layer. It was
     38         originally made for [sxmo](https://sr.ht/~mil/Sxmo/).
     39 * **Traditional layouts**:
     40     * ``en`` - An english layout without layers (QWERTY)
     41     * ``de`` - A german layout (QWERTZ)
     42     * ``ru`` - A russian layout (ЙЦУКЕН)
     43     * ``sh`` - A serbo-croatian layout using latin script (QWERTZ)
     44 
     45 Usage
     46 -----
     47 
     48 	$ svkbd-mobile-intl
     49 
     50 This will open svkbd at the bottom of the screen, showing the default
     51 international layout.
     52 
     53 	$ svkbd-mobile-intl -d
     54 
     55 This tells svkbd to announce itself being a dock window, which then
     56 is managed differently between different window managers. If using dwm
     57 and the dock patch, then this will make svkbd being managed by dwm and
     58 some space of the screen being reserved for it.
     59 
     60 	$ svkbd-mobile-intl -g 400x200+1+1
     61 
     62 This will start svkbd-intl with a size of 400x200 and at the upper left
     63 window corner.
     64 
     65 For layouts that consist of multiple layers, you can enable layers on program start through either the ``-l`` flag or
     66 through the ``SVKBD_LAYERS`` environment variable.  They both take a comma separated list of layer names (as defined in
     67 your ``layout.*.h``). Use the ``↺`` button in the bottom-left to cycle through all the layers.
     68 
     69 Some layouts come with overlays that will show when certain keys are hold pressed for a longer time. For
     70 example, a long press on the ``a`` key will enable an overview showing all kinds of diacritic combinations for ``a``.
     71 
     72 Overlay functionality interferes with the ability to hold a key and have it outputted repeatedly.  You can disable
     73 overlay functionality with the ``-O`` flag or by setting the environment variable ``SVKBD_ENABLEOVERLAYS=0``. There is
     74 also a key on the function layer of the keyboard itself to enable/disable this behaviour on the fly. Its label shows
     75 ``≅`` when the overlay functionality is enabled and ``≇`` when not.
     76 
     77 Notes
     78 ---------
     79 
     80 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.
     81 
     82 If you use another XKB layout you will get unpredictable output that does not match the labels on the virtual keycaps!
     83 
     84 Repository
     85 ----------
     86 
     87 	git clone https://git.suckless.org/svkbd