1SYNC_CLIENT(8)                    Cyrus IMAP                    SYNC_CLIENT(8)
2
3
4

NAME

6       sync_client - Cyrus IMAP documentation
7
8       Client side of the synchronization (replication) engine
9

SYNOPSIS

11       sync_client [ -v ] [ -l ] [ -L ] [ -z ] [ -C config-file ] [ -S server-name ]
12           [ -f input-file ] [ -F shutdown_file ] [ -w wait_interval ]
13           [ -t timeout ] [ -d delay ] [ -r ] [ -n channel ] [ -u ] [ -m ]
14           [ -p partition ] [ -A ] [ -s ] [ -O ] objects...
15

DESCRIPTION

17       sync_client  is  the client side of the replication system.  It runs on
18       the client (master) system and connects to the target (replica)  system
19       and  generates  an  appropriate sequence of transactions to synchronize
20       the replica system with the master system.
21
22       sync_client reads its configuration options out  of  the  imapd.conf(5)
23       file unless specified otherwise by -C.
24

OPTIONS

26       -C config-file
27              Use the specified configuration file config-file rather than the
28              default imapd.conf(5).
29
30       -A     All users mode.  Sync every user on the server  to  the  replica
31              (doesn't  do  non-user mailboxes at all... this could be consid‐
32              ered a bug and maybe it should do those mailboxes independently)
33
34       -d delay
35              Minimum delay between replication runs  in  rolling  replication
36              mode.   Larger  values provide better efficiency as transactions
37              can be merged. Smaller values mean that the  replica  system  is
38              more  up  to date and that you don't end up with large blocks of
39              replication transactions as a single group. Default: 3 seconds.
40
41       -f input-file
42              In mailbox or user replication mode: provides list of  users  or
43              mailboxes  to replicate.  In rolling replication mode, specifies
44              an alternate log file (sync_client will  exit  after  processing
45              the log file).
46
47       -F shutdown-file
48              Rolling  replication  checks  for  this  file at the end of each
49              replication cycle and shuts down  if  it  is  present.  Used  to
50              request a nice clean shutdown at the first convenient point. The
51              file is removed on shutdown. Overrides sync_shutdown_file option
52              in imapd.conf(5).
53
54       -l     Verbose logging mode.
55
56       -L     Perform  only local mailbox operations (do not do mupdate opera‐
57              tions).  This feature was introduced in version 3.0.
58
59       -m     Mailbox mode.  Remaining arguments are list of  mailboxes  which
60              should be replicated.
61
62       -n channel
63              Use the named channel for rolling replication mode.  If multiple
64              channels are specified in  sync_log_channels  then  use  one  of
65              them.   This option is probably best combined with -S to connect
66              to a different server with each channel.
67
68       -o     Only attempt to connect to the backend server once  rather  than
69              waiting up to 1000 seconds before giving up.
70
71       -O     No copyback mode. Replication will stop if the replica reports a
72              CRC error, rather than doing a full mailbox sync. Useful if mov‐
73              ing  users  to  a new server, where you don't want any errors to
74              cause the source servers to change the account.
75
76       -p partition
77              In mailbox or user replication mode: provides the  name  of  the
78              partition  on the replica to which the mailboxes/users should be
79              replicated.
80
81       -r     Rolling (repeat) replication mode. Pick up  a  list  of  actions
82              recorded  by  the lmtpd(8), imapd(8), pop3d(8) and nntpd(8) dae‐
83              mons from the file  specified  in  sync_log_file.  Repeat  until
84              sync_shutdown_file appears.
85
86       -s     Sieve  mode.   Remaining arguments are list of users whose Sieve
87              files should be replicated. Principally used for debugging  pur‐
88              poses: not exposed to sync_client(8).
89
90       -S servername
91              Tells  sync_client  with which server to communicate.  Overrides
92              the sync_host configuration option.
93
94       -t timeout
95              Timeout for  single  replication  run  in  rolling  replication.
96              sync_client  will  negotiate  a restart after this many seconds.
97              Default: 600 seconds
98
99       -u     User mode.  Remaining arguments are list of users who should  be
100              replicated.
101
102       -v     Verbose  mode.  Use twice (-v -v) to log all protocol traffic to
103              stderr.
104
105       -w interval
106              Wait this long before starting. This option is typically used so
107              that we can attach a debugger to one end of the replication sys‐
108              tem or the other.
109
110       -z     Require compression.  The replication protocol will  always  try
111              to enable deflate compression if both ends support it.  Set this
112              flag when you want to abort if compression is not available.
113

EXAMPLES

115       On a replication master, the following would be added to the START sec‐
116       tion of cyrus.conf(5):
117
118          syncclient              cmd="/usr/lib/cyrus/bin/sync_client -r"
119
120       [NB: More examples needed]
121

HISTORY

123       The -L feature, local updates only, was added in version 3.0.
124

FILES

126       /etc/imapd.conf
127

SEE ALSO

129       sync_server(8), cyrus.conf(5), imapd.conf(5), master(8)
130

AUTHOR

132       The   Cyrus   Team,   David  Carter  (dpc22@cam.ac.uk),  Ken  Murchison
133       (ken@oceana.com), Nic Bernstein (Onlight)
134
136       1993-2017, The Cyrus Team
137
138
139
140
1413.0.10                           May 27, 2019                   SYNC_CLIENT(8)
Impressum