SVKBD(1)

🎀 NAME 🎀

svkbd — simple virtual keyboard. This is the svkbd(1) page from the General Commands Manual, and bestie, we're about to get into it 💖

✨ 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. It's meant for environments where no keyboard is available — literally the save when you have no physical keys to press. 🦋

🦋 OPTIONS 🦋

• -D — debug mode; output verbosely to stderr. It's giving diagnostics, bestie. 🔥
• -d — sets 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. helpful icon behavior. 🫶
• -H heightfactor — affects the vertical space taken by the keyboard. One row of keys takes up 1/heighfactor of the screen's total height. math but make it keyboard. 🌸
• -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. that's it, that's the tweet. 💀
• -R — disable press-on-release. no press-on-release energy. 🙈
• -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. overlays? not today. 💅
• -o — print pressed keys to standard output. spill the tea to stdout. 🍓
• -v — show the version information. 👑

🌸 ENVIRONMENT 🌸

You can define these environment variables as an alternative to some of the command line parameters. The command line parameters always take precedence, though — they win, no cap. 💅

• 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 — make it cute:

• 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 — the colour for alphabetical keys. 🔤
• svkbd.abcbackbround — the colour for alphabetical keys. Spelled exactly like that in the page, bestie — copy it as-is 💅
• svkbd.abcshiftbackground — the colour for the secondary labels (shift layer) on alphabetical keys. 🦋
• svkbd.abcshiftforeground — the colour for the secondary labels (shift layer) on alphabetical keys. 🦋
• svkbd.pressforeground — the colour for keys when held pressed. 🫳
• svkbd.pressforebackground — the colour for keys when held pressed. 🫳
• svkbd.highlightforeground — the colour for keys when hovering over them or just after release. 🖱️
• svkbd.highlightforebackground — the colour for keys when hovering over them or just after release. 🖱️
• svkbd.highlightshiftforeground — the colour for the secondary label on keys when hovering over them or just after release. ✨
• svkbd.highlightshiftforebackground — the colour for the secondary label on keys when hovering over them or just after release. ✨
• svkbd.overlayforeground — the colour for keys when they are part of an overlay. 🧚
• svkbd.overlaybackground — the colour for keys when they are part of an overlay. 🧚
• svkbd.overlayshiftforeground — the colour for the secondary label on keys when they are part of an overlay. 👑
• svkbd.overlayshiftbackground — the colour for the secondary label on keys when they are part of an overlay. 👑

🚪 EXIT STATUS 🚪

svkbd exits 0 on success, and >0 if an error occurs. So zero is the slay outcome; anything above zero means an error showed up 😭

👀 SEE ALSO 👀

• XParseGeometry(3) — the one and only see-also, bestie. 🌟

👑 AUTHORS 👑

The icons who built this:

• Christoph Lohmann <20h@r-36.net>
• Enno Boland <gottox@s01.de>
• Miles Alan <m@milesalan.com>
• Maarten van Gompel <proycon@anaproy.nl>
• Tetrakist <tetrakist@mutandum.com>
• Stacy <stacy@stacyharper.net>

xoxo bestie — this page is from Debian, dated March 15, 2021, and it's the SVKBD(1) manual page. now go be a virtual-keyboard main character 💅✨