Frequently Asked Questions

How do I do a particular thing with cagebreak?

Check the man pages
- cagebreak config (probably where you find the answer)
- cagebreak (command line options etc.)
- cagebreak-socket (socket information, mostly useful for scritping)
Check the rest of this FAQ
Open an issue or otherwise get in touch with the development team (See section Email Contact in SECURITY.md).

Note that the feature set of cagebreak is intentionally limited.

Remapping Caps Lock globally seems to be the best option. Follow instructions here to achieve this (should be roughly distribution-agnostic).

Set the following environment variables

to activate wayland support for firefox.

There are multiple ways to launch external programs in cagebreak.

Using a terminal emulator is a perfectly valid way to launch applications. If you want to be able to close the terminal you used to start the program, you may use &disown, which should be available in every shell.
Using the exec command in the cagebreak config, it is possible to launch programs when cagebreak is started. Moreover, as this command can be combined with commands such as bind, it can be used to create custom keybindings which execute external programs. (See also the man page cagebreak-config).
All commands mentioned previously are also available over the socket which allows the creation of (arbitrary) keybindings on the fly and a fortiori keybindings running arbitrary commands.

Consider opening an issue on github or getting in touch with the development team (See section Email Contact in SECURITY.md).