home | help 
cagebreak(1)			Cagebreak Manual		    cagebreak(1)

NAME
     cagebreak - A Wayland tiling compositor

SYNOPSIS
     cagebreak [OPTIONS]

DESCRIPTION
     cagebreak	is  a  slim,  keyboard-controlled, tiling compositor for wayland
     conceptually based on the X11 window manager ratpoison.

     It allows for the screen to be split into	non-overlapping  tiles	and,  in
     contrast  to the original ratpoison, has native support for multi-workspace
     operation.

     All interactions between the user and cagebreak are done via the keyboard.

     Configuration of this behaviour is specified in the  $XDG_CONFIG_PATH/cage-
     break/config file (See cagebreak-config(5)).

     Scripting support is provided through the IPC socket specified in the envi-
     ronment variable $CAGEBREAK_SOCKET. The syntax accepted through this socket
     is  identical  to that of the configuration file (see cagebreak-config(5)).
     Errors which occur during interaction over IPC channel are displayed  in  a
     message box on the screen.

OPTIONS
     -c <path>
	 Load configuration file from <path>

     -e
	 Enable socket

     -h
	 Display help message and exit

     -s
	 Show all available inputs and outputs

     -v
	 Show version number and exit

     --bs
	 "bad  security".  Enable features with potential security implications.
	 Currently, this option has the following effects (possible implications
	 in parentheses):
	 *   Print view titles in `dump` output (an attacker may be able to read
	     sensitive information contained in the view title).

ENVIRONMENT
     CAGEBREAK_SOCKET
	 The IPC unix domain socket address accepting commands as  specified  in
	 cagebreak-config(5)

     XKB_DEFAULT_LAYOUT
	 The keyboard layout to be used (See xkeyboard-config(7))

     XKB_DEFAULT_MODEL
	 The keyboard model to be used (See xkeyboard-config(7))

     XKB_DEFAULT_VARIANT
	 The keyboard variant to be used (See xkeyboard-config(7))

     XKB_DEFAULT_RULES
	 The xkb rules to be used

     XKB_DEFAULT_OPTIONS
	 The xkb options to be used

SEE ALSO
     cagebreak-config(5) cagebreak-socket(7)

BUGS
     See GitHub Issues: <https://github.com/project-repo/cagebreak/issues>

     Mail contact: `cagebreak @ project-repo . co`

     GPG Fingerprints:

     *	 846FCCA537A3FB114202B85C513248B63C1C3BEB

LICENSE
     Copyright (c) 2020-2024 The Cagebreak authors

     Copyright (c) 2018-2020 Jente Hidskes

     Copyright (c) 2019 The Sway authors

     Permission  is  hereby  granted,  free of charge, to any person obtaining a
     copy of this software and associated documentation files (the  "Software"),
     to  deal  in the Software without restriction, including without limitation
     the rights to use, copy, modify, merge,  publish,	distribute,  sublicense,
     and/or sell copies of the Software, and to permit persons to whom the Soft-
     ware is furnished to do so, subject to the following conditions:

     The  above copyright notice and this permission notice shall be included in
     all copies or substantial portions of the Software.

     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  OR
     IMPLIED,  INCLUDING  BUT  NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIA-
     BILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING  FROM,
     OUT  OF  OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
     THE SOFTWARE.

Version 3.2.1			   2026-06-06			    cagebreak(1)
home | help