commit 5b4766fbe4e6edacf237ae745c47937d9d786ade
parent 4ad82686f26994433f86e1d0aaef76bb2259f366
Author: Oswald Buddenhagen <ossi@users.sf.net>
Date: Sat, 12 Dec 2020 14:56:27 +0100
improve docu for {Pass,User}Cmd
Diffstat:
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/src/mbsync.1 b/src/mbsync.1
@@ -326,10 +326,13 @@ Specify the login name on the IMAP server.
\fBUserCmd\fR [\fB+\fR]\fIcommand\fR
Specify a shell command to obtain a user rather than specifying a
user directly. This allows you to script retrieving user names.
+.br
The command must produce exactly one line on stdout; the trailing newline
is optional.
Prepend \fB+\fR to the command to indicate that it produces TTY output
(e.g., a prompt); failure to do so will merely produce messier output.
+Remember to backslash-escape double quotes and backslashes embedded into
+the command.
.
.TP
\fBPass\fR \fIpassword\fR
@@ -342,11 +345,8 @@ configuration file, \fBmbsync\fR will prompt you for a password.
\fBPassCmd\fR [\fB+\fR]\fIcommand\fR
Specify a shell command to obtain a password rather than specifying a
password directly. This allows you to use password files and agents.
-The command must produce exactly one line on stdout; the trailing newline is
-optional.
-Prepend \fB+\fR to the command to indicate that it produces TTY output
-(e.g., a decryption password prompt); failure to do so will merely produce
-messier output.
+.br
+See \fBUserCmd\fR above for details.
.
.TP
\fBUseKeychain\fR \fByes\fR|\fBno\fR