Add documentation

This commit is contained in:
project-repo 2023-05-14 19:51:18 +02:00
commit f17bfab5cc
2 changed files with 19 additions and 0 deletions

View file

@ -81,9 +81,17 @@ configure_message display_time 4
*cursor [enable|disable]*
Enable or disable cursor
This simply hides the cursor. Pointing and clicking is
still possible.
*custom_event <message>*
Send a custom event to the IPC socket
This sends an event of time "custom_event" to all programs
listening to the IPC socket along with the string <message>.
See *cagebreak-socket(7)* for more details.
*definekey <mode> <key> <command>*
Bind <key> to execute <command> if pressed in <mode> -
*definekey* is a more general version of *bind*.

View file

@ -113,6 +113,17 @@ cg-ipc{"event_name":"configure_output","output":"eDP-1","output_id":1}
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}
```
*custom_event*
- 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
```
custom_event Hello World!
cg-ipc{"event_name":"custom_event","message":"Hello World!"}
```
*cycle_outputs*
- Trigger: *nextscreen* and *prevscreen* commands
- JSON