1.. cyrusman:: backupd(8)
2
3.. _imap-reference-manpages-systemcommands-backupd:
4
5===========
6**backupd**
7===========
8
9Cyrus Backups server process
10
11Synopsis
12========
13
14.. parsed-literal::
15
16    **backupd** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ]
17        [ **-s** ] [ **-N** ] [ **-p** *ssf* ]
18
19Description
20===========
21
22**backupd** is the Cyrus Backups server.  It accepts Cyrus replication protocol
23commands on its standard input and responds on its standard output.  It MUST be
24invoked by :cyrusman:`master(8)` with those descriptors attached to a
25replication client connection, typically :cyrusman:`sync_client(8)`.
26
27**backupd** |default-conf-text|
28
29**backupd** is generally configured to run on a dedicated backup server,
30containing backup storage, but no IMAP service or mailbox storage.
31
32You must configure at least one *backuppartition*.  User backups will be
33distributed among the configured partitions.  Note that there is no
34relationship between mailbox partitions and *backuppartitions*.
35
36If the directory ``log``\/*user* exists under the directory specified in the
37``configdirectory`` configuration option, then **backupd** will create
38protocol telemetry logs for sessions authenticating as *user*.  The telemetry
39logs will be stored in the ``log``\/*user* directory with a filename of the
40**backupd** process-id.
41
42Options
43=======
44
45.. program:: backupd
46
47.. option:: -C config-file
48
49    |cli-dash-c-text|
50
51.. option:: -U  uses
52
53    The maximum number of times that the process should be used for new
54    connections before shutting down.  The default is 250.
55
56.. option:: -T  timeout
57
58    The number of seconds that the process will wait for a new
59    connection before shutting down.  Note that a value of 0 (zero)
60    will disable the timeout.  The default is 60.
61
62.. option:: -D
63
64    Run external debugger specified in debug_command.
65
66.. option:: -p  ssf
67
68    Tell **backupd** that an external layer exists.  An *SSF* (security
69    strength factor) of 1 means an integrity protection layer exists.
70    Any higher SSF implies some form of privacy protection.
71
72
73Examples
74========
75
76**backupd** is commonly included in the SERVICES section of
77:cyrusman:`cyrus.conf(5)` like so:
78
79.. parsed-literal::
80    SERVICES {
81        **backupd        cmd="backupd" listen="csync" prefork=0**
82    }
83
84History
85=======
86
87Files
88=====
89
90See Also
91========
92
93:cyrusman:`imapd.conf(5)`,
94:cyrusman:`master(8)`,
95:cyrusman:`sync_client(8)`
96