diff options
| author | Přemysl Eric Janouch <p@janouch.name> | 2025-05-15 13:59:05 +0200 |
|---|---|---|
| committer | Přemysl Eric Janouch <p@janouch.name> | 2025-05-15 14:14:53 +0200 |
| commit | 80af5c22d62f6df11c63a807ebf34ff69a4af754 (patch) | |
| tree | 418804e057f1d85188edd8e6b083780a3776bb20 /xR/xR.adoc | |
| parent | 7ba17a016140f578bccca3ffd320c1663cf66c6c (diff) | |
| download | xK-80af5c22d62f6df11c63a807ebf34ff69a4af754.tar.gz xK-80af5c22d62f6df11c63a807ebf34ff69a4af754.tar.xz xK-80af5c22d62f6df11c63a807ebf34ff69a4af754.zip | |
Add an xC relay protocol analyzerorigin/master
Diffstat (limited to 'xR/xR.adoc')
| -rw-r--r-- | xR/xR.adoc | 41 |
1 files changed, 41 insertions, 0 deletions
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) |