1SYNC_CLIENT(8)              System Manager's Manual             SYNC_CLIENT(8)
2
3
4
5 *
6

NAME

8       sync_client - client side of the synchronization (replication) engine
9

SYNOPSIS

11       sync_client [ -v ] [ -l ] [ -z ] [ -C config-file ] [ -S servername ]
12                   [ -f input-file ] [ -F shutdown_file ] [ -w wait_interval ]
13                   [ -t timeout ] [ -d delay ] [ -r ] [ -u ] [ -m ]
14                   [ -s ] objects...
15
16

DESCRIPTION

18       Sync_client  is  the client side of the replication system.  It runs on
19       the client (master) system and connects to the target (replica)  system
20       and  generates  an  appropriate sequence of transactions to synchronize
21       the replica system with the master system.
22

OPTIONS

24       -v     Verbose mode.
25
26       -l     Verbose logging mode.
27
28       -o     Only attempt to connect to the backend server once  rather  than
29              waiting up to 1000 seconds before giving up.
30
31       -z     Enable  compress.   If you set 'sync_compress' in the imapd.conf
32              or pass -z to sync_client, the replication protocol will attempt
33              to enable deflate compression on the connection.
34
35       -C config-file
36              Read configuration options from config-file.
37
38       -S servername
39              Tells  sync_client  which server to communicate with.  Overrides
40              the sync_host configuration option.
41
42       -f input-file
43              In mailbox or user replication mode: provides list of  users  or
44              mailboxes  to replicate.  In rolling replication mode, specifies
45              an alternate log file (sync_client will  exit  after  processing
46              the log file).
47
48       -F shutdown-file
49              Rolling  replication  checks  for  this  file at the end of each
50              replication cycle and shuts down  if  it  is  present.  Used  to
51              request  nice clean shutdown at first convenient point. The file
52              in  question  is  removed  on  shutdown.   Overrides  sync_shut‐
53              down_file option in imapd.conf
54
55       -w interval
56              Wait  this  long  before starting. Typically used so that we can
57              attach a debugger to one end of the replication  system  or  the
58              other.
59
60       -t timeout
61              Timeout  for  single  replication  run  in  rolling replication.
62              sync_client will negotiate a restart after  this  many  seconds.
63              Default: 600 seconds
64
65       -d delay
66              Minimum  delay  between  replication runs in rolling replication
67              mode.  Larger values provide better efficiency  as  transactions
68              can  be  merged.  Smaller values mean that the replica system is
69              more up to date and that you don't end up with large  blocks  of
70              replication transactions as a single group. Default: 3 seconds.
71
72       -r     Rolling  (repeat)  replication  mode.  Pick up a list of actions
73              recorded by the lmtpd(8), imapd(8), popd(8) and nntpd(8) daemons
74              from   the   file  specified  in  sync_log_file.   Repeat  until
75              sync_shutdwon_file appears.
76
77       -u     User mode.  Remaining arguments are list of users who should  be
78              replicated.
79
80       -m     Mailbox  mode.   Remaining arguments are list of mailboxes which
81              should be replicated.
82
83       -s     Sieve mode.  Remaining arguments are list of users  whose  Sieve
84              files should be replicated.  Principally used for debugging pur‐
85              poses: not exposed to sync_client(8).
86

FILES

88       /etc/imapd.conf
89

SEE ALSO

91       sync_server(8)
92

AUTHORS

94       David Carter (dpc22@cam.ac.uk), Ken Murchison (ken@oceana.com)
95
96
97
98CMU                              Project Cyrus                  SYNC_CLIENT(8)