ZARAFA-ARCHIVER(1)                                          ZARAFA-ARCHIVER(1)



NAME
       zarafa-archiver - Manages zarafa archives and performs the archive
       operation.

SYNOPSIS
       zarafa-archiver [OPTION...]


DESCRIPTION


       This tool is used to attach or detach archives to a users store. An
       archive is defined as a special non-active store or a folder inside
       such a store.



       On top of managing archives, this tool is used to perform the actual
       archive operation. Using the-u option, the archiver can be instructed
       to archive a single store or all stores.



ACTIONS


       zarafa-archiver needs an action command with the appropriate options.
       Valid actions are:




       -l, --list
              List archives for the specified user. The -u option is required.


       -L, --list-archiveusers
              List users that have an archived attached.


       -A, --archive
              Perform an archive run. If a -u option is provided, only the
              store of one user will be archived. Otherwise all stores are
              archived. Optionally the --local-only option can be set to only
              archive stores that exist on the server to which zarafa-archiver
              is connected (usualy the local server).


       --attach-to archive
              Attach an archive to the store of the user specified with the -u
              option. If no additional options are specified, a folder will be
              created in the archive store, which will act as the root of the
              archive for the user. The foldername will be set to the username
              of the user. This behavior can be changed by providing the
              --archive-folder  or --no-folder option.


       --detach-from archive
              Detach an archive from the store of the user specified with the
              -u option. zarafa-archiver will automatically determine which
              folder to detach. However if a user has two archives in one
              archive store, zarafa-archiver won't be able to tell which one
              needs to be detached. In this case the folder needs to be
              specified with the --archive-folder option.



OPTIONS


       The options used by actions are as follows:




       -u username
              Use this parameter to specify a user on which store to perform
              the provided action.


       --local-only
              If this option is passed when an archive run is started, only
              stores that exist on the server to which zarafa-archiver is
              connected will be archived.


       --archive-folder foldername
              Use this option to force zarafa-archiver to create the archive
              folder with a different name than the username of the user for
              whom to attach an archive.


       --archive-server serverpath
              Use this option to specify the path to the archive server. This
              is usefull when using the archiver in a non-multiserver setup.


       --no-folder
              Use this option to force zarafa-archiver to create the root of
              the archive in the root of the archive store (IPM subtree). This
              way only one user store can be attached to an archive.


       -w, --writable
              By default zarafa-archiver makes an archive read-only for the
              user. By passing this option, the user will get read/write
              permissions in the attached archive.


       -c file
              Select an alternate config file to be used by zarafa-archiver.



EXAMPLES




       For attaching an archive:




       zarafa-archiver  -u username  --attach-to archive




       For attaching an archive with a custom archive name:




       zarafa-archiver  -u username  --attach-to archive  --archive-name
       archivename




       For attaching an archive without an archive folder:




       zarafa-archiver  -u username  --attach-to archive  --no-folder




       For detaching an archive:




       zarafa-archiver  -u username  --detach-from archive



       For starting an archive run:




       zarafa-archiver  -A




       For starting an archive run for one user:




       zarafa-archiver  -u username  -A



AUTHOR


       Written by Zarafa.



SEE ALSO


        zarafa-server(1)  zarafa-archiver.cfg(5)





                                                            ZARAFA-ARCHIVER(1)
