svkbd - simple virtual keyboard


SVKBD(1) General Commands Manual SVKBD(1)

NAME

svkbd — simple virtual keyboard

SYNOPSIS

svkbd [−D] [−d] [−g geometry] [−fn font] [−O] [−h] [−H heightfactor] [−l layers] [−s layer] [−v]

DESCRIPTION

svkbd is a simple virtual keyboard for X.org, intended to be used in environments, where no keyboard is available.

OPTIONS
−D

Debug mode; output verbosely to stderr.

−d

Set the _NET_WM_WINDOW_TYPE_DOCK property to hint windowmanagers it is dockable, by default off.

−fn font

Defines the font or font set used. e.g. "Monospace:bold:size=20" (an Xft font).

−g geometry

Adjust the initial window position or size as specified by the standard X11 geometry format.

−h

Show the usage information.

−H heightfactor

Affects the vertical space taken by the keyboard. One row of keys takes up 1/heighfactor of the screen’s total height.

−l layers

Comma separated list of layers to enable (by name). If not set, all layers in the layout will be available. The layer names are defined by the layout you compiled.

−n

Do not simulate key presses for X

−R

Disable press-on-release

−s layer

The layer to show on program start-up (by name). If not set, the first layer of the layout will be shown.

−O

Disable overlay functionality.

−o

Print pressed keys to standard output

−v

Show the version information.

ENVIRONMENT

The following environment variables can be defined, providing an alternative to some of the command line parameters. The command line parameters, however, always take precedence:

SVKBD_LAYERS

Comma separated list of layers to enable (by name). The layer names are defined by the layout you compiled.

SVKBD_ENABLEOVERLAYS

Set this to 0 if you want to disable overlay functionality.

SVKBD_HEIGHTFACTOR

Affects the vertical space taken by the keyboard. One row of keys takes up 1/heighfactor of the screen’s total height.

XRESOURCES

The appearance of svkbd can be configured via xresources:

svkbd.font

An Xft font specification like "Monospace:bold:size=20".

svkbd.background

The background colour for the keycaps (in #rrggbb syntax)

svkbd.foreground

The foreground colour for the keycaps (in #rrggbb syntax)

svkbd.shiftforeground

The foreground colour for the secondary labels (shift layer) on the keycaps

svkbd.shiftbackground

The background colour for the secondary labels (shift layer) on the keycaps

svkbd.abcforeground

svkbd.abcbackbround

The colour for alphabetical keys

svkbd.abcshiftbackground

svkbd.abcshiftforeground

The colour for the secondary labels (shift layer) on alphabetical keys

svkbd.pressforeground

svkbd.pressforebackground

The colour for keys when held pressed

svkbd.highlightforeground

svkbd.highlightforebackground

The colour for keys when hovering over them or just after release

svkbd.highlightshiftforeground

svkbd.highlightshiftforebackground

The colour for the secondary label on keys when hovering over them or just after release

svkbd.overlayforeground

svkbd.overlaybackground

The colour for keys when they are part of an overlay

svkbd.overlayshiftforeground

svkbd.overlayshiftbackground

The colour for the secondary label on keys when they are part of an overlay

EXIT STATUS

The svkbd utility exits 0 on success, and >0 if an error occurs.

SEE ALSO

XParseGeometry(3)

AUTHORS

Christoph Lohmann <[email protected]>
Enno Boland <[email protected]>
Miles Alan <[email protected]>
Maarten van Gompel <[email protected]>
Tetrakist <[email protected]>
Stacy <[email protected]> GNU March 15, 2021 SVKBD(1)


Updated 2024-01-29 - jenkler.se | uex.se