Release 2.3.0

Functionality:
  * Add configuration to anchor position of messages (#60, 71 in Bugs.md).
  * Add output priorisation (#38, 68 in Bugs.md).
  * Print whether output is active in dump.

Bug Fixes:
  * Fix gamma control (72 in Bugs.md).
  * Add missing commands to example config.
  * Add message_config to dump output.

Example Scripts:
  * Add screenshot script.
  * Make example scripts standalone.

Documentation:
  * Escape html tags in config man page. (#68, 69 in Bugs.md)
  * Improve README.md (#62, 70 in Bugs.md).
  * Improve SECURITY.md.
  * Add CONTRIBUTING.md (#62, 70 in Bugs.md).
  * FAQ: Add Firefox screenshare instructions for wayland.
  * FAQ: Add wlroots downgrading instructions for workaround in case of temporary wlroots incompatibility.
  * Update copyright notices to 2024.

Development Tooling:
  * Add new gpg keys (signed by the old ones).
  * Add PR template.
  * Add dev-FAQ.
  * Remove now-unnecessary fanalyzer pragmas.

example_scripts/cb_script_header.sh

@@ -1,18 +0,0 @@
-#!/bin/bash
-# Copyright 2023, project-repo and the cagebreak contributors
-# SPDX-License-Identifier: MIT
-
-named_pipe_send="$(mktemp -u)"
-named_pipe_recv="$(mktemp -u)"
-mkfifo "${named_pipe_send}"
-mkfifo "${named_pipe_recv}"
-nc -U "${CAGEBREAK_SOCKET}" < "${named_pipe_send}" > "${named_pipe_recv}"&
-# The file descriptor 3 is set up to send commands to cagebreak and file
-# descriptor 4 can be used to read events. Notice that events will pile up in
-# file descriptor 4, so it is a good idea to continuously read from it or to
-# clear it before starting a new transaction.
-exec 3>"${named_pipe_send}"
-exec 4<"${named_pipe_recv}"
-# When the script exits, the os will clean up the pipe
-rm "${named_pipe_recv}"
-rm "${named_pipe_send}"

example_scripts/screenshot_script

@@ -0,0 +1,44 @@
+#!/bin/bash
+# Copyright 2023 - 2024, project-repo, sodface and the cagebreak contributors
+# SPDX-License-Identifier: MIT
+#
+# Execute this script if you want to take a screenshot.
+# Please supply your chosen cropping/editing tool as a
+# command-line argument. The filepath to the temporary
+# file will be given as an argument to your command.
+#
+# Example:
+# screenshot_script "gwenview"
+
+named_pipe_send="$(mktemp -u)"
+named_pipe_recv="$(mktemp -u)"
+mkfifo "${named_pipe_send}"
+mkfifo "${named_pipe_recv}"
+nc -U "${CAGEBREAK_SOCKET}" < "${named_pipe_send}" > "${named_pipe_recv}"&
+# The file descriptor 3 is set up to send commands to cagebreak and file
+# descriptor 4 can be used to read events. Notice that events will pile up in
+# file descriptor 4, so it is a good idea to continuously read from it or to
+# clear it before starting a new transaction.
+exec 3>"${named_pipe_send}"
+exec 4<"${named_pipe_recv}"
+# When the script exits, the os will clean up the pipe
+rm "${named_pipe_recv}"
+rm "${named_pipe_send}"
+
+if [[ ${#} -lt 1 ]]
+then
+        echo "Expected a single command line argument specifying the command to edit the screenshot."
+        exit 1
+fi
+
+edit_cmd="${1}"
+
+echo "dump" >&3
+IFS= read -r -d $'\0' event <&4
+
+co="$(echo "${event:6}"|jq -r ".curr_output")"
+tmpfile="$(mktemp)"
+grim -t png -o "${co}" "${tmpfile}"
+bash -c "${edit_cmd} \"${tmpfile}\""
+wl-copy < "${tmpfile}"
+rm "${tmpfile}"

example_scripts/show_workspace_views

@@ -1,11 +1,23 @@
 #!/bin/bash
-# Copyright 2020 - 2023, project-repo and the cagebreak contributors
+# Copyright 2020 - 2024, project-repo and the cagebreak contributors
 # SPDX-License-Identifier: MIT
-
+#
 # This script displays the process names of the views on the current workspace.
 
-# Start up the ipc link
-source "$(dirname "${BASH_SOURCE[0]}")/cb_script_header.sh"
+named_pipe_send="$(mktemp -u)"
+named_pipe_recv="$(mktemp -u)"
+mkfifo "${named_pipe_send}"
+mkfifo "${named_pipe_recv}"
+nc -U "${CAGEBREAK_SOCKET}" < "${named_pipe_send}" > "${named_pipe_recv}"&
+# The file descriptor 3 is set up to send commands to cagebreak and file
+# descriptor 4 can be used to read events. Notice that events will pile up in
+# file descriptor 4, so it is a good idea to continuously read from it or to
+# clear it before starting a new transaction.
+exec 3>"${named_pipe_send}"
+exec 4<"${named_pipe_recv}"
+# When the script exits, the os will clean up the pipe
+rm "${named_pipe_recv}"
+rm "${named_pipe_send}"
 
 echo "dump" >&3