aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2020-02-11 17:39:52 +0100
committerSimon Ser <contact@emersion.fr>2020-02-11 17:40:18 +0100
commit02b59bc3650bab684f4661f7a75b96f19c6fa87b (patch)
treeb88d772eb375f88fc897ec4f408491e88356dc37 /docs
parent3c391fa81db23666df0fd238267795126338bf43 (diff)
downloadalps-02b59bc3650bab684f4661f7a75b96f19c6fa87b.tar.gz
alps-02b59bc3650bab684f4661f7a75b96f19c6fa87b.zip
docs/cli: new page
Diffstat (limited to 'docs')
-rw-r--r--docs/cli.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md
new file mode 100644
index 0000000..36964e9
--- /dev/null
+++ b/docs/cli.md
@@ -0,0 +1,42 @@
+# SYNOPSIS
+
+ koushin [options...] <upstream servers...>
+
+# DESCRIPTION
+
+koushin is a simple and extensible webmail. It offers a web interface for IMAP,
+SMTP and other upstream servers.
+
+At least one upstream IMAP server needs to be specified. The easiest way to do
+so is to just specify a domain name:
+
+ koushin example.org
+
+This assumes SRV DNS records are properly set up (see [RFC 6186]).
+
+Alternatively, one or more upstream server URLs can be specified:
+
+ koushin imaps://mail.example.org:993 smtps://mail.example.org:465
+
+The following URL schemes are supported:
+
+* `imaps` (IMAP with TLS), `imap+insecure` (plain IMAP)
+* `smtps` (SMTP with TLS), `smtp+insecure` (plain SMTP)
+* `https` (CardDAV and CalDAV over HTTPS), `http+insecure` (CardDAV and CalDAV
+ over plain HTTP)
+* `carddavs` (CardDAV over HTTPS), `carddav+insecure` (CardDAV over plain HTTP)
+* `caldavs` (CalDAV over HTTPS), `caldav+insecure` (CalDAV over plain HTTP)
+
+# OPTIONS
+
+**-theme**: default theme (default: no theme)
+
+**-addr**: listening address (default: ":1323")
+
+**-h**, **--help**: show help message and exit
+
+# SIGNALS
+
+**SIGUSR1**: reloads templates and Lua plugins
+
+[RFC 6186]: https://tools.ietf.org/html/rfc6186