From 03eefc3f0985ba8f108b3ec906c712999a9f7848 Mon Sep 17 00:00:00 2001
From: "martin f. krafft" <madduck@madduck.net>
Date: Tue, 22 Mar 2022 08:11:37 +0100
Subject: [PATCH] add server-side config comment

---
 .offlineimap/preauthtunnel.sh | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/.offlineimap/preauthtunnel.sh b/.offlineimap/preauthtunnel.sh
index 0976974..778cf0d 100755
--- a/.offlineimap/preauthtunnel.sh
+++ b/.offlineimap/preauthtunnel.sh
@@ -1,3 +1,15 @@
 #!/bin/sh
 
 exec ssh -F ~/.offlineimap/ssh_config -i ~/.offlineimap/${1}.ssh-seckey ${1}
+
+# this relies on the IMAP command being specified on the server side, i.e. in
+# ~/.ssh/authorized_keys, put a line like the following
+#
+#   command="MAIL=$HOME/.maildir /usr/lib/dovecot/imap 2>/dev/null",no-agent-forwarding,no-X11-forwarding,no-port-forwarding,no-pty ssh-ed25519 AAA…
+#
+# Then, when you invoke this script directly, you should see the IMAP server
+# greet you:
+#
+# % ~/.offlineimap/preauthtunnel.sh madduck-net.imap.madduck.net
+# * PREAUTH [CAPABILITY IMAP4rev1 […]] Logged in as madduck
+
-- 
2.39.2