From cffe8e1991c632ce7c033f75b848159e701772fc Mon Sep 17 00:00:00 2001
From: project-repo <cagebreak_signing_key_9@project-repo.co>
Date: Fri, 30 Sep 2022 22:05:19 +0200
Subject: [PATCH] Add socket man page

---
 man/cagebreak-config.5.md |  1 +
 man/cagebreak-socket.7.md | 70 +++++++++++++++++++++++++++++++++++++++
 man/cagebreak.1.md        |  1 +
 3 files changed, 72 insertions(+)
 create mode 100644 man/cagebreak-socket.7.md

diff --git a/man/cagebreak-config.5.md b/man/cagebreak-config.5.md
index 5f3fec9..8429a9c 100644
--- a/man/cagebreak-config.5.md
+++ b/man/cagebreak-config.5.md
@@ -355,6 +355,7 @@ is used.
 # SEE ALSO
 
 *cagebreak(1)*
+*cagebreak-socket(7)*
 
 # BUGS
 
diff --git a/man/cagebreak-socket.7.md b/man/cagebreak-socket.7.md
new file mode 100644
index 0000000..a140a1f
--- /dev/null
+++ b/man/cagebreak-socket.7.md
@@ -0,0 +1,70 @@
+cagebreak-socket(7) "Version 2.0.0" "Cagebreak Manual"
+
+# NAME
+
+*cagebreak-socket* — Cagebreak socket
+
+# SYNOPSIS
+
+*ipc-socket-capable-tool \$CAGEBREAK_SOCKET*
+
+# DESCRIPTION
+
+The cagebreak socket is an ipc socket.
+
+The socket accepts cagebreak commands as input (see *cagebreak-config(5)* for more information).
+
+Events are provided as output as specified in this man page.
+
+## EVENTS
+
+*foo <arg>*
+	Set x of y - <[x|y|z]> are foos
+	between 0 and 1.
+	This is a full sentence.
+
+```
+# Comment
+example
+```
+
+## SECURITY
+
+The socket is restricted to the user for reading, writing and execution.
+
+## EXAMPLES
+
+*nc -U $CAGEBREAK_SOCKET*
+
+*ncat -U $CAGEBREAK_SOCKET*
+
+# SEE ALSO
+
+*cagebreak(1)*
+*cagebreak-config(5)*
+
+# BUGS
+
+See GitHub Issues: <https://github.com/project-repo/cagebreak/issues>
+
+# LICENSE
+
+Copyright (c) 2022 The Cagebreak authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/man/cagebreak.1.md b/man/cagebreak.1.md
index 4067375..aa6e071 100644
--- a/man/cagebreak.1.md
+++ b/man/cagebreak.1.md
@@ -68,6 +68,7 @@ are displayed in a message box at the top right of the screen.
 # SEE ALSO
 
 *cagebreak-config(5)*
+*cagebreak-socket(7)*
 
 # BUGS