summary refs log tree commit diff
path: root/README.7
diff options
context:
space:
mode:
authorJune McEnroe <june@causal.agency>2019-12-21 15:08:02 -0500
committerJune McEnroe <june@causal.agency>2019-12-21 15:08:02 -0500
commit78ab311c5e2259f5d7e3e3db008d686f463940e1 (patch)
tree46d963cefaacc5a3693f293e338c87c39190af13 /README.7
parentAdd copyright header to git-fetch-email (diff)
downloadimbox-78ab311c5e2259f5d7e3e3db008d686f463940e1.tar.gz
imbox-78ab311c5e2259f5d7e3e3db008d686f463940e1.zip
Add README
Diffstat (limited to '')
-rw-r--r--README.748
1 files changed, 48 insertions, 0 deletions
diff --git a/README.7 b/README.7
new file mode 100644
index 0000000..8e1407a
--- /dev/null
+++ b/README.7
@@ -0,0 +1,48 @@
+.Dd December 21, 2019
+.Dt README 7
+.Os "Causal Agency"
+.
+.Sh NAME
+.Nm imbox
+.Nd IMAP to mbox
+.
+.Sh DESCRIPTION
+.Nm
+is a small TLS-only IMAP client
+intended for fetching git patches.
+It requires LibreSSL
+.Pq Fl ltls
+and either
+.Xr dig 1
+or
+.Xr drill 1
+for automatic IMAP server configuration.
+.
+.Pp
+Build configuration can be written to
+.Pa config.mk .
+The install prefix of LibreSSL is set by
+.Va LIBRESSL_PREFIX .
+The path of
+.Xr dig 1
+can be set by defining the C preprocessor macro
+.Va DIG_PATH .
+The default is
+.Pa /usr/bin/drill
+on
+.Fx
+and
+.Pa dig
+everywhere else.
+.
+.Sh CONTRIBUTING
+The upstream URL of this project is
+.Aq Lk https://git.causal.agency/imbox .
+I'm happy to receive contributions in any form at
+.Aq Mt june@causal.agency .
+For sending patches by email, see
+.Aq Lk https://git-send-email.io .
+.
+.Sh SEE ALSO
+.Xr git-fetch-email 1 ,
+.Xr imbox 1