Return to default mode

Set RGB of background - <[r|g|b]> are floating point numbers between 0 and 1. There is no support for background images.

# Set background to red
background 1.0 0.0 0.0

Bind <key> to execute <command> if pressed in root mode

bind <key> <command>
# is equivalent to
definekey root <key> <command>

Close current window - This may be useful for windows of applications which do not offer any method of closing them.

Configure message characteristics -

• font <font description> sets the font of the message. Here, <font description> is either
  - an X core font description or
  - a FreeType font description via pango
• fg_color <r> <g> <b> <a> sets the RGBA of the foreground
• bg_color <r> <g> <b> <a> sets the RGBA of the background
• display_time <n> sets the display time in seconds
• anchor <position> sets the position of the message.

# Set font
## Set example X code font
configure_message font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
## Set example FreeType font description
configure_message font pango:monospace 10
# Set foreground RGBA to red
configure_message fg_color 1.0 0.0 0.0 1.0
# Set background RGBA to red
configure_message bg_color 1.0 0.0 0.0 1.0
# Set duration for message display to four seconds
configure_message display_time 4

Enable or disable cursor

This simply hides the cursor. Pointing and clicking is still possible.

Send a custom event to the IPC socket

This sends an event of type "custom_event" to all programs listening to the IPC socket along with the string <message>. See cagebreak-socket(7) for more details.

Bind <key> to execute <command> if pressed in <mode> - definekey is a more general version of bind.

Define new mode <mode> - After a call to definemode, <mode> can be used with definekey to create a custom key mapping.

# define new mode and create a mapping for it
definemode foo
definekey foo C-t abort

Triggers the dump event, see cagebreak-socket(7) for details

Set <key> to switch to root mode to execute one command

escape <key>
# is equivalent to
definekey top <key> mode root

Exchange current window with window in the tile to the bottom

Exchange current window with window in the tile to the left

Exchange current window with window in the tile to the right

Exchange current window with window in the tile to the top

Execute <command> using sh -c

Focus next tile

Focus tile to the bottom

Focus tile to the left

Focus previous tile

Focus tile to the right

Focus tile to the top

Split current tile horizontally

Set <setting> to <value> for device <identifier> - <identifier> can be "*" (wildcard), of the form "type:<device_type>" or the identifier of the device as printed for example by cagebreak -s. The supported input types are

• touchpad
• pointer
• keyboard
• touch
• tablet_tool
• tablet_pad
• switch

Configurations are applied sequentially. Currently, only libinput devices may be configured. The available settings and their corresponding values are as follows:

accel_profile adaptive|flat

calibration_matrix <6 space-separated floating point values>

click_method none|button_areas|clickfinger

drag enabled|disabled

drag_lock enabled|disabled

dwt enabled|disabled

events enabled|disabled|disabled_on_external_mouse

keybindings [enabled|disabled]

left_handed enabled|disabled

middle_emulation enabled|disabled

natural_scroll enabled|disabled

pointer_accel [<-1|1>]

scroll_button disable|<event-code-or-name>

scroll_factor <floating point value>

scroll_method none|two_finger|edge|on_button_down

repeat_delay <n>

repeat_rate <n>

tap enabled|disabled

tap_button_map lrm|lmr

Display a line of arbitrary text.

Enter mode "<mode>" - Returns to default mode, after a command is executed.

Move currently focused window to next screen See output for differences between screen and output.

Move currently focused window to previous screen See output for differences between screen and output.

Move currently focused window to <n>-th screen See output for differences between screen and output.

Move currently focused window to <n>-th workspace See output for differences between screen and output.

Focus next window in current tile

Focus next screen See output for differences between screen and output.

Remove all splits and make current window fill the entire screen

Configure output "<name>" -

• <xpos> and <ypos> are the position of the monitor in pixels. The top-left monitor should have the coordinates 0 0.
• <width> and <height> specify the resolution in pixels.
• <rate> sets the refresh rate of the monitor (often this is 50 or 60).
• <scale> sets the output scale (default is 1.0)
• enable and disable enable or disable <name>. Note that if <output> is the only enabled output, output <output> disable has no effect.
• permanent sets <name> to persist even on disconnect. When the physical monitor is disconnected, the output is maintained and operates identically to the attached monitor. On reconnect, the monitor operates as though it was never disconnected. Setting the output role to peripheral when the monitor is disconnected, destroys the output, as if the monitor were disconnected.
• peripheral sets the role of <name> to peripheral, meaning that on disconnecting the respective monitor, all views will be moved to another available output. The default role is peripheral.
• prio <n> is used to set the priority of an output. If nothing else is set, outputs are added as they request to be added and have a numerical priority of -1. Using prio <n> it is possible to set priorities for outputs, where <n> >= 1. The larger <n> is, the higher the priority is, that is to say, the earlier the output will appear in the list of outputs.
• rotate <n> is used to rotate the output by `<n> mod 4 x 90` degrees counter-clockwise.

# Don't rotate
output DP-1 rotate 0
# rotate 90 degrees counter-clockwise
output DP-1 rotate 1
# rotate 180 degrees counter-clockwise
output DP-1 rotate 2
# rotate 270 degrees counter-clockwise
output DP-1 rotate 3

output and the screen family of commands are similar in that they both deal with monitors on some level.

• output addresses outputs by their name and is vaguely symmetric to input.
• Any screen command deals with the number identifying a monitor within a Cagebreak session either explicitly or implicitly (i.e. the commands containing next and prev).

Focus previous window in current tile

Focus previous screen

Exit cagebreak

Resize current tile towards the bottom

Resize current tile towards the left

Resize current tile towards the right

Resize current tile towards the top

Change to <n>-th screen See output for differences between screen and output.

Display information about the current setup - In particular, print the identifiers of the available inputs and outputs.

Set default mode to <mode>

Switch to tty <n>

Display time

Split current tile vertically

Change to <n>-th workspace

Set number of workspaces to <n> - <n> is a single integer larger than 1 and less than 30.