mirror of
https://cagebreak.project-repo.co/cagebreak.git
synced 2026-08-22 21:44:19 +02:00
Adjust socket documentation
This commit is contained in:
project-repo
parent
48f3a749aa
commit
89c92c5166
1 changed files with 47 additions and 19 deletions
|
|
@ -54,12 +54,14 @@ cg-ipc{"event_name":"background","old_bg":[0.000000,1.000000,1.000000],"new_bg":
|
|||
- 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
|
||||
|
||||
```
|
||||
close
|
||||
cg-ipc{"event_name":"close","view_id":47,"tile_id":47,"workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"close","view_id":47,"view_pid":30456,"tile_id":47,"workspace":1,"output":"eDP-1","output_id":1}
|
||||
```
|
||||
|
||||
*configure_input*
|
||||
|
|
@ -88,10 +90,11 @@ cg-ipc{"event_name":"configure_message"}
|
|||
- JSON
|
||||
- event_name: "configure_output"
|
||||
- output: name of the output as a string
|
||||
- output_id: id of the output as an integer
|
||||
|
||||
```
|
||||
output eDP-1 rotate 0
|
||||
cg-ipc{"event_name":"configure_output","output":"eDP-1"}
|
||||
cg-ipc{"event_name":"configure_output","output":"eDP-1","output_id":1}
|
||||
```
|
||||
|
||||
*cursor_switch_tile*
|
||||
|
|
@ -99,13 +102,15 @@ cg-ipc{"event_name":"configure_output","output":"eDP-1"}
|
|||
- 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
|
||||
|
||||
```
|
||||
# Cursor switches tile
|
||||
cg-ipc{"event_name":"cursor_switch_tile","old_output":"eDP-1","old_tile":2,"new_output":"eDP-1","new_tile":3}
|
||||
cg-ipc{"event_name":"cursor_switch_tile","old_output":"eDP-1","old_output_id":1,"old_tile":2,"new_output":"eDP-1","new_output_id":1,"new_tile":3}
|
||||
```
|
||||
|
||||
*cycle_outputs*
|
||||
|
|
@ -113,12 +118,14 @@ cg-ipc{"event_name":"cursor_switch_tile","old_output":"eDP-1","old_tile":2,"new_
|
|||
- 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*
|
||||
|
||||
```
|
||||
nextscreen
|
||||
cg-ipc{"event_name":"cycle_outputs","old_output":"eDP-1","new_output":"HDMI-A-1","reverse":0}
|
||||
cg-ipc{"event_name":"cycle_outputs","old_output":"eDP-1","old_output_id":1,"new_output":"HDMI-A-1","new_output_id":2,"reverse":0}
|
||||
```
|
||||
|
||||
*cycle_views*
|
||||
|
|
@ -126,14 +133,17 @@ cg-ipc{"event_name":"cycle_outputs","old_output":"eDP-1","new_output":"HDMI-A-1"
|
|||
- 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
|
||||
|
||||
```
|
||||
next
|
||||
cg-ipc{"event_name":"cycle_views","old_view_id":11,"new_view_id":4,"tile_id":13,"workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"cycle_views","old_view_id":11,"old_view_pid":32223,"new_view_id":4,"old_view_pid";53221,"tile_id":13,"workspace":1,"output":"eDP-1","output_id":1}
|
||||
```
|
||||
|
||||
*definekey*
|
||||
|
|
@ -181,10 +191,11 @@ cg-ipc{"event_name":"definemode","mode":"foo"}
|
|||
- JSON
|
||||
- event_name: "destroy_output"
|
||||
- output: name of the output as a string
|
||||
- output_id: id of the output as an integer
|
||||
|
||||
```
|
||||
# remove output from the device
|
||||
cg-ipc{"event_name":"destroy_output","output":"HDMI-A-1"}
|
||||
cg-ipc{"event_name":"destroy_output","output":"HDMI-A-1","output_id":2}
|
||||
```
|
||||
|
||||
*dump*
|
||||
|
|
@ -325,10 +336,11 @@ cg-ipc{"event_name":"dump","nws":1,
|
|||
- 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
|
||||
|
||||
```
|
||||
focus
|
||||
cg-ipc{"event_name":"focus_tile","old_tile_id":14,"new_tile_id":13,"workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"focus_tile","old_tile_id":14,"new_tile_id":13,"workspace":1,"output":"eDP-1","output_id":1}
|
||||
```
|
||||
|
||||
*fullscreen*
|
||||
|
|
@ -338,10 +350,11 @@ cg-ipc{"event_name":"focus_tile","old_tile_id":14,"new_tile_id":13,"workspace":1
|
|||
- 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
|
||||
|
||||
```
|
||||
only
|
||||
cg-ipc{"event_name":"fullscreen","tile_id":3,"workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"fullscreen","tile_id":3,"workspace":1,"output":"eDP-1","output_id":1}
|
||||
```
|
||||
|
||||
*move_view_to_cycle_output*
|
||||
|
|
@ -349,13 +362,16 @@ cg-ipc{"event_name":"fullscreen","tile_id":3,"workspace":1,"output":"eDP-1"}
|
|||
- 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
|
||||
|
||||
```
|
||||
movetonextscreen
|
||||
cg-ipc{"event_name":"cycle_outputs","old_output":"eDP-1","new_output":"HDMI-A-1","reverse":0}
|
||||
cg-ipc{"event_name":"move_view_to_cycle_output","view_id":11,"old_output":"eDP-1","new_output":"HDMI-A-1"}
|
||||
cg-ipc{"event_name":"move_view_to_cycle_output","view_id":11,"view_pid":43123,"old_output":"eDP-1","old_output_id":1,"new_output":"HDMI-A-1","new_output_id":2}
|
||||
```
|
||||
|
||||
*move_view_to_output*
|
||||
|
|
@ -380,12 +396,13 @@ cg-ipc{"event_name":"move_view_to_output","view_id":78,"old_output":"eDP-1","new
|
|||
- 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
|
||||
|
||||
```
|
||||
movetoworkspace 1
|
||||
cg-ipc{"event_name":"switch_ws","old_workspace":1,"new_workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"move_view_to_ws","view_id":43,"old_workspace":0,"new_workspace":0,"output":"eDP-1","view_pid":64908}
|
||||
cg-ipc{"event_name":"move_view_to_ws","view_id":43,"old_workspace":0,"new_workspace":0,"output":"eDP-1","output_id":1,"view_pid":64908}
|
||||
```
|
||||
|
||||
*new_output*
|
||||
|
|
@ -393,11 +410,12 @@ cg-ipc{"event_name":"move_view_to_ws","view_id":43,"old_workspace":0,"new_worksp
|
|||
- 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
|
||||
|
||||
```
|
||||
# a new output is attached
|
||||
cg-ipc{"event_name":"new_output","output":"HDMI-A-1","priority":-1}
|
||||
cg-ipc{"event_name":"new_output","output":"HDMI-A-1","output_id":2,"priority":-1}
|
||||
```
|
||||
|
||||
*resize_tile*
|
||||
|
|
@ -409,11 +427,12 @@ cg-ipc{"event_name":"new_output","output":"HDMI-A-1","priority":-1}
|
|||
- 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
|
||||
|
||||
```
|
||||
resizeleft
|
||||
cg-ipc{"event_name":"resize_tile","tile_id":14,"old_dims":"[1280,0,1440,1280]","new_dims":"[1270,0,1440,1290]","workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"resize_tile","tile_id":13,"old_dims":"[0,0,1440,1280]","new_dims":"[0,0,1440,1270]","workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"resize_tile","tile_id":14,"old_dims":"[1280,0,1440,1280]","new_dims":"[1270,0,1440,1290]","workspace":1,"output":"eDP-1","output_id":1}
|
||||
cg-ipc{"event_name":"resize_tile","tile_id":13,"old_dims":"[0,0,1440,1280]","new_dims":"[0,0,1440,1270]","workspace":1,"output":"eDP-1","output_id":1}
|
||||
```
|
||||
|
||||
*set_nws*
|
||||
|
|
@ -436,11 +455,12 @@ cg-ipc{"event_name":"set_nws","old_nws":1,"new_nws":2}
|
|||
- 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
|
||||
|
||||
```
|
||||
hsplit
|
||||
cg-ipc{"event_name":"split","tile_id":11,"new_tile_id":12,"workspace":1,"output":"eDP-1","vertical":0}
|
||||
cg-ipc{"event_name":"split","tile_id":11,"new_tile_id":12,"workspace":1,"output":"eDP-1","output_id":1,"vertical":0}
|
||||
```
|
||||
|
||||
*swap_tile*
|
||||
|
|
@ -448,13 +468,16 @@ cg-ipc{"event_name":"split","tile_id":11,"new_tile_id":12,"workspace":1,"output"
|
|||
- 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
|
||||
|
||||
```
|
||||
exchangeright
|
||||
cg-ipc{"event_name":"swap_tile","tile_id":1,"swap_tile_id":3,"workspace":1,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"swap_tile","tile_id":1,"tile_pid":53478,"swap_tile_id":3,"swap_tile_pid":98234,"workspace":1,"output":"eDP-1"}
|
||||
```
|
||||
|
||||
*switch_default_mode*
|
||||
|
|
@ -474,11 +497,13 @@ switch_output
|
|||
- 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
|
||||
|
||||
```
|
||||
screen 2
|
||||
cg-ipc{"event_name":"switch_output","old_output":"eDP-1","new_output":"HDMI-A-1"}
|
||||
cg-ipc{"event_name":"switch_output","old_output":"eDP-1","old_output_id":1,"new_output":"HDMI-A-1","new_output_id":2}
|
||||
```
|
||||
|
||||
switch_ws
|
||||
|
|
@ -488,10 +513,11 @@ 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
|
||||
|
||||
```
|
||||
workspace 2
|
||||
cg-ipc{"event_name":"switch_ws","old_workspace":1,"new_workspace":2,"output":"eDP-1"}
|
||||
cg-ipc{"event_name":"switch_ws","old_workspace":1,"new_workspace":2,"output":"eDP-1","output_id":1}
|
||||
```
|
||||
|
||||
*view_map*
|
||||
|
|
@ -502,11 +528,12 @@ cg-ipc{"event_name":"switch_ws","old_workspace":1,"new_workspace":2,"output":"eD
|
|||
- 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
|
||||
|
||||
```
|
||||
# process opens a view
|
||||
cg-ipc{"event_name":"view_map","view_id":28,"tile_id":14,"workspace":1,"output":"eDP-1","view_pid":39827}
|
||||
cg-ipc{"event_name":"view_map","view_id":28,"tile_id":14,"workspace":1,"output":"eDP-1","output_id":1,"view_pid":39827}
|
||||
```
|
||||
|
||||
*view_unmap*
|
||||
|
|
@ -517,11 +544,12 @@ cg-ipc{"event_name":"view_map","view_id":28,"tile_id":14,"workspace":1,"output":
|
|||
- 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
|
||||
|
||||
```
|
||||
# view is closed by the process
|
||||
cg-ipc{"event_name":"view_unmap","view_id":24,"tile_id":13,"workspace":1,"output":"eDP-1","view_pid":39544}
|
||||
cg-ipc{"event_name":"view_unmap","view_id":24,"tile_id":13,"workspace":1,"output":"eDP-1","output_id":1,"view_pid":39544}
|
||||
```
|
||||
|
||||
## SECURITY
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue