cagebreak-socket - (unknown subject)

•

Trigger: background command

•

JSON

event_name: "background"

•

old_bg: list of three floating point numbers denoting the old background in rgb

•

new_bg: list of three floating point numbers denoting the new background in rgb

•

Trigger: close command

•

JSON

event_name: "close"

•

view_id: view id as an integer

•

tile_id: tile id as an integer

•

view_pid: pid of the process

•

workspace: workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: input command

•

JSON

event_name: "configure_input"

•

input: the input as a string, as per cagebreak-config(5)

•

Trigger: configure_message command

•

JSON

event_name: "configure_message"

•

Trigger: output command

•

JSON

event_name: "configure_output"

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: Cursor crosses the border between tiles

•

JSON

event_name: "cursor_switch_tile"

•

old_output: name of the old output as a string

•

old_output_id: old output id as an integer

•

old_tile: number of the old tile as an integer

•

new_output: name of the new output as a string

•

new_output_id: new output id as an integer

•

new_tile: number of the new tile as an integer

•

Trigger: Cagebreak receives the custom_event command, either in the config file or via the IPC socket (see cagebreak-config(5)).

•

JSON

event_name: "custom_event"

•

message: The message passed to the custom_event command

•

Trigger: nextscreen and prevscreen commands

•

JSON

event_name: "cycle_outputs"

•

old_output: old output name as string

•

old_output_id: old output id as an integer

•

new_output: new output name as string

•

new_output_id: new output id as an integer

•

reverse: "0" if nextscreen or "1" if prevscreen

•

Trigger: next and prev commands

•

JSON

event_name: "cycle_views"

•

old_view_id: old view id as an integer

•

old_view_pid: pid of old view

•

new_view_id: new view id as an interger

•

new_view_pid: pid of new view

•

tile_id: tile id as an integer

•

workspace: workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: definekey command

•

JSON

event_name: "definekey"

•

modifiers: number denoting the modifier as described below

0: no modifier

•

1: shift

•

2: alt

•

3: ctrl

•

4: logo key

•

5: modifier 2

•

6: modifier 3

•

7: modifier 5

•

•

command: command as a string - CAVEAT: This is an internal representation of commands which is not in one-to-one correspondance with the commands available in the config file. The differences are as follows:

"cycle_tiles": represents any exchange command (e.g. exchangeright)

•

"cycle_views": represents both the next and the prev command

•

"cycle_outputs": represents nextscreen, movetoprevscreen and prevscreen commands

•

"resize_tile_vertical": represents resizedown and resizeup commands

•

"resize_tile_horizontal": represents resizeleft and resizeright commands

•

Trigger: definemode command

•

JSON

event_name: "definemode"

•

mode: name of mode as string

•

Trigger: removal of an output

•

JSON

event_name: "destroy_output"

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: dump command

•

JSON

event_name: "dump"

•

nws: number of workspaces as an integer

•

bg_color: list of three floating point numbers denoting the new background in rgb

•

views_curr_id: id of the currently focussed view as an integer

•

tiles_curr_id: id of the currently focussed tile as in integer

•

curr_output: current output as a string

•

default_mode: name of the default mode as a string

•

modes: list of names of modes as strings

•

message_config: the current configuration of the cagebreak messages

font: the font used to display the messages

•

display_time: the duration in seconds that the cagebreak messages are displayed

•

bg_color: list of four floating point numbers denoting the background color in rgba

•

fg_color: list of four floating point numbers denoting the foreground color in rgba

•

anchor: the positioning of the messages on the screen (see cagebreak-config(5) for more information)

•

•

output name as string

priority: priority as per output prio <n> in cagebreak-config(5) or default

•

coords: object of x and y coordinates of output

•

size: object of width and height as integers

•

refresh_rate: refresh rate as float

•

permanent: 0 if peripheral, 1 if permanent

•

active: 1 if the output is active, 0 if not

•

curr_workspace: current workspace as an integer

•

workspaces: list of objects for each workspace

views: list of objects for each view

id: view id as an integer

•

pid: pid of the process which opened the view as an integer

•

coords: object of x and y coordinates

•

type: ["xdg"|"xwayland"]

•

•

