commit 7b682af0ce3805d91159f313a2f1f802f7db8e37
from: Omar Polo <op@omarpolo.com>
date: Sun Nov 21 15:29:01 2021 UTC

add a README

commit - b542d8003b0a24ba0e646257a8e9331cabc7ec9f
commit + 7b682af0ce3805d91159f313a2f1f802f7db8e37
blob - /dev/null
blob + 80d8380d84b869868eedd0222fddbf1ae9833d69 (mode 644)
--- /dev/null
+++ README.md
@@ -0,0 +1,21 @@
+# lstun -- lazy ssh tunnel
+
+lstun is a simple utility to lazily (on demand) spawn a ssh tunnel to
+a remote machine and kill it after some time of inactivity.
+
+Given its narrow scope, it's probably not useful to anybody but me, so
+I haven't invested much time in making it easily portable.  Said that,
+it shouldn't be hard to compile it in non-OpenBSD systems: you have
+just to compile it by hand and (probably) provide an implementation
+for strtonum(3) and getprogname(3).
+
+To compile it just run
+
+	make
+
+The only dependency is libevent.
+
+By default it uses `/usr/bin/ssh`, you can change it at compile time
+with `-D SSH_PATH=<whatever>`.
+
+Check out the manpage for the usage.