lobo/isync
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
98f4fd4586
isync/src/mbsync.1

817 lines
32 KiB
Groff
Raw Normal View History

convert licensing to SPDX while at it, add/fix some licenses/copyrights/comments: - it makes no sense to have a GPL exception in scripts - ted did not contribute to the man page - tst_timers is not part of the mbsync executable - explicitly put the build system under GPL and add copyrights
2022-06-16 10:44:35 +00:00
.\" SPDX-FileCopyrightText: 2000-2002 Michael R. Elkins <me@mutt.org>
.\" SPDX-FileCopyrightText: 2002-2022 Oswald Buddenhagen <ossi@users.sf.net>
.\" SPDX-License-Identifier: GPL-2.0-or-later
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.\"
convert licensing to SPDX while at it, add/fix some licenses/copyrights/comments: - it makes no sense to have a GPL exception in scripts - ted did not contribute to the man page - tst_timers is not part of the mbsync executable - explicitly put the build system under GPL and add copyrights
2022-06-16 10:44:35 +00:00
.\" mbsync - mailbox synchronizer
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
convert licensing to SPDX while at it, add/fix some licenses/copyrights/comments: - it makes no sense to have a GPL exception in scripts - ted did not contribute to the man page - tst_timers is not part of the mbsync executable - explicitly put the build system under GPL and add copyrights
2022-06-16 10:44:35 +00:00
.TH mbsync 1 "2022 Jun 16"
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH NAME
mbsync - synchronize IMAP4 and Maildir mailboxes
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH SYNOPSIS
\fBmbsync\fR [\fIoptions\fR ...] {{\fIchannel\fR[\fB:\fIbox\fR[{\fB,\fR|\fB\\n\fR}...]]|\fIgroup\fR} ...|\fB-a\fR}
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH DESCRIPTION
\fBmbsync\fR is a command line application which synchronizes mailboxes;
currently Maildir and IMAP4 mailboxes are supported.
New messages, message deletions and flag changes can be propagated both ways;
the operation set can be selected in a fine-grained manner.
.br
Synchronization is based on unique message identifiers (UIDs), so no
mention safety of concurrent access; wording improvements
2015-09-07 10:23:12 +00:00
identification conflicts can occur (unlike with some other mail synchronizers).
implement Message-Id based UIDVALIDITY recovery
2016-12-18 19:50:20 +00:00
OTOH, \fBmbsync\fR is susceptible to UID validity changes (but will recover
just fine if the change is unfounded).
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Synchronization state is kept in one local text file per mailbox pair;
mention safety of concurrent access; wording improvements
2015-09-07 10:23:12 +00:00
these files are protected against concurrent \fBmbsync\fR processes.
Mailboxes can be safely modified while \fBmbsync\fR operates
(see \fBINHERENT PROBLEMS\fR below for a minor exception).
Multiple replicas of each mailbox can be maintained.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH OPTIONS
.TP
\fB-c\fR, \fB--config\fR \fIfile\fR
Read configuration from \fIfile\fR.
By default, the configuration is read from ~/.mbsyncrc.
.TP
\fB-a\fR, \fB--all\fR
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
Select all configured Channels. Any Channel/Group specifications on the
command line are ignored.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fB-l\fR, \fB--list\fR
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
Don't synchronize anything, but list all mailboxes in the selected Channels
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
and exit.
.TP
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fB-C\fR[\fBf\fR][\fBn\fR], \fB--create\fR[\fB-far\fR|\fB-near\fR]
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Override any \fBCreate\fR options from the config file. See below.
.TP
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fB-R\fR[\fBf\fR][\fBn\fR], \fB--remove\fR[\fB-far\fR|\fB-near\fR]
add support for propagating folder deletions
2014-12-29 01:08:48 +00:00
Override any \fBRemove\fR options from the config file. See below.
.TP
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fB-X\fR[\fBf\fR][\fBn\fR], \fB--expunge\fR[\fB-far\fR|\fB-near\fR]
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Override any \fBExpunge\fR options from the config file. See below.
.TP
{\fB-n\fR|\fB-N\fR|\fB-d\fR|\fB-f\fR|\fB-0\fR|\fB-F\fR},\
{\fB--new\fR|\fB--renew\fR|\fB--delete\fR|\fB--flags\fR|\fB--noop\fR|\fB--full\fR}
.TP
\r{\fB-L\fR|\fB-H\fR}[\fBn\fR][\fBN\fR][\fBd\fR][\fBf\fR],\
{\fB--pull\fR|\fB--push\fR}[\fB-new\fR|\fB-renew\fR|\fB-delete\fR|\fB-flags\fR]
Override any \fBSync\fR options from the config file. See below.
.TP
\fB-h\fR, \fB--help\fR
Display a summary of command line options.
.TP
\fB-v\fR, \fB--version\fR
Display version information.
.TP
\fB-V\fR, \fB--verbose\fR
revamp console output options - the old meaning of -V[V] was moved to -D{n|N}, as these are really debugging options. - don't print the info messages by default; this can be re-enabled with the -V switch, and is implied by most debug options (it was really kind of stupid that verbose/debug operation disabled these). - the sync algo/state debugging can be separately enabled with -Ds now.
2015-03-23 07:42:51 +00:00
Enable \fIverbose\fR mode, which displays what is currently happening.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
introduce driver call debugging do that by wrapping the actual stores into proxies. the proxy driver's code is auto-generated from function templates, some parameters, and the declarations of the driver functions themselves. attempts to do it with CPP macros turned out to be a nightmare.
2017-04-02 12:57:17 +00:00
\fB-D\fR[\fBC\fR][\fBd\fR|\fBD\fR][\fBm\fR][\fBM\fR][\fBn\fR|\fBN\fR][\fBs\fR]\fR]\fR,\
\fB--debug\fR[\fB-crash\fR|\fB-driver\fR|\fB-driver-all\fR|\fB-maildir\fR|\fB-main\fR|\fB-net\fR|\fB-net-all\fR|\fB-sync\fR]
revamp console output options - the old meaning of -V[V] was moved to -D{n|N}, as these are really debugging options. - don't print the info messages by default; this can be re-enabled with the -V switch, and is implied by most debug options (it was really kind of stupid that verbose/debug operation disabled these). - the sync algo/state debugging can be separately enabled with -Ds now.
2015-03-23 07:42:51 +00:00
Enable debugging categories:
.in +4
\fBC\fR, \fBcrash\fR - use built-in crash handler
.br
introduce driver call debugging do that by wrapping the actual stores into proxies. the proxy driver's code is auto-generated from function templates, some parameters, and the declarations of the driver functions themselves. attempts to do it with CPP macros turned out to be a nightmare.
2017-04-02 12:57:17 +00:00
\fBd\fR, \fBdriver\fR - print driver calls (metadata only)
.br
\fBD\fR, \fBdriver-all\fR - print driver calls (including messages)
.br
revamp console output options - the old meaning of -V[V] was moved to -D{n|N}, as these are really debugging options. - don't print the info messages by default; this can be re-enabled with the -V switch, and is implied by most debug options (it was really kind of stupid that verbose/debug operation disabled these). - the sync algo/state debugging can be separately enabled with -Ds now.
2015-03-23 07:42:51 +00:00
\fBm\fR, \fBmaildir\fR - print maildir debug info
.br
add debugging for main() so far, that's mostly mailbox listing
2015-03-26 17:09:25 +00:00
\fBM\fR, \fBmain\fR - print main debug info
.br
revamp console output options - the old meaning of -V[V] was moved to -D{n|N}, as these are really debugging options. - don't print the info messages by default; this can be re-enabled with the -V switch, and is implied by most debug options (it was really kind of stupid that verbose/debug operation disabled these). - the sync algo/state debugging can be separately enabled with -Ds now.
2015-03-23 07:42:51 +00:00
\fBn\fR, \fBnet\fR - print network traffic (protocol only)
.br
\fBN\fR, \fBnet-all\fR - print network traffic (including payloads)
.br
\fBs\fR, \fBsync\fR - print synchronization debug info
.in -4
All categories except \fBcrash\fR implictly enable \fIverbose\fR mode.
Without category specification, all categories except net-all are enabled.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fB-q\fR, \fB--quiet\fR
revamp console output options - the old meaning of -V[V] was moved to -D{n|N}, as these are really debugging options. - don't print the info messages by default; this can be re-enabled with the -V switch, and is implied by most debug options (it was really kind of stupid that verbose/debug operation disabled these). - the sync algo/state debugging can be separately enabled with -Ds now.
2015-03-23 07:42:51 +00:00
Suppress progress counters (this is implicit if stdout is no TTY,
or any debugging categories are enabled) and notices.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
If specified twice, suppress warning messages as well.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH CONFIGURATION
The configuration file is mandatory; \fBmbsync\fR will not run without it.
Lines starting with a hash mark (\fB#\fR) are comments and are ignored entirely.
Configuration items are keywords followed by one or more arguments;
support backslash-escaping in the config file note that no attempt is made at making this work in the compat wrapper.
2013-09-25 18:56:52 +00:00
arguments containing spaces must be enclosed in double quotes (\fB"\fR),
and literal double quotes and backslashes (\fB\\\fR) must be backslash-escaped.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
All keywords (including those used as arguments) are case-insensitive.
make paths relative to CWD, after all the test suite actually relies on it. it would be possible to adjust it, but there is not much reason to make paths relative to HOME (as we support convenient tilde expansion). so use the least invasive approach, which is simply the old behavior. adjust the documentation accordingly. This reverts commit da5ce5d8f42a15a2842d6d14043452f1a7892a0a.
2013-03-30 13:14:23 +00:00
Bash-like home directory expansion using the tilde (\fB~\fR) is supported
in all options which represent local paths.
improve wording in man page
2020-10-05 11:16:51 +00:00
There are a few global options, the others apply to particular sections.
Sections begin with a section-starting keyword and are terminated by an empty
line or end of file.
pre-release doc updates
2012-08-26 13:17:38 +00:00
Every section defines an object with an identifier unique within that
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
object class.
.P
There are two basic object classes: Stores and Channels. A Store defines
a collection of mailboxes; basically a folder, either local or remote.
A Channel connects two Stores, describing the way the two are synchronized.
.br
There are two auxiliary object classes: Accounts and Groups. An Account
improve wording in man page
2020-10-05 11:16:51 +00:00
describes the connection part of network Stores, so server configurations can
be shared between multiple Stores. A Group aggregates multiple Channels to
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
save typing on the command line.
add support for hierarchical mailboxes
2012-08-11 16:34:46 +00:00
.P
File system locations (in particular, \fBPath\fR and \fBInbox\fR) use the
Store's internal path separators, which may be slashes, periods, etc., or
even combinations thereof.
.br
Mailbox names, OTOH, always use canonical path separators, which are
Unix-like forward slashes.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SS All Stores
These options can be used in all supported Store types.
.br
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
The term "opposite Store" refers to the other Store within a Channel.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
The special mailbox \fBINBOX\fR exists in every Store; its physical location
in the file system is Store type specific.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBPath\fR \fIpath\fR
The location of the Store in the (server's) file system.
If this is no absolute path, the reference point is Store type specific.
This string is prepended to the mailbox names addressed in this Store,
but is not considered part of them; this is important for \fBPatterns\fR
improve wording in man page
2020-10-05 11:16:51 +00:00
and \fBCreate\fR in the Channels section.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Note that you \fBmust\fR append a slash if you want to specify an entire
directory.
permit IMAP Stores with explicitly empty Path this is useful if the server sends an unhelpful NAMESPACE like "INBOX." (which precludes clean use of Patterns with the real INBOX).
2014-10-04 11:12:50 +00:00
(Default: none)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBMaxSize\fR \fIsize\fR[\fBk\fR|\fBm\fR][\fBb\fR]
create placeholders for messages over MaxSize this is vastly more useful than just omitting the messages with no indication at all.
2019-12-29 13:37:53 +00:00
Messages larger than \fIsize\fR will have only a small placeholder message
propagated into this Store. To propagate the full message, it must be
flagged in either Store; that can be done retroactively, in which case
the \fBReNew\fR operation needs to be executed instead of \fBNew\fR.
This is useful for avoiding downloading messages with large attachments
unless they are actually needed.
Caveat: Setting a size limit on a Store you never read directly (which is
typically the case for servers) is not recommended, as you may never
notice that affected messages were not propagated to it.
.br
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
\fBK\fR and \fBM\fR can be appended to the size to specify KiBytes resp.
typos
2006-02-05 17:42:22 +00:00
MeBytes instead of bytes. \fBB\fR is accepted but superfluous.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
If \fIsize\fR is 0, the maximum message size is \fBunlimited\fR.
(Default: \fI0\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBMapInbox\fR \fImailbox\fR
clarify wording in MapInbox doc
2013-12-13 18:07:05 +00:00
Create a virtual mailbox (relative to \fBPath\fR) which aliases
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
the \fBINBOX\fR. Makes sense in conjunction with \fBPatterns\fR in the
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
Channels section, though with a Maildir near side, you probably want to
discourage use of MapInbox
2013-04-07 14:54:19 +00:00
place \fBInbox\fR under \fBPath\fR instead.
add support for hierarchical mailboxes
2012-08-11 16:34:46 +00:00
This virtual mailbox does not support subfolders.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
introduce ability to flatten the hierarchy of Stores
2012-08-18 11:58:14 +00:00
\fBFlatten\fR \fIdelim\fR
Flatten the hierarchy within this Store by substituting the canonical
hierarchy delimiter \fB/\fR with \fIdelim\fR.
This can be useful when the MUA used to access the Store provides
suboptimal handling of hierarchical mailboxes, as is the case with
\fBMutt\fR.
A common choice for the delimiter is \fB.\fR.
man page fixups
2013-04-13 17:05:44 +00:00
.br
Note that flattened sub-folders of the \fBINBOX\fR always end up
under \fBPath\fR, including the "INBOX\fIdelim\fR" prefix.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
introduce ability to flatten the hierarchy of Stores
2012-08-18 11:58:14 +00:00
.TP
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
\fBTrash\fR \fImailbox\fR
Specifies a mailbox (relative to \fBPath\fR) to copy deleted messages to
elaborate on expunging and trashing
2013-12-14 11:37:11 +00:00
prior to expunging.
See \fBRECOMMENDATIONS\fR and \fBINHERENT PROBLEMS\fR below.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
(Default: none)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBTrashNewOnly\fR \fByes\fR|\fBno\fR
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
When trashing, copy only not yet propagated messages. This makes sense if the
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
opposite Store has a \fBTrash\fR as well (with \fBTrashNewOnly\fR \fBno\fR).
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Default: \fBno\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBTrashRemoteNew\fR \fByes\fR|\fBno\fR
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
When expunging the opposite Store, copy not yet propagated messages to this
Store's \fBTrash\fR.
When using this, the opposite Store does not need an own \fBTrash\fR at all,
yet all messages are archived.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Default: \fBno\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SS Maildir Stores
make paths relative to CWD, after all the test suite actually relies on it. it would be possible to adjust it, but there is not much reason to make paths relative to HOME (as we support convenient tilde expansion). so use the least invasive approach, which is simply the old behavior. adjust the documentation accordingly. This reverts commit da5ce5d8f42a15a2842d6d14043452f1a7892a0a.
2013-03-30 13:14:23 +00:00
The reference point for relative \fBPath\fRs is the current working directory.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.P
As \fBmbsync\fR needs UIDs, but no standardized UID storage scheme exists for
Maildir, \fBmbsync\fR supports two schemes, each with its pros and cons.
.br
The \fBnative\fR scheme is stolen from the latest Maildir patches to \fBc-client\fR
and is therefore compatible with \fBpine\fR. The UID validity is stored in a
file named .uidvalidity; the UIDs are encoded in the file names of the messages.
.br
The \fBalternative\fR scheme is based on the UID mapping used by \fBisync\fR
versions 0.8 and 0.9.x. The invariant parts of the file names of the messages
are used as keys into a Berkeley database named .isyncuidmap.db, which holds
the UID validity as well.
.br
fix typos
2014-01-25 12:19:02 +00:00
The \fBnative\fR scheme is faster, more space efficient, endianness independent
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
and "human readable", but will be disrupted if a message is copied from another
mailbox without getting a new file name; this would result in duplicated UIDs
sooner or later, which in turn results in a UID validity change, making
synchronization fail.
The \fBalternative\fR scheme would fail if a MUA changed a message's file name
in a part \fBmbsync\fR considers invariant; this would be interpreted as a
message deletion and a new message, resulting in unnecessary traffic.
.br
\fBMutt\fR is known to work fine with both schemes.
.br
Use \fBmdconvert\fR to convert mailboxes from one scheme to the other.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBMaildirStore\fR \fIname\fR
Define the Maildir Store \fIname\fR, opening a section for its parameters.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBAltMap\fR \fByes\fR|\fBno\fR
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Use the \fBalternative\fR UID storage scheme for mailboxes in this Store.
This does not affect mailboxes that do already have a UID storage scheme;
use \fBmdconvert\fR to change it.
mention the need for renaming Maildir files upon move mu4e config line offered by Ben Maughan <benmaughan@gmail.com>.
2017-08-05 18:24:11 +00:00
See \fBRECOMMENDATIONS\fR below.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Default: \fBno\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBInbox\fR \fIpath\fR
discourage use of MapInbox
2013-04-07 14:54:19 +00:00
The location of the \fBINBOX\fR. This is \fInot\fR relative to \fBPath\fR,
but it is allowed to place the \fBINBOX\fR inside the \fBPath\fR.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
(Default: \fI~/Maildir\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
introduce FieldDelimiter and InfoDelimiter options ... for windows fs compatibility. the maildir-specific InfoDelimiter inherits the global FieldDelimiter (which affects SyncState), based on the assumption that if the sync state is on a windows FS, the mailboxes certainly will be as well, while the inverse is not necessarily true (when running on unix, anyway). REFMAIL: <CA+m_8J1ynqAjHRJagvKt9sb31yz047Q7NH-ODRmHOKyfru8vtA@mail.gmail.com>
2014-10-25 15:30:57 +00:00
.TP
\fBInfoDelimiter\fR \fIdelim\fR
The character used to delimit the info field from a message's basename.
The Maildir standard defines this to be the colon, but this is incompatible
with DOS/Windows file systems.
(Default: the value of \fBFieldDelimiter\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
support verbatim and real Maildir++ subfolder naming styles the legacy style is a poorly executed attempt at Maildir++, so introduce the latter for the sake of completeness. but most users will probably just want to use subfolders without any additional dots.
2015-05-01 17:16:23 +00:00
.TP
\fBSubFolders\fR \fBVerbatim\fR|\fBMaildir++\fR|\fBLegacy\fR
The on-disk folder naming style used for hierarchical mailboxes.
wording fixes in mbsync.1 inspired by Ulrich Ölmann <u.oelmann@pengutronix.de>.
2019-09-10 11:00:18 +00:00
This option has no effect when \fBFlatten\fR is used.
support verbatim and real Maildir++ subfolder naming styles the legacy style is a poorly executed attempt at Maildir++, so introduce the latter for the sake of completeness. but most users will probably just want to use subfolders without any additional dots.
2015-05-01 17:16:23 +00:00
.br
fix SubFolders style Maildir++ turns out i misread the spec in a subtle way: while all other folders are physically nested under INBOX, the IMAP view puts them at the same (root) level. to get them shown as subfolders of INBOX, they need to have _two_ leading dots. this also implies that the Maildir++ mode has no use for a Path, so reject attempts to specify one.
2016-11-04 15:21:09 +00:00
Suppose mailboxes with the canonical paths \fBtop/sub/subsub\fR and
\fBINBOX/sub/subsub\fR, the styles will yield the following on-disk paths:
support verbatim and real Maildir++ subfolder naming styles the legacy style is a poorly executed attempt at Maildir++, so introduce the latter for the sake of completeness. but most users will probably just want to use subfolders without any additional dots.
2015-05-01 17:16:23 +00:00
.br
fix SubFolders style Maildir++ turns out i misread the spec in a subtle way: while all other folders are physically nested under INBOX, the IMAP view puts them at the same (root) level. to get them shown as subfolders of INBOX, they need to have _two_ leading dots. this also implies that the Maildir++ mode has no use for a Path, so reject attempts to specify one.
2016-11-04 15:21:09 +00:00
\fBVerbatim\fR - \fIPath\fB/top/sub/subsub\fR and \fIInbox\fB/sub/subsub\fR
support verbatim and real Maildir++ subfolder naming styles the legacy style is a poorly executed attempt at Maildir++, so introduce the latter for the sake of completeness. but most users will probably just want to use subfolders without any additional dots.
2015-05-01 17:16:23 +00:00
(this is the style you probably want to use)
.br
fix SubFolders style Maildir++ turns out i misread the spec in a subtle way: while all other folders are physically nested under INBOX, the IMAP view puts them at the same (root) level. to get them shown as subfolders of INBOX, they need to have _two_ leading dots. this also implies that the Maildir++ mode has no use for a Path, so reject attempts to specify one.
2016-11-04 15:21:09 +00:00
\fBMaildir++\fR - \fIInbox\fB/.top.sub.subsub\fR and \fIInbox\fB/..sub.subsub\fR
support verbatim and real Maildir++ subfolder naming styles the legacy style is a poorly executed attempt at Maildir++, so introduce the latter for the sake of completeness. but most users will probably just want to use subfolders without any additional dots.
2015-05-01 17:16:23 +00:00
(this style is compatible with Courier and Dovecot - but note that
fix SubFolders style Maildir++ turns out i misread the spec in a subtle way: while all other folders are physically nested under INBOX, the IMAP view puts them at the same (root) level. to get them shown as subfolders of INBOX, they need to have _two_ leading dots. this also implies that the Maildir++ mode has no use for a Path, so reject attempts to specify one.
2016-11-04 15:21:09 +00:00
the mailbox metadata format is \fInot\fR compatible).
Note that attempts to set \fBPath\fR are rejected in this mode.
support verbatim and real Maildir++ subfolder naming styles the legacy style is a poorly executed attempt at Maildir++, so introduce the latter for the sake of completeness. but most users will probably just want to use subfolders without any additional dots.
2015-05-01 17:16:23 +00:00
.br
fix SubFolders style Maildir++ turns out i misread the spec in a subtle way: while all other folders are physically nested under INBOX, the IMAP view puts them at the same (root) level. to get them shown as subfolders of INBOX, they need to have _two_ leading dots. this also implies that the Maildir++ mode has no use for a Path, so reject attempts to specify one.
2016-11-04 15:21:09 +00:00
\fBLegacy\fR - \fIPath\fB/top/.sub/.subsub\fR and \fIInbox\fB/.sub/.subsub\fR
support verbatim and real Maildir++ subfolder naming styles the legacy style is a poorly executed attempt at Maildir++, so introduce the latter for the sake of completeness. but most users will probably just want to use subfolders without any additional dots.
2015-05-01 17:16:23 +00:00
(this is \fBmbsync\fR's historical style)
.br
(Default: unset; will error out when sub-folders are encountered)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SS IMAP4 Accounts
.TP
\fBIMAPAccount\fR \fIname\fR
Define the IMAP4 Account \fIname\fR, opening a section for its parameters.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
un-document "Host imaps:[...]" syntax and introduce new option UseIMAPS instead. apply ted's patch to support UseIMAPS in conjunction with Tunnel. document that SSLv2 is No Good (TM).
2006-05-28 15:43:58 +00:00
\fBHost\fR \fIhost\fR
Specify the DNS name or IP address of the IMAP server.
clarify effect of Tunnel on Host and Port
2014-07-05 20:53:19 +00:00
.br
require Host if SSL is used despite Tunnel
2014-07-27 16:10:26 +00:00
If \fBTunnel\fR is used, this setting is needed only if \fBSSLType\fR is
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
not \fBNone\fR and \fBCertificateFile\fR is not used,
require Host if SSL is used despite Tunnel
2014-07-27 16:10:26 +00:00
in which case the host name is used for certificate subject verification.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBPort\fR \fIport\fR
un-document "Host imaps:[...]" syntax and introduce new option UseIMAPS instead. apply ted's patch to support UseIMAPS in conjunction with Tunnel. document that SSLv2 is No Good (TM).
2006-05-28 15:43:58 +00:00
Specify the TCP port number of the IMAP server. (Default: 143 for IMAP,
993 for IMAPS)
clarify effect of Tunnel on Host and Port
2014-07-05 20:53:19 +00:00
.br
If \fBTunnel\fR is used, this setting is ignored.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
add socket timeout handling
2015-04-06 14:49:33 +00:00
\fBTimeout\fR \fItimeout\fR
Specify the connect and data timeout for the IMAP server in seconds.
Zero means unlimited.
(Default: \fI20\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add socket timeout handling
2015-04-06 14:49:33 +00:00
.TP
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
\fBUser\fR \fIusername\fR
don't lie about the default of User unlike the isync wrapper, mbsync does not have a default for the IMAP user. the remote user seldomly matches the local one, so "forwarding" it is more confusing than helpful. CCMAIL: 744389@bugs.debian.org
2014-04-13 15:07:53 +00:00
Specify the login name on the IMAP server.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
add ability to script IMAP user query It was already possible to retrieve passwords from arbitrary commands. But this goes only half the way to allowing automated derivation of login credentials, as some environments may also have different user names based on the system. Therefore, add the UserCmd option to complement PassCmd. Based on a patch series by Patrick Steinhardt <ps@pks.im>
2019-11-26 11:17:33 +00:00
\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.
improve docu for {Pass,User}Cmd
2020-12-12 13:56:27 +00:00
.br
add ability to script IMAP user query It was already possible to retrieve passwords from arbitrary commands. But this goes only half the way to allowing automated derivation of login credentials, as some environments may also have different user names based on the system. Therefore, add the UserCmd option to complement PassCmd. Based on a patch series by Patrick Steinhardt <ps@pks.im>
2019-11-26 11:17:33 +00:00
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.
improve docu for {Pass,User}Cmd
2020-12-12 13:56:27 +00:00
Remember to backslash-escape double quotes and backslashes embedded into
the command.
add ability to script IMAP user query It was already possible to retrieve passwords from arbitrary commands. But this goes only half the way to allowing automated derivation of login credentials, as some environments may also have different user names based on the system. Therefore, add the UserCmd option to complement PassCmd. Based on a patch series by Patrick Steinhardt <ps@pks.im>
2019-11-26 11:17:33 +00:00
.
.TP
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
\fBPass\fR \fIpassword\fR
Specify the password for \fIusername\fR on the IMAP server.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
Note that this option is \fInot\fR required.
add PassCmd option to query IMAP password dynamically inspired by patches by Aurélien Francillon <aurelien.francillon@eurecom.fr>, Martin Stenberg <martin@gnutiken.se> and sbfnk@users.sf.net.
2013-07-27 08:37:15 +00:00
If neither a password nor a password command is specified in the
configuration file, \fBmbsync\fR will prompt you for a password.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add PassCmd option to query IMAP password dynamically inspired by patches by Aurélien Francillon <aurelien.francillon@eurecom.fr>, Martin Stenberg <martin@gnutiken.se> and sbfnk@users.sf.net.
2013-07-27 08:37:15 +00:00
.TP
don't insert unnecessary linebreaks upon PassCmd invocation the PassCmd will be typically non-interactive (or it will use a gui password agent), so starting a new line just makes the progress counter uglier. so make it configurable and default to no line break.
2015-03-30 12:52:02 +00:00
\fBPassCmd\fR [\fB+\fR]\fIcommand\fR
add PassCmd option to query IMAP password dynamically inspired by patches by Aurélien Francillon <aurelien.francillon@eurecom.fr>, Martin Stenberg <martin@gnutiken.se> and sbfnk@users.sf.net.
2013-07-27 08:37:15 +00:00
Specify a shell command to obtain a password rather than specifying a
password directly. This allows you to use password files and agents.
improve docu for {Pass,User}Cmd
2020-12-12 13:56:27 +00:00
.br
See \fBUserCmd\fR above for details.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
add option to get password from macOS Keychain this is better than using PassCmd, as it allows the keychain manager to identify the calling process and therefore use a selective whitelist. unlike in the now removed example, we use an "internet password" for the imap protocol, rather than a "generic password" - this seems more appropriate. based on a patch by Oliver Runge <oliver.runge@gmail.com>
2019-11-27 16:13:44 +00:00
\fBUseKeychain\fR \fByes\fR|\fBno\fR
Whether to use the macOS Keychain to obtain the password.
(Default: \fBno\fR)
.IP
The neccessary keychain item can be created this way:
.RS
.IP
.nh
.B security add-internet-password \-r imap \-s
.I Host
.B \-a
.I User
.B \-w
.I password
[
.B \-T
.I /path/to/mbsync
]
.hy
.RE
.
.TP
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
\fBTunnel\fR \fIcommand\fR
Specify a command to run to establish a connection rather than opening a TCP
socket. This allows you to run an IMAP session over an SSH tunnel, for
be *slightly* more explicit about which options Tunnel makes superfluous.
2006-05-28 16:02:56 +00:00
example.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
rework authentication mechanism configuration RequireCRAM (another fairly stupid "use if available" option) is now deprecated. instead, the AuthMech option can be used to give a precise list of acceptable authentication mechanisms (which is currently "a bit" short). in particular, this allows *not* using CRAM-MD5 even if it's available.
2014-07-12 19:02:25 +00:00
\fBAuthMechs\fR \fItype\fR ...
The list of acceptable authentication mechanisms.
In addition to the mechanisms listed in the SASL registry (link below),
the legacy IMAP \fBLOGIN\fR mechanism is known.
The wildcard \fB*\fR represents all mechanisms that are deemed secure
enough for the current \fBSSLType\fR setting.
The actually used mechanism is the most secure choice from the intersection
add SASL support patch initially by Jack Stone <jwjstone@fastmail.fm>, cleaned up by Jan Synacek <jsynacek@redhat.com>, ... and then almost completely rewritten by me. ^^
2014-07-27 16:41:22 +00:00
of this list, the list supplied by the server, and the installed SASL modules.
rework authentication mechanism configuration RequireCRAM (another fairly stupid "use if available" option) is now deprecated. instead, the AuthMech option can be used to give a precise list of acceptable authentication mechanisms (which is currently "a bit" short). in particular, this allows *not* using CRAM-MD5 even if it's available.
2014-07-12 19:02:25 +00:00
(Default: \fB*\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBSSLType\fR {\fBNone\fR|\fBSTARTTLS\fR|\fBIMAPS\fR}
re-design SSL/TLS configuration the combinations of the various options made quite a mess. additionally, 'RequireSSL no' is inherently insecure - "use SSL if available" is plain stupid. the old options are still accepted, but will elicit a warning.
2014-07-12 18:35:55 +00:00
Select the connection security/encryption method:
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBNone\fR - no security.
re-design SSL/TLS configuration the combinations of the various options made quite a mess. additionally, 'RequireSSL no' is inherently insecure - "use SSL if available" is plain stupid. the old options are still accepted, but will elicit a warning.
2014-07-12 18:35:55 +00:00
This is the default when \fBTunnel\fR is set, as tunnels are usually secure.
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBSTARTTLS\fR - security is established via the STARTTLS extension
re-design SSL/TLS configuration the combinations of the various options made quite a mess. additionally, 'RequireSSL no' is inherently insecure - "use SSL if available" is plain stupid. the old options are still accepted, but will elicit a warning.
2014-07-12 18:35:55 +00:00
after connecting the regular IMAP port 143. Most servers support this,
so it is the default (unless a tunnel is used).
un-document "Host imaps:[...]" syntax and introduce new option UseIMAPS instead. apply ted's patch to support UseIMAPS in conjunction with Tunnel. document that SSLv2 is No Good (TM).
2006-05-28 15:43:58 +00:00
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBIMAPS\fR - security is established by starting SSL/TLS negotiation
re-design SSL/TLS configuration the combinations of the various options made quite a mess. additionally, 'RequireSSL no' is inherently insecure - "use SSL if available" is plain stupid. the old options are still accepted, but will elicit a warning.
2014-07-12 18:35:55 +00:00
right after connecting the secure IMAP port 993.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
un-document "Host imaps:[...]" syntax and introduce new option UseIMAPS instead. apply ted's patch to support UseIMAPS in conjunction with Tunnel. document that SSLv2 is No Good (TM).
2006-05-28 15:43:58 +00:00
.TP
add support for (disabling) TLS v1.3 this is actually potentially counterproductive, as people who have set SSLVersions and fail to adjust it will _lose_ tls 1.3 support. however, without the option being there, people (incorrectly) believe that tls 1.3 is not supported.
2019-11-26 15:05:46 +00:00
\fBSSLVersions\fR [\fBSSLv3\fR] [\fBTLSv1\fR] [\fBTLSv1.1\fR] [\fBTLSv1.2\fR] [\fBTLSv1.3\fR]
re-design SSL/TLS configuration the combinations of the various options made quite a mess. additionally, 'RequireSSL no' is inherently insecure - "use SSL if available" is plain stupid. the old options are still accepted, but will elicit a warning.
2014-07-12 18:35:55 +00:00
Select the acceptable SSL/TLS versions.
enable TLS 1.1 and 1.2 by default there is no reason not to, and debian even disabled 1.0 globally, because it's (theoretically) too insecure in some contexts (BEAST attack). in the compat wrapper, the UseTLSv1 option has been re-interpreted as v1.x, to avoid adding new options.
2017-08-11 06:50:28 +00:00
Use old versions only when the server has problems with newer ones.
add support for (disabling) TLS v1.3 this is actually potentially counterproductive, as people who have set SSLVersions and fail to adjust it will _lose_ tls 1.3 support. however, without the option being there, people (incorrectly) believe that tls 1.3 is not supported.
2019-11-26 15:05:46 +00:00
(Default: [\fBTLSv1\fR] [\fBTLSv1.1\fR] [\fBTLSv1.2\fR] [\fBTLSv1.3\fR]).
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBSystemCertificates\fR \fByes\fR|\fBno\fR
improve documentation of the server certificate related options
2019-11-18 17:57:38 +00:00
Whether the system's default CA (certificate authority) certificate
store should be used to verify certificate trust chains. Disable this
if you want to trust only hand-picked certificates.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Default: \fByes\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
make it possible to disable usage of system cert store
2014-07-27 13:42:33 +00:00
.TP
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
\fBCertificateFile\fR \fIpath\fR
rewrite SSL certificate verification. again. leave all the hard work to OpenSSL. this has several consequences: - certificate chain validation actually works instead of throwing around error 20 - the interactive approval is gone. i don't expect it to be useful anyway, as mbsync is mostly a batch tool - the code is much shorter
2013-03-17 11:41:47 +00:00
File containing additional X.509 certificates used to verify server
improve documentation of the server certificate related options
2019-11-18 17:57:38 +00:00
identities.
unbreak CertificateFile documentation the file may in fact contain CA certs. amends 7d9d3e15.
2020-08-02 18:05:42 +00:00
It may contain two types of certificates:
.RS
.IP Host
These certificates are matched only against the received server certificate
itself.
They are always trusted, regardless of validity.
A typical use case would be forcing acceptance of an expired certificate.
rewrite SSL certificate verification. again. leave all the hard work to OpenSSL. this has several consequences: - certificate chain validation actually works instead of throwing around error 20 - the interactive approval is gone. i don't expect it to be useful anyway, as mbsync is mostly a batch tool - the code is much shorter
2013-03-17 11:41:47 +00:00
.br
unbreak CertificateFile documentation the file may in fact contain CA certs. amends 7d9d3e15.
2020-08-02 18:05:42 +00:00
These certificates may be obtained using the \fBmbsync-get-cert\fR tool;
make sure to verify their fingerprints before trusting them, or transfer
them securely from the server's network (if it can be trusted beyond the
server itself).
.IP CA
These certificates are used as trust anchors when building the certificate
chain for the received server certificate.
They are used to supplant or supersede the system's trust store, depending
on the \fBSystemCertificates\fR setting;
it is not necessary and not recommended to specify the system's trust store
itself here.
The trust chains are fully validated.
.RE
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
add support for sending a TLS client certificate
2015-08-08 17:45:53 +00:00
\fBClientCertificate\fR \fIpath\fR
File containing a client certificate to send to the server.
\fBClientKey\fR should also be specified.
.br
Note that client certificate verification is usually not required,
so it is unlikely that you need this option.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add support for sending a TLS client certificate
2015-08-08 17:45:53 +00:00
.TP
\fBClientKey\fR \fIpath\fR
File containing the private key corresponding to \fBClientCertificate\fR.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add support for sending a TLS client certificate
2015-08-08 17:45:53 +00:00
.TP
Add support for specifying cipher string used for ssl connection Some distributions (e.g. Fedora) added support for system wide crypto policies. This is supported in most common crypto libraries including OpenSSL. Applications can override this policy using their own cipher string. This commit adds support for specifying the cipher string in the mbsync configuration. For example, to exclude Diffie-Hellman, the user can specify CipherString "DEFAULT:!DH" in the IMAP Account's configuration.
2019-11-09 18:47:55 +00:00
\fBCipherString\fR \fIstring\fR
Specify OpenSSL cipher string for connections secured with TLS up to
version 1.2 (but not 1.3 and above).
The format is described in \fBciphers\fR\|(1).
(Default: empty, which implies system wide policy).
.
.TP
make IMAP pipeline depth configurable currently, this affects only "clustered" message listings and flag stores.
2011-03-27 14:58:23 +00:00
\fBPipelineDepth\fR \fIdepth\fR
Maximum number of IMAP commands which can be simultaneously in flight.
Setting this to \fI1\fR disables pipelining.
document some additional uses for PipelineDepth
2016-11-12 13:15:57 +00:00
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.
fully asynchronous IMAP operation - asynchronous sockets using an event loop - connect & starttls have completion callback parameters - callbacks for notification about filled input buffer and emptied output buffer - unsent imap command queue - used when - socket output buffer is non-empty - number of commands in flight exceeds limit - last sent command requires round-trip - command has a dependency on completion of previous command - trashnc is tri-state so only a single "scout" trash APPEND/COPY is sent at first. a possibly resulting CREATE is injected in front of the remaining trash commands, so they can succeed (or be cancel()d if it fails). - queue's presence necessitates imap_cancel implementation
2012-08-25 16:26:23 +00:00
(Default: \fIunlimited\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add DisableExtension option to work around (server) bugs
2015-05-08 08:20:09 +00:00
.TP
\fBDisableExtension\fR[\fBs\fR] \fIextension\fR ...
Disable the use of specific IMAP extensions.
This can be used to work around bugs in servers
(and possibly \fBmbsync\fR itself).
(Default: empty)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SS IMAP Stores
The reference point for relative \fBPath\fRs is whatever the server likes it
to be; probably the user's $HOME or $HOME/Mail on that server. The location
of \fBINBOX\fR is up to the server as well and is usually irrelevant.
.TP
\fBIMAPStore\fR \fIname\fR
Define the IMAP4 Store \fIname\fR, opening a section for its parameters.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBAccount\fR \fIaccount\fR
Specify which IMAP4 Account to use. Instead of defining an Account and
referencing it here, it is also possible to specify all the Account options
directly in the Store's section - this makes sense if an Account is used for
one Store only anyway.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBUseNamespace\fR \fByes\fR|\fBno\fR
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Selects whether the server's first "personal" NAMESPACE should be prefixed to
mailbox names. Disabling this makes sense for some broken IMAP servers.
This option is meaningless if a \fBPath\fR was specified.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Default: \fByes\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add support for hierarchical mailboxes
2012-08-11 16:34:46 +00:00
.TP
\fBPathDelimiter\fR \fIdelim\fR
support multi-character path separators this applies to both the IMAP PathDelimiter (which is needed by Lotus Domino), as well as the Flatten-ed separators.
2013-08-03 13:10:57 +00:00
Specify the server's hierarchy delimiter.
add support for hierarchical mailboxes
2012-08-11 16:34:46 +00:00
(Default: taken from the server's first "personal" NAMESPACE)
introduce ability to flatten the hierarchy of Stores
2012-08-18 11:58:14 +00:00
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
Do \fInot\fR abuse this to re-interpret the hierarchy.
introduce ability to flatten the hierarchy of Stores
2012-08-18 11:58:14 +00:00
Use \fBFlatten\fR instead.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
Add option to use IMAP LSUB instead of LIST Based on patch by Cedric Ware <cedric.ware__bml@normalesup.org>
2019-11-26 14:49:19 +00:00
.TP
\fBSubscribedOnly\fR \fByes\fR|\fBno\fR
Selects whether to synchronize only mailboxes that are subscribed to on the
IMAP server. In technical terms, if this option is set, \fBmbsync\fR will use
the IMAP command LSUB instead of LIST to look for mailboxes in this Store.
This option make sense only in conjunction with \fBPatterns\fR.
(Default: \fBno\fR)
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SS Channels
.TP
\fBChannel\fR \fIname\fR
Define the Channel \fIname\fR, opening a section for its parameters.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
{\fBFar\fR|\fBNear\fR} \fB:\fIstore\fB:\fR[\fImailbox\fR]
Specify the far resp. near side Store to be connected by this Channel.
allow prefixes to Patterns this makes it possible to "rename" a "namespace" while syncing.
2013-12-08 08:49:39 +00:00
If \fBPatterns\fR are specified, \fImailbox\fR is interpreted as a
prefix which is not matched against the patterns, and which is not
affected by mailbox list overrides.
refuse box list overrides if Channel has no Patterns as the named boxes are the same on both sides, they logically make sense only when the channel is in that mode anyway, which is the case when using patterns.
2013-12-07 15:41:05 +00:00
Otherwise, if \fImailbox\fR is omitted, \fBINBOX\fR is assumed.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBPattern\fR[\fBs\fR] [\fB!\fR]\fIpattern\fR ...
Instead of synchronizing only one mailbox pair, synchronize all mailboxes
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
that match the \fIpattern\fR(s). The mailbox names are the same on the far
and near side. Patterns are IMAP4 patterns, i.e., \fB*\fR matches anything
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
and \fB%\fR matches anything up to the next hierarchy delimiter. Prepending
\fB!\fR to a pattern makes it an exclusion. Multiple patterns can be specified
(either by supplying multiple arguments or by using \fBPattern\fR multiple
times); later matches take precedence.
don't let wildcards match INBOX, unless it lives under Path it's counter-intuitive to have '*' match the (always present) INBOX when the rest of the mailboxes lives in a different namespace.
2013-04-13 17:05:27 +00:00
.br
Note that \fBINBOX\fR is not matched by wildcards, unless it lives under
\fBPath\fR.
.br
refuse box list overrides if Channel has no Patterns as the named boxes are the same on both sides, they logically make sense only when the channel is in that mode anyway, which is the case when using patterns.
2013-12-07 15:41:05 +00:00
The mailbox list selected by \fBPatterns\fR can be overridden by a mailbox
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
list in a Channel reference (a \fBGroup\fR specification or the command line).
refuse box list overrides if Channel has no Patterns as the named boxes are the same on both sides, they logically make sense only when the channel is in that mode anyway, which is the case when using patterns.
2013-12-07 15:41:05 +00:00
.br
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Example: "\fBPatterns\fR\ \fI%\ !Trash\fR"
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBMaxSize\fR \fIsize\fR[\fBk\fR|\fBm\fR][\fBb\fR]
Analogous to the homonymous option in the Stores section, but applies equally
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
to Far and Near. Note that this actually modifies the Stores, so take care
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
not to provide conflicting settings if you use the Stores in multiple Channels.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBMaxMessages\fR \fIcount\fR
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
Sets the maximum number of messages to keep in each near side mailbox.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
This is useful for mailboxes where you keep a complete archive on the server,
but want to mirror only the last messages (for instance, for mailing lists).
The messages that were the first to arrive in the mailbox (independently of
the actual date of the message) will be deleted first.
add ExpireUnread option
2013-11-24 19:26:33 +00:00
Messages that are flagged (marked as important) and (by default) unread
messages will not be automatically deleted.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
If \fIcount\fR is 0, the maximum number of messages is \fBunlimited\fR
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
(Global default: \fI0\fR).
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBExpireUnread\fR \fByes\fR|\fBno\fR
add ExpireUnread option
2013-11-24 19:26:33 +00:00
Selects whether unread messages should be affected by \fBMaxMessages\fR.
Normally, unread messages are considered important and thus never expired.
This ensures that you never miss new messages even after an extended absence.
However, if your archive contains large amounts of unread messages by design,
treating them as important would practically defeat \fBMaxMessages\fR. In this
case you need to enable this option.
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
(Global default: \fBno\fR).
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add ExpireUnread option
2013-11-24 19:26:33 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBSync\fR {\fBNone\fR|[\fBPull\fR] [\fBPush\fR] [\fBNew\fR] [\fBReNew\fR] [\fBDelete\fR] [\fBFlags\fR]|\fBAll\fR}
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Select the synchronization operation(s) to perform:
.br
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fBPull\fR - propagate changes from far to near side.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fBPush\fR - propagate changes from near to far side.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBNew\fR - propagate newly appeared messages.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
create placeholders for messages over MaxSize this is vastly more useful than just omitting the messages with no indication at all.
2019-12-29 13:37:53 +00:00
\fBReNew\fR - upgrade placeholders to full messages. Useful only with
a configured \fBMaxSize\fR.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBDelete\fR - propagate message deletions. This applies only to messages that
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
are actually gone, i.e., were expunged. The affected messages in the opposite
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Store are marked as deleted only, i.e., they won't be really deleted until
that Store is expunged.
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBFlags\fR - propagate flag changes. Note that Deleted/Trashed is a flag as
fix typos
2014-01-25 12:19:02 +00:00
well; this is particularly interesting if you use \fBmutt\fR with the
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
maildir_trash option.
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBAll\fR (\fB--full\fR on the command line) - all of the above.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
This is the global default.
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBNone\fR (\fB--noop\fR on the command line) - don't propagate anything.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Useful if you want to expunge only.
.IP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBPull\fR and \fBPush\fR are direction flags, while \fBNew\fR, \fBReNew\fR,
\fBDelete\fR and \fBFlags\fR are type flags. The two flag classes make up a
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
two-dimensional matrix (a table). Its cells are the individual actions to
perform. There are two styles of asserting the cells:
.br
In the first style, the flags select entire rows/colums in the matrix. Only
the cells which are selected both horizontally and vertically are asserted.
Specifying no flags from a class is like specifying all flags from this class.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
For example, "\fBSync\fR\ \fBPull\fR\ \fBNew\fR\ \fBFlags\fR" will propagate
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
new messages and flag changes from the far side to the near side,
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
"\fBSync\fR\ \fBNew\fR\ \fBDelete\fR" will propagate message arrivals and
deletions both ways, and "\fBSync\fR\ \fBPush\fR" will propagate all changes
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
from the near side to the far side.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
In the second style, direction flags are concatenated with type flags; every
compound flag immediately asserts a cell in the matrix. In addition to at least
one compound flag, the individual flags can be used as well, but as opposed to
the first style, they immediately assert all cells in their respective
row/column. For example,
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
"\fBSync\fR\ \fBPullNew\fR\ \fBPullDelete\fR\ \fBPush\fR" will propagate
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
message arrivals and deletions from the far side to the near side and any
changes from the near side to the far side.
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
.br
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Note that it is not allowed to assert a cell in two ways, e.g.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
"\fBSync\fR\ \fBPullNew\fR\ \fBPull\fR" and
"\fBSync\fR\ \fBPullNew\fR\ \fBDelete\fR\ \fBPush\fR" induce error messages.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fBCreate\fR {\fBNone\fR|\fBFar\fR|\fBNear\fR|\fBBoth\fR}
Automatically create missing mailboxes [on the far/near side].
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
Otherwise print an error message and skip that mailbox pair if a mailbox
add support for propagating folder deletions
2014-12-29 01:08:48 +00:00
and the corresponding sync state does not exist.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Global default: \fBNone\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add support for propagating folder deletions
2014-12-29 01:08:48 +00:00
.TP
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fBRemove\fR {\fBNone\fR|\fBFar\fR|\fBNear\fR|\fBBoth\fR}
Propagate mailbox deletions [to the far/near side].
add support for propagating folder deletions
2014-12-29 01:08:48 +00:00
Otherwise print an error message and skip that mailbox pair if a mailbox
does not exist but the corresponding sync state does.
.br
For MailDir mailboxes it is sufficient to delete the cur/ subdirectory to
mark them as deleted. This ensures compatibility with \fBSyncState *\fR.
.br
Note that for safety, non-empty mailboxes are never deleted.
.br
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Global default: \fBNone\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fBExpunge\fR {\fBNone\fR|\fBFar\fR|\fBNear\fR|\fBBoth\fR}
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
Permanently remove all messages [on the far/near side] which are marked
for deletion.
elaborate on expunging and trashing
2013-12-14 11:37:11 +00:00
See \fBRECOMMENDATIONS\fR below.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Global default: \fBNone\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBCopyArrivalDate\fR {\fByes\fR|\fBno\fR}
added sync support for the arrival date of messages initial patch by Marc Hoersken <info@marc-hoersken.de>
2013-07-28 13:55:13 +00:00
Selects whether their arrival time should be propagated together with
the messages.
Enabling this makes sense in order to keep the time stamp based message
sorting intact.
Note that IMAP does not guarantee that the time stamp (termed \fBinternal
date\fR) is actually the arrival time, but it is usually close enough.
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
(Global default: \fBno\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
make it possible to specify CopyArrivalDate and MaxMessages globally sneaky change on the side: the wording of the man page is changed from "outside any section" to "before any section" to get global options. this is not entirely true ... the previously existing options behave as before, while the two newcomers actually affect subsequent channels.
2013-11-24 18:39:33 +00:00
.P
add support for propagating folder deletions
2014-12-29 01:08:48 +00:00
\fBSync\fR, \fBCreate\fR, \fBRemove\fR, \fBExpunge\fR,
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
\fBMaxMessages\fR, \fBExpireUnread\fR, and \fBCopyArrivalDate\fR
make it possible to specify CopyArrivalDate and MaxMessages globally sneaky change on the side: the wording of the man page is changed from "outside any section" to "before any section" to get global options. this is not entirely true ... the previously existing options behave as before, while the two newcomers actually affect subsequent channels.
2013-11-24 18:39:33 +00:00
can be used before any section for a global effect.
The global settings are overridden by Channel-specific options,
which in turn are overridden by command line switches.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
added sync support for the arrival date of messages initial patch by Marc Hoersken <info@marc-hoersken.de>
2013-07-28 13:55:13 +00:00
.TP
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
\fBSyncState\fR {\fB*\fR|\fIpath\fR}
wording fixes in mbsync.1 inspired by Ulrich Ölmann <u.oelmann@pengutronix.de>.
2019-09-10 11:00:18 +00:00
Set the location of this Channel's synchronization state files.
\fB*\fR means that the state should be saved in a file named .mbsyncstate
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
in the near side mailbox itself; this has the advantage that you do not need
wording fixes in mbsync.1 inspired by Ulrich Ölmann <u.oelmann@pengutronix.de>.
2019-09-10 11:00:18 +00:00
to handle the state file separately if you delete the mailbox, but it works
only with Maildir mailboxes, obviously.
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
Otherwise this is interpreted as a string to prepend to the near side mailbox
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
name to make up a complete path. Note that you \fBmust\fR append a slash if
you want to specify a directory.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
This option can be used outside any section for a global effect. In this case
the appended string is made up according to the pattern
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
\fB:\fIfar-store\fB:\fIfar-box\fB_:\fInear-store\fB:\fInear-box\fR
introduce FieldDelimiter and InfoDelimiter options ... for windows fs compatibility. the maildir-specific InfoDelimiter inherits the global FieldDelimiter (which affects SyncState), based on the assumption that if the sync state is on a windows FS, the mailboxes certainly will be as well, while the inverse is not necessarily true (when running on unix, anyway). REFMAIL: <CA+m_8J1ynqAjHRJagvKt9sb31yz047Q7NH-ODRmHOKyfru8vtA@mail.gmail.com>
2014-10-25 15:30:57 +00:00
(see also \fBFieldDelimiter\fR below).
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.br
(Global default: \fI~/.mbsync/\fR).
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SS Groups
.TP
\fBGroup\fR \fIname\fR [\fIchannel\fR[\fB:\fIbox\fR[\fB,\fR...]]] ...
Define the Group \fIname\fR, opening a section for its parameters.
Note that even though Groups have an own namespace, they will "hide" Channels
with the same name on the command line.
.br
One or more Channels can be specified on the same line.
.br
If you supply one or more \fIbox\fRes to a \fIchannel\fR, they will be used
refuse box list overrides if Channel has no Patterns as the named boxes are the same on both sides, they logically make sense only when the channel is in that mode anyway, which is the case when using patterns.
2013-12-07 15:41:05 +00:00
instead of what is specified in the Channel's Patterns.
The same can be done on the command line, except that there newlines can be
used as mailbox name separators as well.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
\fBChannel\fR[\fBs\fR] \fIchannel\fR[\fB:\fIbox\fR[\fB,\fR...]] ...
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
Add the specified Channels to the Group. This option can be specified multiple
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
times within a Group.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
add option to control amount of fsync()ing
2012-09-15 13:15:22 +00:00
.SS Global Options
.TP
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
\fBFSync\fR \fByes\fR|\fBno\fR
reduce FSync option to a boolean there is no use for Thorough mode any more, so simplify the configuration.
2013-11-02 20:42:34 +00:00
.br
Selects whether \fBmbsync\fR performs forced flushing, which determines
the level of data safety after system crashes and power outages.
Disabling it is reasonably safe for file systems which are mounted with
data=ordered mode.
Enabling it is a wise choice for file systems mounted with data=writeback,
in particular modern systems like ext4, btrfs and xfs. The performance impact
on older file systems may be disproportionate.
use \fB and \fI consistently, take 2 \fB means literal, while \fI means placeholder, value for placeholder, or emphasis.
2015-05-01 16:39:04 +00:00
(Default: \fByes\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
introduce FieldDelimiter and InfoDelimiter options ... for windows fs compatibility. the maildir-specific InfoDelimiter inherits the global FieldDelimiter (which affects SyncState), based on the assumption that if the sync state is on a windows FS, the mailboxes certainly will be as well, while the inverse is not necessarily true (when running on unix, anyway). REFMAIL: <CA+m_8J1ynqAjHRJagvKt9sb31yz047Q7NH-ODRmHOKyfru8vtA@mail.gmail.com>
2014-10-25 15:30:57 +00:00
.TP
\fBFieldDelimiter\fR \fIdelim\fR
The character to use to delimit fields in the string appended to a global
\fBSyncState\fR.
\fBmbsync\fR prefers to use the colon, but this is incompatible with
DOS/Windows file systems.
This option is meaningless for \fBSyncState\fR if the latter is \fB*\fR,
obviously. However, it also determines the default of \fBInfoDelimiter\fR.
(Global default: \fI;\fR on Windows, \fI:\fR everywhere else)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
soft-limit peak memory usage propagating many messages from a fast store (typically maildir or a local IMAP server) to a slow asynchronous store could cause gigabytes of data being buffered. avoid this by throttling fetches if the target context reports memory usage above a configurable limit. REFMAIL: 9737edb14457c71af4ed156c1be0ae59@mpcjanssen.nl
2015-02-15 17:13:05 +00:00
.TP
\fBBufferLimit\fR \fIsize\fR[\fBk\fR|\fBm\fR][\fBb\fR]
The per-Channel, per-direction instantaneous memory usage above which
\fBmbsync\fR will refrain from using more memory. Note that this is no
absolute limit, as even a single message can consume more memory than
this.
(Default: \fI10M\fR)
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
make progress counters global which means they are now cumulative, and include channels and boxes.
2015-03-28 16:26:08 +00:00
.SH CONSOLE OUTPUT
If \fBmbsync\fR's output is connected to a console, it will print progress
counters by default. The output will look like this:
.P
.in +4
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
C: 1/2 B: 3/4 F: +13/13 *23/42 #0/0 N: +0/7 *0/0 #0/0
make progress counters global which means they are now cumulative, and include channels and boxes.
2015-03-28 16:26:08 +00:00
.in -4
.P
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
This represents the cumulative progress over Channels, boxes, and messages
deprecate master/slave terminology the underlying metaphor refers to an inhumane practice, so using it casually is rightfully offensive to many people. it isn't even a particularly apt metaphor, as it suggests a strict hierarchy that is counter to mbsync's highly symmetrical mode of operation. the far/near terminology has been chosen as the replacement, as it is a natural fit for the push/pull terminology. on the downside, due to these not being nouns, a few uses are a bit awkward, and several others had to be amended to include 'side'. also, it's conceptually quite close to remote/local, which matches the typical use case, but is maybe a bit too suggestive of actually non-existing limitations. the new f/n suffixes of the -C/-R/-X options clash with pre-existing options, so direct concatenation of short options is even less practical than before (some suffixes of -D already clashed), but doing that leads to unreadable command lines anyway. as with previous deprecations, all pre-existing command line and config options keep working, but yield a warning. the state files are silently upgraded.
2020-07-22 17:44:26 +00:00
affected on the far and near side, respectively.
make progress counters global which means they are now cumulative, and include channels and boxes.
2015-03-28 16:26:08 +00:00
The message counts represent added messages, messages with updated flags,
and trashed messages, respectively.
No attempt is made to calculate the totals in advance, so they grow over
time as more information is gathered.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
elaborate on expunging and trashing
2013-12-14 11:37:11 +00:00
.SH RECOMMENDATIONS
Make sure your IMAP server does not auto-expunge deleted messages - it is
slow, and semantically somewhat questionable. Specifically, Gmail needs to
be configured not to do it.
.P
By default, \fBmbsync\fR will not delete any messages - deletions are
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
propagated by marking the messages as deleted in the opposite Store.
elaborate on expunging and trashing
2013-12-14 11:37:11 +00:00
Once you have verified that your setup works, you will typically want to
set \fBExpunge\fR to \fBBoth\fR, so that deletions become effective.
.P
\fBmbsync\fR's built-in trash functionality relies on \fBmbsync\fR doing
the expunging of deleted messages. This is the case when it propagates
deletions of previously propagated messages, and the trash is on the target
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
Store (typically your IMAP server).
elaborate on expunging and trashing
2013-12-14 11:37:11 +00:00
.br
However, when you intend \fBmbsync\fR to trash messages which were not
propagated yet, the MUA must mark the messages as deleted without expunging
them (e.g., \fBMutt\fR's \fBmaildir_trash\fR option). Note that most
messages are propagated a long time before they are deleted, so this is a
corner case you probably do not want to optimize for. This also implies
that the \fBTrashNewOnly\fR and \fBTrashRemoteNew\fR options are typically
not very useful.
.P
If your server supports auto-trashing (as Gmail does), it is probably a
good idea to rely on that instead of \fBmbsync\fR's trash functionality.
If you do that, and intend to synchronize the trash like other mailboxes,
you should not use \fBmbsync\fR's \fBTrash\fR option at all.
add DisableExtension option to work around (server) bugs
2015-05-08 08:20:09 +00:00
.P
Use of the \fBTrash\fR option with M$ Exchange 2013 requires the use of
\fBDisableExtension MOVE\fR due to a server bug.
Merge branch '1.2' Conflicts: configure.ac src/mbsync.1
2017-08-05 19:20:34 +00:00
.P
mention the need for renaming Maildir files upon move mu4e config line offered by Ben Maughan <benmaughan@gmail.com>.
2017-08-05 18:24:11 +00:00
When using the more efficient default UID mapping scheme, it is important
that the MUA renames files when moving them between Maildir folders.
Mutt always does that, while mu4e needs to be configured to do it:
.br
.in +4
(setq mu4e-change-filenames-when-moving t)
.in -4
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
.br
The general expectation is that a completely new filename is generated
as if the message was new, but stripping the \fB,U=\fIxxx\fR infix is
sufficient as well.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH INHERENT PROBLEMS
Changes done after \fBmbsync\fR has retrieved the message list will not be
synchronised until the next time \fBmbsync\fR is invoked.
make use of UID EXPUNGE
2012-08-25 18:30:04 +00:00
.P
Using \fBTrash\fR on IMAP Stores without the UIDPLUS extension (notably,
M$ Exchange up to at least 2010) bears a race condition: messages will be
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
lost if they are marked as deleted after the message list was retrieved but
make use of UID EXPUNGE
2012-08-25 18:30:04 +00:00
before the mailbox is expunged.
There is no risk as long as the IMAP mailbox is accessed by only one client
(including \fBmbsync\fR) at a time.
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH FILES
.TP
.B ~/.mbsyncrc
documentation tweaks manual: - explain what "rename on move" really means - reword "remote" to "opposite" to make it less confusing (possibly renaming TrashRemoteNew left as an exercise for later) - mention example mbsyncrc - consistently capitalize Store/Channel/Group where they refer to the respective configuration entities - emphasize that SyncState may need a trailing slash (as we do for Path) - fix missing mention of global usage/default for some options example mbsyncrc: - add big fat note that empty lines matter - stop demoing deprecated options - point out that CertificateFile is optional REFMAIL: 877dd11jb3.fsf@angela.anarc.at
2021-12-09 18:05:06 +00:00
Default configuration file.
See also the example file in the documentation directory.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.TP
.B ~/.mbsync/
Directory containing synchronization state files
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.SH SEE ALSO
delete the compat wrapper it was deprecated in 1.2. until 1.4 gets released, enough time will have passed for sure.
2017-10-01 13:21:05 +00:00
mdconvert(1), mutt(1), maildir(5)
The Big Rewrite. too many change to list them all. as opposed to earlier threats, BerkDB was not entirely dropped; i suppose the isync 0.7 -> 0.8 change had a reason, so i added an alternative UID storage scheme. note that BDB 4.0 is not sufficient, as the db->open function changed in an incompatible way ... i updated the debian packaging except for a changelog entry. note that i removed the upgrade blurb, as upstream now has a smooth upgrade path down to at least isync 0.4.
2004-03-27 16:07:20 +00:00
.P
Up to date information on \fBmbsync\fR can be found at http://isync.sf.net/
rework authentication mechanism configuration RequireCRAM (another fairly stupid "use if available" option) is now deprecated. instead, the AuthMech option can be used to give a precise list of acceptable authentication mechanisms (which is currently "a bit" short). in particular, this allows *not* using CRAM-MD5 even if it's available.
2014-07-12 19:02:25 +00:00
.P
SASL mechanisms are listed at
http://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml
fix roff abuse in man pages ".." is not valid. use "." instead, as recommended by groff_man(7). this also necessitated adjusting the markup of the license blurbs.
2019-11-27 16:55:33 +00:00
.
remove mail addresses from man pages apparently, some people don't see the "maintained by" bits, so make them look harder for explicit contact information (to be found in AUTHORS).
2010-02-28 21:23:20 +00:00
.SH AUTHORS
Originally written by Michael R. Elkins,
rewritten and currently maintained by Oswald Buddenhagen,
contributions by Theodore Y. Ts'o.
Reference in New Issue Copy Permalink