svkbd

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

svkbd.1 (3795B)

      1 .Dd March 15, 2021
      2 .Dt SVKBD 1
      3 .Os
      4 .Sh NAME
      5 .Nm svkbd
      6 .Nd simple virtual keyboard
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Op Fl D
     10 .Op Fl d
     11 .Op Fl g Ar geometry
     12 .Op Fl fn Ar font
     13 .Op Fl O
     14 .Op Fl h
     15 .Op Fl H Ar heightfactor
     16 .Op Fl l Ar layers
     17 .Op Fl s Ar layer
     18 .Op Fl v
     19 .Sh DESCRIPTION
     20 .Nm
     21 is a simple virtual keyboard for X.org, intended to be used in environments, where no
     22 keyboard is available.
     23 .Sh OPTIONS
     24 .Bl -tag -width Ds
     25 .It Fl D
     26 Debug mode; output verbosely to stderr.
     27 .It Fl d
     28 Set the _NET_WM_WINDOW_TYPE_DOCK property to hint windowmanagers it is
     29 dockable, by default off.
     30 .It Fl fn Ar font
     31 Defines the font or font set used. e.g. "Monospace:bold:size=20" (an Xft font).
     32 .It Fl g Ar geometry
     33 Adjust the initial window position or size as specified by the standard X11
     34 geometry format.
     35 .It Fl h
     36 Show the usage information.
     37 .It Fl H Ar heightfactor
     38 Affects the vertical space taken by the keyboard.
     39 One row of keys takes up 1/heighfactor of the screen's total height.
     40 .It Fl l Ar layers
     41 Comma separated list of layers to enable (by name). If not set, all layers
     42 in the layout will be available.
     43 The layer names are defined by the layout you compiled.
     44 .It Fl n
     45 Do not simulate key presses for X
     46 .It Fl R
     47 Disable press-on-release
     48 .It Fl s Ar layer
     49 The layer to show on program start-up (by name). If not set, the first
     50 layer of the layout will be shown.
     51 .It Fl O
     52 Disable overlay functionality.
     53 .It Fl o
     54 Print pressed keys to standard output
     55 .It Fl v
     56 Show the version information.
     57 .El
     58 .Sh ENVIRONMENT
     59 The following environment variables can be defined, providing
     60 an alternative to some of the command line parameters.
     61 The command line parameters, however, always take precedence:
     62 .Bl -tag -width Ds
     63 .It Ev SVKBD_LAYERS
     64 Comma separated list of layers to enable (by name). The layer names are defined by the layout
     65 you compiled.
     66 .It Ev SVKBD_ENABLEOVERLAYS
     67 Set this to 0 if you want to disable overlay functionality.
     68 .It Ev SVKBD_HEIGHTFACTOR
     69 Affects the vertical space taken by the keyboard.
     70 One row of keys takes up 1/heighfactor of the screen's total height.
     71 .El
     72 .Sh XRESOURCES
     73 The appearance of svkbd can be configured via xresources:
     74 .Bl -tag -width Ds
     75 .It Ev svkbd.font
     76 An Xft font specification like "Monospace:bold:size=20".
     77 .It Ev svkbd.background
     78 The background colour for the keycaps (in #rrggbb syntax)
     79 .It Ev svkbd.foreground
     80 The foreground colour for the keycaps (in #rrggbb syntax)
     81 .It Ev svkbd.shiftforeground
     82 The foreground colour for the secondary labels (shift layer) on the keycaps
     83 .It Ev svkbd.shiftbackground
     84 The background colour for the secondary labels (shift layer) on the keycaps
     85 .It Ev svkbd.abcforeground
     86 .It Ev svkbd.abcbackbround
     87 The colour for alphabetical keys
     88 .It Ev svkbd.abcshiftbackground
     89 .It Ev svkbd.abcshiftforeground
     90 The colour for the secondary labels (shift layer) on alphabetical keys
     91 .It Ev svkbd.pressforeground
     92 .It Ev svkbd.pressforebackground
     93 The colour for keys when held pressed
     94 .It Ev svkbd.highlightforeground
     95 .It Ev svkbd.highlightforebackground
     96 The colour for keys when hovering over them or just after release
     97 .It Ev svkbd.highlightshiftforeground
     98 .It Ev svkbd.highlightshiftforebackground
     99 The colour for the secondary label on keys when hovering over them or just
    100 after release
    101 .It Ev svkbd.overlayforeground
    102 .It Ev svkbd.overlaybackground
    103 The colour for keys when they are part of an overlay
    104 .It Ev svkbd.overlayshiftforeground
    105 .It Ev svkbd.overlayshiftbackground
    106 The colour for the secondary label on keys when they are part of an overlay
    107 .El
    108 .Sh EXIT STATUS
    109 .Ex -std
    110 .Sh SEE ALSO
    111 .Xr XParseGeometry 3
    112 .Sh AUTHORS
    113 .An Christoph Lohmann Aq Mt 20h@r-36.net
    114 .An Enno Boland Aq Mt gottox@s01.de
    115 .An Miles Alan Aq Mt m@milesalan.com
    116 .An Maarten van Gompel Aq Mt proycon@anaproy.nl
    117 .An Tetrakist Aq Mt tetrakist@mutandum.com
    118 .An Stacy Aq Mt stacy@stacyharper.net