/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of the Qt Build Suite.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/licensing. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

/*!
    \contentspage index.html
    \page archiver-module.html
    \ingroup list-of-modules

    \title Module archiver
    \brief Provides support for building archives.

    The \c archiver module contains the properties and rules for creating (compressed) archives.
    The output artifact has the file tag "archiver.archive". The sole input artifact is a text file
    containing the list of files to package, with one file path per line. The paths can be
    relative, in which case they will be looked for at \c{archiver.workingDirectory}. The file tag
    of this input artifact is "archiver.input-list".

    \section1 archiver Properties

    \table
    \header
        \li Property
        \li Type
        \li Default
        \li Description
    \row
        \li flags
        \li stringList
        \li empty list
        \li Custom options not covered by any of the other properties.
    \row
        \li archiveBaseName
        \li string
        \li \c{product.name}
        \li The base name of the archive file (in other words, the file name without
            any extensions).
    \row
        \li compressionLevel
        \li string
        \li \c undefined
        \li How much effort to put into the compression of a 7-Zip archive.
            Possible values are \c undefined, "0", "1", "3", "5", "7" and "9". Higher numbers
            result in a smaller archive, but the compressing process will take more time.
            A value of \c undefined means to use the default compression level.
    \row
        \li compressionType
        \li string
        \li \c{"gz"}
        \li How to compress a tar archive. Possible options are "none", "gz", "bz2", "Z" and "xz".
    \row
        \li outputDirectory
        \li string
        \li \c{product.destinationDirectory}
        \li Where to put the archive file.
    \row
        \li type
        \li string
        \li \c{undefined}
        \li Which kind of archiver to use. The currently supported values are "tar" and "7zip".
    \row
        \li workingDirectory
        \li string
        \li undefined
        \li The directory in which to execute \c command.
    \row
        \li command
        \li string
        \li Depends on \c{type}.
        \li The command with which to invoke the archiver.
    \endtable
*/
