1 files changed, 50 insertions, 0 deletions

@@ -0,0 +1,50 @@
+# MERGIRC TURNEL
+
+a configurable ssh tunneler that I use for IRC
+
+this is a small shell script that'll set up
+an IRC tunnel between hosts that you can configure
+using a file.
+
+When you run mrgrctrnl,
+it'll automagically tunnel the hosts
+and let you sign into IRC on your own computer.
+Yay!
+
+## Why
+
+I like running weechat from my computer but have it connected to others.
+For example, I like to stay connected to tilde.town's IRC from my laptop.
+According to instructions from
+[~nick](https://tilde.town/~nick/sshtunnel.html),
+you can just set up an SSH tunnel.
+But I have multiple servers!
+So I made this script.
+
+### Why the stupid name?
+
+![gersbermps meme edited so she's holding terminals](mrgrc.jpg "ermahgerd")
+
+## Config file
+
+The config file is located at `$XDG_CONFIG_HOME/mrgrctrnl/config`.
+Each row is an ssh tunnel to run,
+with whitespace-separeted fields.
+A `#` begins a comment that goes to the end of the line.
+
+```
+# machine       user    local           remote
+example.com     ted     localhost:6989  localhost:6667
+```
+
+## Requirements
+
+- POSIX environment
+- ssh
+
+## Install
+
+````
+$ make clean
+# make install
+```