From ccb2ef57e36b0fa3a5e02de710d5b763a9472646 Mon Sep 17 00:00:00 2001
From: Guilhem Moulin <guilhem@fripost.org>
Date: Fri, 13 Dec 2019 20:04:26 +0100
Subject: doc/getting-started.md: Clarify use of `exec` built-in.

---
 doc/getting-started.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/getting-started.md b/doc/getting-started.md
index 1d29231..da8f116 100644
--- a/doc/getting-started.md
+++ b/doc/getting-started.md
@@ -180,23 +180,27 @@ for the sake of clarity we start from an empty file here.
 			# ignore the mailbox named 'virtual' and its descendants
 			# WARN: for version 0.4 and earlier it should be ^virtual(?:/|$)
 			ignore-mailbox = ^virtual(?:\x00|$)
-
 		EOF
 
  2. Next, append a `[local]` section pointing to the wrapper defined
     above:
 
         $ cat >>${XDG_CONFIG_HOME:-~/.config}/interimap/config <<-EOF
+
 			[local]
 			type = tunnel
 			command = exec ~/.local/bin/dovecot-imap
-
 		EOF
 
+    (The command will be passed to `` `/bin/sh -c` `` as it contains
+    the metacharacter `~`.  We use the `exec` built-in utility so the
+    shell process doesn't linger around during the IMAP session.)
+
  3. And finally append a `[remote]` section with your account
     information at `imap.example.org` (adapt the values accordingly):
 
         $ cat >>${XDG_CONFIG_HOME:-~/.config}/interimap/config <<-EOF
+
 			[remote]
 			type = imaps
 			host = imap.example.net
-- 
cgit v1.2.3