.. cyrusman:: sync_client(8)

.. author: David Carter (dpc22@cam.ac.uk)
.. author: Ken Murchison (ken@oceana.com)
.. author: Nic Bernstein (Onlight)

.. _imap-reference-manpages-systemcommands-sync_client:

===============
**sync_client**
===============

Client side of the synchronization (replication) engine

Synopsis
========

.. parsed-literal::

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

Description
===========

**sync_client** is the client side of the replication system.  It runs
on the client (master) system and connects to the target (replica)
system and generates an appropriate sequence of transactions to
synchronize the replica system with the master system.

**sync_client** |default-conf-text|

Options
=======

.. program:: sync_client

.. option:: -C config-file

    |cli-dash-c-text|

.. option:: -A

    All users mode.
    Sync every user on the server to the replica (doesn't do non-user
    mailboxes at all... this could be considered a bug and maybe it
    should do those mailboxes independently)

.. option:: -d delay

    Minimum delay between replication runs in rolling replication mode.
    Larger values provide better efficiency as transactions can be
    merged. Smaller values mean that the replica system is more up to
    date and that you don't end up with large blocks of replication
    transactions as a single group. Default: 3 seconds.

.. option:: -f input-file

    In mailbox or user replication mode: provides list of users or
    mailboxes to replicate.  In rolling replication mode, specifies an
    alternate log file (**sync_client** will exit after processing the
    log file).

.. option:: -F shutdown-file

    Rolling replication checks for this file at the end of each
    replication cycle and shuts down if it is present. Used to request
    a nice clean shutdown at the first convenient point. The file is
    removed on shutdown. Overrides ``sync_shutdown_file`` option in
    :cyrusman:`imapd.conf(5)`.

.. option:: -l

    Verbose logging mode.

.. option:: -L

    Perform only local mailbox operations (do not do mupdate operations).
    |v3-new-feature|

.. option:: -m

    Mailbox mode.
    Remaining arguments are list of mailboxes which should be replicated.

.. option:: -n channel

    Use the named channel for rolling replication mode.  If multiple
    channels are specified in ``sync_log_channels`` then use one of them.
    This option is probably best combined with **-S** to connect to a
    different server with each channel.

.. option:: -o

    Only attempt to connect to the backend server once rather than
    waiting up to 1000 seconds before giving up.

.. option:: -O

    No copyback mode. Replication will stop if the replica reports a CRC
    error, rather than doing a full mailbox sync. Useful if moving users to a
    new server, where you don't want any errors to cause the source servers
    to change the account.

.. option:: -p partition

    In mailbox or user replication mode: provides the name of the
    partition on the replica to which the mailboxes/users should be
    replicated.

.. option:: -r

    Rolling (repeat) replication mode. Pick up a list of actions
    recorded by the :cyrusman:`lmtpd(8)`, :cyrusman:`imapd(8)`,
    :cyrusman:`pop3d(8)` and :cyrusman:`nntpd(8)` daemons from the file
    specified in ``sync_log_file``. Repeat until ``sync_shutdown_file``
    appears.

.. option:: -1

    Like rolling replication, but only process a single file before exiting.

.. option:: -s

    Sieve mode.
    Remaining arguments are list of users whose Sieve files should be
    replicated. Principally used for debugging purposes: not exposed to
    :cyrusman:`sync_client(8)`.

.. option:: -S servername

    Tells **sync_client** with which server to communicate.  Overrides
    the ``sync_host`` configuration option.

.. option:: -t timeout

    Timeout for single replication run in rolling replication.
    **sync_client** will negotiate a restart after this many seconds.
    Default: 600 seconds

.. option:: -u

    User mode.
    Remaining arguments are list of users who should be replicated.

.. option:: -v

    Verbose mode.  Use twice (**-v -v**) to log all protocol traffic to
    stderr.

.. option:: -w interval

    Wait this long before starting. This option is typically used so
    that we can attach a debugger to one end of the replication system
    or the other.

.. option:: -z

    Require compression.
    The replication protocol will always try to enable deflate
    compression if both ends support it.  Set this flag when you want
    to abort if compression is not available.


Examples
========

On a replication master, the following would be added to the START
section of :cyrusman:`cyrus.conf(5)`:

    ::

        syncclient		cmd="/usr/lib/cyrus/bin/sync_client -r"

[NB: More examples needed]

History
=======

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

Files
=====

/etc/imapd.conf

See Also
========

:cyrusman:`sync_server(8)`, :cyrusman:`cyrus.conf(5)`,
:cyrusman:`imapd.conf(5)`, :cyrusman:`master(8)`
