.\" Generated by scdoc  1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "cagebreak" "1" "2023-08-18" "Version 2.2.1" "Cagebreak Manual"
.P
.SH NAME
.P
cagebreak - A Wayland tiling compositor
.P
.SH SYNOPSIS
.P
\fBcagebreak\fR [OPTIONS]
.P
.SH DESCRIPTION
.P
cagebreak is a slim, keyboard-controlled, tiling compositor for
wayland conceptually based on the X11 window manager ratpoison.\&
.P
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.\&
.P
All interactions between the user and cagebreak are done via
the keyboard.\&
.P
Configuration of this behaviour is specified in the
\fB$XDG_CONFIG_PATH/cagebreak/config\fR file (See \fBcagebreak-config(5)\fR).\&
.P
Scripting support is provided through the IPC
socket specified in the environment variable \fB$CAGEBREAK_SOCKET\fR.\&
The syntax accepted through this socket is identical to
that of the configuration file (see \fBcagebreak-config(5)\fR).\&
Errors which occur during interaction over IPC channel
are displayed in a message box at the top right of the screen.\&
.P
.SH OPTIONS
.P
\fB-c <path>\fR
.RS 4
Load configuration file from <path>
.P
.RE
\fB-e\fR
.RS 4
Enable socket
.P
.RE
\fB-h\fR
.RS 4
Display help message and exit
.P
.RE
\fB-s\fR
.RS 4
Show all available inputs and outputs
.P
.RE
\fB-v\fR
.RS 4
Show version number and exit
.P
.RE
\fB--bs\fR
.RS 4
"bad security".\& Enable features with potential security implications.\&
Currently, this option has the following effects (possible implications
in parentheses):
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Print view titles in `dump` output (an attacker may be able to read sensitive information contained in the view title).\&

.RE
.P
.RE
.SH ENVIRONMENT
.P
\fBCAGEBREAK_SOCKET\fR
.RS 4
The IPC unix domain socket address accepting
commands as specified in \fBcagebreak-config(5)\fR
.P
.RE
\fBXKB_DEFAULT_LAYOUT\fR
.RS 4
The keyboard layout to be used (See \fBxkeyboard-config(7)\fR)
.P
.RE
\fBXKB_DEFAULT_MODEL\fR
.RS 4
The keyboard model to be used (See \fBxkeyboard-config(7)\fR)
.P
.RE
\fBXKB_DEFAULT_VARIANT\fR
.RS 4
The keyboard variant to be used (See \fBxkeyboard-config(7)\fR)
.P
.RE
\fBXKB_DEFAULT_RULES\fR
.RS 4
The xkb rules to be used
.P
.RE
\fBXKB_DEFAULT_OPTIONS\fR
.RS 4
The xkb options to be used
.P
.RE
.SH SEE ALSO
.P
\fBcagebreak-config(5)\fR
\fBcagebreak-socket(7)\fR
.P
.SH BUGS
.P
See GitHub Issues: <https://github.\&com/project-repo/cagebreak/issues>
.P
Mail contact: `cagebreak @ project-repo .\& co`
.P
GPG Fingerprints:
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
B15B92642760E11FE002DE168708D42451A94AB5
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
F8DD9F8DD12B85A28F5827C4678E34D2E753AA3C
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
3ACEA46CCECD59E4C8222F791CBEB493681E8693
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
0A268C188D7949FEB39FD1462F2AD980247E4918

.RE
.P
.SH LICENSE
.P
Copyright (c) 2020-2023 The Cagebreak authors
.P
Copyright (c) 2018-2020 Jente Hidskes
.P
Copyright (c) 2019 The Sway authors
.P
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 Software is furnished to do
so, subject to the following conditions:
.P
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.\&
.P
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
LIABILITY, 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.\&
