A Wayland kiosk
Find a file
Frank Seifferth 4934225759 Add command line switches to disable pointer and touch
I am using a wireless keyboard with an integrated touchpad.
I do neither need nor want the touchpad, but I am unable to
attach the keyboard only (without the pointer device) to my
computer. I therefore find it convenient to simply disable
that device when starting `cage`. The switch for disabling
touch input is there for consistency. Maybe it comes in handy
to someone else at some point.

I don't have any previous experience with wayland, so there is
a chance that I simply missed some environment variable that
accomplishes the same. In this case, this commit would be
unnecessary.

The command line switches `P` and `T` are quite ad-hoc. I probably
would have gone for `--disable-pointer` and `--disable-touch` if
long command line switches had already been in use. If someone has
a better idea than `P` and `T`, please suggest it.
2021-05-30 15:08:26 +02:00
.builds CI: bump wlroots version to 0.13.0 2021-04-09 19:33:14 +02:00
contrib Include release scripts 2021-04-16 14:34:57 +02:00
.clang-format Add clang-format file 2020-02-18 21:20:23 +01:00
cage.1.scd Add command line switches to disable pointer and touch 2021-05-30 15:08:26 +02:00
cage.c Add command line switches to disable pointer and touch 2021-05-30 15:08:26 +02:00
config.h.in cage: add -v argument to print version 2020-01-26 18:18:49 +01:00
idle_inhibit_v1.c Apply clang-format 2020-02-18 21:20:23 +01:00
idle_inhibit_v1.h Replace all wayland-server.h includes with wayland-server-core.h 2019-12-20 17:16:53 +01:00
LICENSE Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
meson.build Update version to 0.1.3 2021-04-16 14:01:38 +02:00
meson_options.txt Add man page. (#141) 2020-05-31 15:14:18 +02:00
output.c output: chase swaywm/wlroots@cc56b4f073 2021-04-09 19:33:14 +02:00
output.h output: chase swaywm/wlroots@cc56b4f073 2021-04-09 19:33:14 +02:00
README.md Add man page. (#141) 2020-05-31 15:14:18 +02:00
render.c xdg_shell: chase swaywm/wlroots@07111828c5 2021-04-09 19:33:14 +02:00
render.h Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
seat.c Add command line switches to disable pointer and touch 2021-05-30 15:08:26 +02:00
seat.h Implement support for wlr_keyboard_group (#123) 2020-02-21 21:19:12 +01:00
server.h Add command line switches to disable pointer and touch 2021-05-30 15:08:26 +02:00
util.c Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
util.h Refactor surface damaging and rendering code 2020-01-11 17:07:33 +01:00
view.c xdg_shell: chase swaywm/wlroots@07111828c5 2021-04-09 19:33:14 +02:00
view.h xdg_shell: chase swaywm/wlroots@07111828c5 2021-04-09 19:33:14 +02:00
xdg_shell.c xdg_shell: chase swaywm/wlroots@07111828c5 2021-04-09 19:33:14 +02:00
xdg_shell.h Replace all wayland-server.h includes with wayland-server-core.h 2019-12-20 17:16:53 +01:00
xwayland.c xdg_shell: chase swaywm/wlroots@07111828c5 2021-04-09 19:33:14 +02:00
xwayland.h Don’t terminate display when no view is found (#132) 2020-03-16 20:32:24 +01:00

Cage: a Wayland kiosk builds.sr.ht status

Cage's logo

This is Cage, a Wayland kiosk. A kiosk runs a single, maximized application.

This README is only relevant for development resources and instructions. For a description of Cage and installation instructions for end-users, please see its project page and the Wiki.

Release signatures

Releases are signed with 6EBC43B1 and published on GitHub.

Building and running Cage

You can build Cage with the meson build system. It requires wayland, wlroots, and xkbcommon to be installed. Optionally, install scdoc for manual pages. Note that Cage is developed against the latest tag of wlroots, in order to not constantly chase breaking changes as soon as they occur.

Simply execute the following steps to build Cage:

$ meson build
$ ninja -C build

By default, this builds a debug build. To build a release build, use meson build --buildtype=release.

Cage comes with compile-time support for XWayland. To enable this, first make sure that your version of wlroots is compiled with this option. Then, add -Dxwayland=true to the meson command above. Note that you'll need to have the XWayland binary installed on your system for this to work.

You can run Cage by running ./build/cage APPLICATION. If you run it from within an existing X11 or Wayland session, it will open in a virtual output as a window in your existing session. If you run it at a TTY, it'll run with the KMS+DRM backend. In debug mode (default build type with Meson), press Alt+Esc to quit. For more configuration options, see Configuration.

Cage is based on the annotated source of tinywl and rootston.

Bugs

For any bug, please create an issue on GitHub.

License

Please see LICENSE on GitHub.

Copyright © 2018-2020 Jente Hidskes dev@hjdskes.nl