Cagebreakのソースを表示

[[Category:Wayland compositors]]
[[en:Cagebreak]]
{{Related articles start}}
{{Related|Wayland#コンポジタ}}
{{Related|ウィンドウマネージャ}}
{{Related articles end}}

[https://github.com/project-repo/cagebreak Cagebreak] is a tiling compositor for [[wayland]], based on {{Pkg|cage}} and inspired by [[ratpoison]], which is easily
controlled through the keyboard and a unix domain socket.

== Installation ==

[[Install]] {{AUR|cagebreak}} or
{{AUR|cagebreak-bin}}. Alternatively, download a
[https://github.com/project-repo/cagebreak/releases/latest release tarball] or
clone the [https://github.com/project-repo/cagebreak repository].

=== Optional dependencies ===

* {{Pkg|wl-clipboard}} for copy/paste capabilities
* {{Pkg|xorg-xwayland}} for allowing [[Xorg]] applications to run under cagebreak

== Configuration ==

The general configuration for cagebreak is located in {{ic|$XDG_CONFIG_PATH/cagebreak/config}}. This defaults to {{ic|~/.config/cagebreak/config}}. 

Read the [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md configuration man page] for detailed information. Note that you can also add configuration by using [[#Interaction through socket]].

An example configuration file may be found on [https://github.com/project-repo/cagebreak/tree/master/examples/config Github].

== Usage ==

Start cagebreak like any other binary.

=== Getting started ===

The following is an example of how to install and use cagebreak with the configuration file provided on [https://github.com/project-repo/cagebreak/tree/master/examples/config Github].

# Install {{ic|cagebreak}} as per [[#Installation]]. You should use {{AUR|cagebreak-bin}} unless you have reasons to do otherwise.
# Copy the example configuration from [https://github.com/project-repo/cagebreak/tree/master/examples/config Github] to {{ic|$XDG_CONFIG_PATH/cagebreak/config}}. Documentation is provided in the [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md configuration man page].
# Install {{ic|xterm}} or replace {{ic|xterm}} with your preferred terminal emulator in the configuration file.
# Run the following command or add it to {{ic|~/.bash_profile}} to run cagebreak on login (see [[#Keyboard layout]] and [[#Firefox]] for explanation):
#*  {{ic|MOZ_USE_WAYLAND&#61;1 GDK_BACKEND&#61;wayland XKB_DEFAULT_LAYOUT&#61;us cagebreak}}
# Cagebreak should start up and display the terminal emulator you specified above. Press {{ic|C-t}} {{ic|t}} to open a new terminal or {{ic|C-t}} {{ic|S}} to split the screen. You can also use {{ic|Alt-<number>}} to switch to the workspace {{ic|<number>}}. For a full list of available keybindings, read the configuration file and the [https://github.com/project-repo/cagebreak/tree/master/man/cagebreak-config.5.md documentation].
# If you wish, you may also interact with cagebreak using the unix domain socket. See [[#Interaction through socket]] for further information.
# Also, please file any bugs you may find:
#* [https://github.com/project-repo/cagebreak/issues/ Github issue tracker] or via email as per [https://github.com/project-repo/cagebreak/blob/master/README.md the readme] for cagebreak
#* AUR comments for the {{AUR|cagebreak-bin}} and {{AUR|cagebreak}} PKGBUILDs

=== Keyboard layout ===

Set the environment variable {{ic|XKB_DEFAULT_LAYOUT}} to the desired keyboard layout. See the [https://github.com/project-repo/cagebreak/blob/master/man/cagebreak.1.md#environment man page] for further information.

=== Interaction through socket ===

On startup, cagebreak opens a unix domain socket through which interaction with the compositor is possible
at run-time. The path to this socket is stored in the {{ic|CAGEBREAK_SOCKET}} environment variable.
For example, {{Pkg|openbsd-netcat}} may be invoked with:

 $ nc -U $CAGEBREAK_SOCKET

to send cagebreak any configuration while it is running. The syntax is identical to the syntax of the configuration file.

== See also ==

# [https://github.com/project-repo/cagebreak github]
# [https://github.com/project-repo/cagebreak/wiki github wiki]
# [https://github.com/project-repo/cagebreak-pkgbuild pkgbuild on github]