From 80af5c22d62f6df11c63a807ebf34ff69a4af754 Mon Sep 17 00:00:00 2001
From: Přemysl Eric Janouch <p@janouch.name>
Date: Thu, 15 May 2025 13:59:05 +0200
Subject: Add an xC relay protocol analyzer

---
 xR/xR.adoc | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 xR/xR.adoc

(limited to 'xR/xR.adoc')

diff --git a/xR/xR.adoc b/xR/xR.adoc
new file mode 100644
index 0000000..c3215bd
--- /dev/null
+++ b/xR/xR.adoc
@@ -0,0 +1,41 @@
+xR(1)
+=====
+:doctype: manpage
+:manmanual: xK Manual
+:mansource: xK {release-version}
+
+Name
+----
+xR - xC relay protocol analyzer
+
+Synopsis
+--------
+*xR* [_OPTION_]... RELAY-ADDRESS...
+
+Description
+-----------
+*xR* connects to an *xC* relay and prints all incoming events one per line
+in JSON format.  The JSON objects have two additional fields:
+
+when::
+	The time of reception (or sending) as a nanosecond precision
+	RFC 3339 UTC timestamp.
+raw::
+	The incoming event (or outgoing command) in raw binary form.
+
+Options
+-------
+*-debug*::
+	Print any outgoing commands as well, which may help in debugging any issues.
+
+*-version*::
+	Output version information and exit.
+
+Reporting bugs
+--------------
+Use https://git.janouch.name/p/xK to report bugs, request features,
+or submit pull requests.
+
+See also
+--------
+*xC*(1)
-- 
cgit v1.2.3-70-g09d2