id: tile id as an integer

•

coords: object of x and y coordinates

•

size: object of width and height

•

view: view id as an integer

•

•

keyboard name as a string

commands_enabled: 0 if keybindings are disabled for the keyboard, 1 otherwise

•

repeat_delay: repeat delay in milliseconds as an integer

•

repeat_rate: repeat rate in 1/sec as an integer

•

•

identifier for a keyboard as a string

is_virtual: 1 if virtual, 0 otherwise

•

type: [keyboard|pointer|switch]

•

•

Trigger: focus command

•

JSON

event_name: "focus_tile"

•

old_tile_id: old tile id as an integer

•

new_tile_id: new tile id as an integer

•

workspace: workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: only command

•

JSON

event_name: "fullscreen"

•

tile_id: tile id as an integer

•

workspace: workspace number as an integer

•

output: output as a string

•

output_id: id of the output as an integer

•

Trigger: movetonextscreen and similar commands

•

JSON

event_name: "move_view_to_cycle_output"

•

view_id: view id as an integer

•

view_pid: pid of the process

•

old_output: name of the old output as a string

•

old_output_id: old output id as an integer

•

new_output: name of the new output as a string

•

old_output_id: old output id as an integer

•

Trigger: movetoscreen command

•

JSON

event_name: "move_view_to_output"

•

view_id: view id as an integer

•

old_output: old output name as string

•

new_output: new output name as string

•

Trigger: movetoworkspace command

•

JSON

event_name: "move_view_to_ws"

•

view_id: view id as an integer

•

old_workspace: old workspace number as an integer

•

new_workspace: new workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

view_pid: pid of the process

•

Trigger: a new output is physically attached

•

JSON

event_name: "new_output"

•

output: new output name as a string

•

output_id: id of the new output as an integer

•

priority: priority as per output prio <n> in cagebreak-config(5) or default

•

Trigger: the resize family of commands

•

JSON

event_name: "resize_tile"

•

tile_id: tile id as an integer

•

old_dims: list of coordinates [x coordinate of lower left corner, y coordinate of lower left corner, x coordinate of upper right corner, y coordinate of upper right corner]

•

new_dims: list of coordinate [x coordinate of lower left corner, y coordinate of lower left corner, x coordinate of upper right corner, y coordinate of upper right corner]

•

workspace: workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: workspaces command

•

JSON

event_name: "set_nws"

•

old_nws: old number of workspaces as an integer

•

new_nws: new number of workspaces as an integer

•

Trigger: split command

•

JSON

event_name: "split"

•

tile_id: old tile id as an integer

•

new_tile_id: new tile id as an integer

•

workspace: workspace number as an integer

•

output: output as a string

•

output_id: id of the output as an integer

•

vertical: 0 if horizontal split, 1 if not

•

Trigger: the exchange family of commands

•

JSON

event_name: "swap_tile"

•

tile_id: previous tile id as an integer

•

tile_pid: pid of previous tile

•

swap_tile_id: swap tile id as an integer

•

swap_tile_pid: pid of swap tile

•

workspace: workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: setmode command

•

JSON

event_name: "switch_default_mode"

•

old_mode: old mode name

•

mode: new mode name

•

Trigger. screen command

•

JSON

event_name: "switch_output"

•

old_output: name of the old output as a string

•

old_output_id: old output id as an integer

•

new_output: name of the new output as a string

•

new_output_id: new output id as an integer

•

Trigger: workspace command

•

JSON

event_name: "switch_ws"

•

old_workspace: old workspace number as an integer

•

new_workspace: new workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

Trigger: view is opened by a process

•

JSON

event_name: "view_map"

•

view_id: view id as an integer

•

tile_id: tile id as an integer

•

workspace: workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

view_pid: pid of the process

•

Trigger: view is closed by a process

•

JSON

event_name: "view_unmap"

•

view_id: view id as an integer

•

tile_id: tile id as an integer

•

workspace: workspace number as an integer

•

output: name of the output as a string

•

output_id: id of the output as an integer

•

view_pid: pid of the process

•

0A268C188D7949FEB39FD1462F2AD980247E4918

•

283D10F54201B0C6CCEE2C561DE04E4B056C749D