From f17bfab5ccc2e11ac58feb2feb9a445a3dbba530 Mon Sep 17 00:00:00 2001 From: project-repo Date: Sun, 14 May 2023 19:51:18 +0200 Subject: [PATCH] Add documentation --- man/cagebreak-config.5.md | 8 ++++++++ man/cagebreak-socket.7.md | 11 +++++++++++ 2 files changed, 19 insertions(+) diff --git a/man/cagebreak-config.5.md b/man/cagebreak-config.5.md index b9632dd..d497542 100644 --- a/man/cagebreak-config.5.md +++ b/man/cagebreak-config.5.md @@ -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 * + 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 . + See *cagebreak-socket(7)* for more details. + *definekey * Bind to execute if pressed in - *definekey* is a more general version of *bind*. diff --git a/man/cagebreak-socket.7.md b/man/cagebreak-socket.7.md index 4c1a31a..e8b88d3 100644 --- a/man/cagebreak-socket.7.md +++ b/man/cagebreak-socket.7.md @@ -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