From b9ab74abe7a021e30bf6c2f450e7d52c9646c504 Mon Sep 17 00:00:00 2001
From: June McEnroe <june@causal.agency>
Date: Sun, 28 Apr 2019 13:23:45 -0400
Subject: Add relay.1

---
 bin/irc/relay.1 | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 bin/irc/relay.1

(limited to 'bin/irc')

diff --git a/bin/irc/relay.1 b/bin/irc/relay.1
new file mode 100644
index 00000000..402c4726
--- /dev/null
+++ b/bin/irc/relay.1
@@ -0,0 +1,48 @@
+.Dd April 28, 2019
+.Dt RELAY 1
+.Os
+.
+.Sh NAME
+.Nm relay
+.Nd IRC relay bot
+.
+.Sh SYNOPSIS
+.Nm
+.Ar host
+.Ar port
+.Ar nick
+.Ar chan
+.
+.Sh DESCRIPTION
+.Nm
+is one half of an IRC relay pair.
+It connects to
+.Ar host Ns : Ns Ar port
+over TLS
+as
+.Ar nick
+and joins
+.Ar chan .
+.
+.Pp
+.Nm
+outputs messages from
+.Ar chan
+to standard output
+and sends messages to
+.Ar chan
+from standard input.
+Two
+.Nm
+processes can be connected with
+.Xr mkfifo 1 .
+.
+.Sh EXAMPLES
+.Bd -literal -offset indent
+mkfifo a b
+relay a.example.com 6697 relay '#example' <>a >b
+relay b.example.com 6697 relay '#example' <>b >a
+.Ed
+.
+.Sh SEE ALSO
+.Xr mkfifo 1
-- 
cgit 1.4.1