1ZARAFA-ARCHIVER(1) Zarafa user reference ZARAFA-ARCHIVER(1)
2
6 zarafa-archiver - Manages zarafa archives and performs the archive
7 operation.
8
10 zarafa-archiver [OPTION...]
11
13 This tool is used to attach or detach archives to a users store. An
14 archive is defined as a special non-active store or a folder inside
15 such a store.
16 On top of managing archives, this tool is used to perform the actual
18 archive operation. Using the -u option, the archiver can be instructed
19 to archive a single store or all stores.
20
22 zarafa-archiver needs an action command with the appropriate options.
23 Valid actions are:
24 -l, --list
26 List archives for the specified user. The -u option is required.
27 -L, --list-archiveusers
29 List users that have an archive attached.
30 -A, --archive
32 Perform an archive run. If a -u option is provided, only the store
33 of one user will be archived. Otherwise all stores are archived.
34 Optionally the --local-only option can be set to only archive
35 stores that exist on the server to which zarafa-archiver is
36 connected (usualy the local server).
37 -a archive, --attach-to archive
39 Attach an archive to the store of the user specified with the -u
40 option. If no additional options are specified, a folder will be
41 created in the archive store, which will act as the root of the
42 archive for the user. The foldername will be set to the username of
43 the user. This behavior can be changed by providing the
44 --archive-folder or --no-folder option.
45 -d archive, --detach-from archive
47 Detach an archive from the store of the user specified with the -u
48 option. zarafa-archiver will automatically determine which folder
49 to detach. However if a user has two archives in one archive store,
50 zarafa-archiver won´t be able to tell which one needs to be
51 detached. In this case the folder needs to be specified with the
52 --archive-folder option.
53 -D archiveno, --detach archiveno
55 Detach an archive from the store of the user specified with the -u
56 option. The archive to detach is indicated by archiveno and can be
57 obtained by running zarafa-archiver -u username -l
58
60 The options used by actions are as follows:
61 -u username
63 Use this parameter to specify a user on which store to perform the
64 provided action.
65 --local-only
67 If this option is passed when an archive run is started, only
68 stores that exist on the server to which zarafa-archiver is
69 connected will be archived.
70 --archive-folder foldername
72 Use this option to force zarafa-archiver to create the archive
73 folder with a different name than the username of the user for whom
74 to attach an archive.
75 --archive-server serverpath
77 Use this option to specify the path to the archive server. This is
78 usefull when using the archiver in a non-multiserver setup.
79 --no-folder
81 Use this option to force zarafa-archiver to create the root of the
82 archive in the root of the archive store (IPM subtree). This way
83 only one user store can be attached to an archive.
84 -w, --writable
86 By default zarafa-archiver makes an archive read-only for the user.
87 By passing this option, the user will get read/write permissions in
88 the attached archive.
89 -c file
91 Select an alternate config file to be used by zarafa-archiver.
92 Default: /etc/zarafa/archiver.cfg
94
96 For attaching an archive:
97 zarafa-archiver -u username --attach-to archive
99 For attaching an archive with a custom archive name:
101 zarafa-archiver -u username --attach-to archive --archive-name
103 archivename
104 For attaching an archive without an archive folder:
106 zarafa-archiver -u username --attach-to archive --no-folder
108 For detaching an archive:
110 zarafa-archiver -u username --detach-from archive
112 For starting an archive run:
114 zarafa-archiver -A
116 For starting an archive run for one user:
118 zarafa-archiver -u username -A
120
122 Written by Zarafa.
123
125 zarafa-server(1) zarafa-archiver.cfg(5)
126Zarafa 7.0 August 2011 ZARAFA-ARCHIVER(1)