changeset 17:2b799ca75d96

Add configuration example to the documentation
author Guido Berhoerster <guido+sievemgr@berhoerster.name>
date Tue, 02 Feb 2021 19:04:34 +0100
parents 14f5c9152901
children d14d93d011d7
files cmd/sievemgr/doc.go
diffstat 1 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/cmd/sievemgr/doc.go	Thu Dec 24 09:36:59 2020 +0100
+++ b/cmd/sievemgr/doc.go	Tue Feb 02 19:04:34 2021 +0100
@@ -86,6 +86,22 @@
 		skipped.  This renders the connection insecure and should only
 		be used for testing purposes.
 
+An example configuration with two accounts is provided below:
+
+	account "work" host "mail.example.com" port 2000 user "foo"
+	account "private" default host "example.net" user "baz" pass "qux"
+
+The first account must be explicitly referred to by its name "work".  sievemgr
+will directly connect to the host "mail.example.com" using the non-standard
+port 2000 since both host and port are given.  The user will be prompted for
+the account password before authentication is performed with the username
+"foo".
+
+The second account is the default account, host and port name of the server
+will be determined by looking up the corresponding SRV record associated with
+the domain "example.net". Authentication will be performed non-interactively
+with the username "baz" and password "qux".
+
 Global Options:
 
 	-f config