cyr_backup(8)

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

NAME

6       cyr_backup - Cyrus IMAP documentation
7
8       Inspect contents of Cyrus backups.
9

SYNOPSIS

11          cyr_backup [OPTIONS] [MODE] backup list chunks
12          cyr_backup [OPTIONS] [MODE] backup list mailboxes
13          cyr_backup [OPTIONS] [MODE] backup list messages
14          cyr_backup [OPTIONS] [MODE] backup list all
15          cyr_backup [OPTIONS] [MODE] backup show mailboxes [ mboxname | uniqueid ]...
16          cyr_backup [OPTIONS] [MODE] backup show messages guid...
17          cyr_backup [OPTIONS] [MODE] backup dump chunk id
18          cyr_backup [OPTIONS] [MODE] backup dump message guid
19          cyr_backup [OPTIONS] [MODE] backup json chunks
20          cyr_backup [OPTIONS] [MODE] backup json mailboxes
21          cyr_backup [OPTIONS] [MODE] backup json messages
22          cyr_backup [OPTIONS] [MODE] backup json headers guid...
23

DESCRIPTION

25       cyr_backup is a tool for inspecting the contents of a Cyrus backup.
26
27       cyr_backup  reads  its  configuration  options out of the imapd.conf(5)
28       file unless specified otherwise by -C.
29
30       In all invocations, backup is interpreted according  to  the  specified
31       MODE.  See Modes below.
32
33       cyr_backup provides the following sub-commands:
34
35       list
36
37                 cyr_backup [OPTIONS] [MODE] backup list chunks
38                 cyr_backup [OPTIONS] [MODE] backup list mailboxes
39                 cyr_backup [OPTIONS] [MODE] backup list messages
40                 cyr_backup [OPTIONS] [MODE] backup list all
41
42              List chunks, mailboxes, or messages contained in backup.
43
44       show
45
46                 cyr_backup [OPTIONS] [MODE] backup show mailboxes [ mboxname | uniqueid ]...
47                 cyr_backup [OPTIONS] [MODE] backup show messages guid...
48
49              show  mailboxes shows the contents (i.e. the contained messages)
50              of mailboxes matching each given mboxname  or  uniqueid  in  the
51              named  backup.  The uid, expunged time, and guid of each message
52              are shown.
53
54              show messages shows details of messages matching each given guid
55              in  the  named backup.  The guid, containing mailboxes, and MIME
56              headers of each message are shown.
57
58       dump
59
60                 cyr_backup [OPTIONS] [MODE] backup dump chunk id
61                 cyr_backup [OPTIONS] [MODE] backup dump message guid
62
63              Dump the contents of the specified chunk or message contained in
64              the  named  backup to standard out.  Chunks are output as uncom‐
65              pressed backup data format  (which  is  a  replication  protocol
66              stream).  Messages are output in their on-disk format (typically
67              MIME).
68
69              dump chunk is mainly useful for diagnostic purposes.
70
71              dump message may be useful as part of a manual message  restora‐
72              tion  process, when the restoration destination does not support
73              the restore(8) command.
74
75       json
76
77                 cyr_backup [OPTIONS] [MODE] backup json chunks
78                 cyr_backup [OPTIONS] [MODE] backup json mailboxes
79                 cyr_backup [OPTIONS] [MODE] backup json messages
80                 cyr_backup [OPTIONS] [MODE] backup json headers guid...
81
82              Dump information about the chunks, mailboxes  or  messages  con‐
83              tained in the named backup to standard out, in JSON format.
84

OPTIONS

86       -C config-file
87              Use the specified configuration file config-file rather than the
88              default imapd.conf(5).
89
90       -v, --verbose
91              Increase the verbosity.  Can be specified multiple times.
92

MODES

94       -f, --filename
95              backup is interpreted as a filename.  The named  file  does  not
96              need to be known about in the backups database.
97
98       -m, --mailbox
99              backup  is interpreted as a mailbox name.  There must be a known
100              backup for the user whose mailbox this is.
101
102              Known backups are recorded in  the  database  specified  by  the
103              backup_db and backup_db_path configuration options.
104
105       -u, --userid
106              backup is interpreted as a userid.  There must be a known backup
107              for the specified user.
108
109              This is the default if no mode is specified.
110

EXAMPLES

HISTORY

FILES

AUTHOR

118       The Cyrus Team
119

COPYRIGHT

121       1993–2023, The Cyrus Team
122
123
124
125
1263.8.1                            Sep 11, 2023                    CYR_BACKUP(8)