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

NAME

6       sync_client - client side of the synchronization (replication) engine
7

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

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

FILES

82       /etc/imapd.conf
83

SEE ALSO

85       sync_server(8)
86

AUTHORS

88       David Carter (dpc22@cam.ac.uk), Ken Murchison (ken@oceana.com)
89
90
91
92CMU                              Project Cyrus                  SYNC_CLIENT(8)