Browse Source

document some additional uses for PipelineDepth

Oswald Buddenhagen 8 years ago
parent
commit
22145f6674
1 changed files with 3 additions and 1 deletions
  1. 3 1
      src/mbsync.1

+ 3 - 1
src/mbsync.1

@@ -397,7 +397,9 @@ File containing the private key corresponding to \fBClientCertificate\fR.
 \fBPipelineDepth\fR \fIdepth\fR
 \fBPipelineDepth\fR \fIdepth\fR
 Maximum number of IMAP commands which can be simultaneously in flight.
 Maximum number of IMAP commands which can be simultaneously in flight.
 Setting this to \fI1\fR disables pipelining.
 Setting this to \fI1\fR disables pipelining.
-This is mostly a debugging only option.
+This is mostly a debugging option, but may also be used to limit average
+bandwidth consumption (GMail may require this if you have a very fast
+connection), or to spare flaky servers like M$ Exchange.
 (Default: \fIunlimited\fR)
 (Default: \fIunlimited\fR)
 ..
 ..
 .TP
 .TP