ceos/cagebreak
1
0
Fork 0
mirror of https://cagebreak.project-repo.co/cagebreak.git synced 2026-08-23 05:54:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add ipc documentation

Browse source
This commit is contained in:
Cagebreak Signing Key 1 2020-05-25 21:01:27 +02:00
commit 43b06932d7
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
man/cagebreak.1.md
View file

@ -18,10 +18,16 @@ 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/cagebreak/config** file (See **cagebreak-config(5)**).
the keyboard.
## OPTIONS
Configuration of this behaviour is specified in the
**\$XDG_CONFIG_PATH/cagebreak/config** file (See **cagebreak-config(5)**).
Scripting support is provided through the inter process communication
socket **\$CAGEBREAK_SOCKET**.
Errors are displayed in the top right corner of the screen.
# OPTIONS
-h
@ -37,6 +43,11 @@ in the **\$XDG_CONFIG_PATH/cagebreak/config** file (See **cagebreak-config(5)**)
# ENVIRONMENT
`CAGEBREAK_SOCKET`
: The inter process communication unix domain socket address accepting
everything specified in **cagebreak-config(5)**
`XKB_DEFAULT_LAYOUT`
: The keyboard layout to be used (See **xkeyboard-config(7)**)