diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-03-09 13:47:39 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2015-03-11 10:16:36 +0000 |
| commit | 750c2b6a0d345add0d4f0ebc54824be0e4e02eb3 (patch) | |
| tree | fdc637e71486e2e49bb06be0fada28bbcb9eb38a /doc | |
| parent | 8c2941ae5892826520cccc946d13c17c8cc347f0 (diff) | |
Doc: add archivegen usage to Reference > Tools
Change-Id: I4da08d1c34124ae9c2009c37121964a6b0dfaa66
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/installerfw.qdoc | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index 596efeed7..c6ed2b508 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -678,23 +678,10 @@ \section1 Data Directory - The \c data directory contains the content that is extracted during the - installation. The Qt Installer Framework uses the archivegen tool to extract - the files from a 7zip archive (.7z). - - You have the following options: - \list - \li Copy the files to the \c data directory. Before the installer is - created, the files are packaged into a 7zip archive. - \li Use the archivegen tool to package the files as a 7zip archive and - copy it to the \c data directory. - \li Use some other tool to package the files as a 7zip compatible - archive and copy it to the \c data directory. - \endlist - - \note Each of the above options has advantages and disadvantages. We - recommend that you use archivegen because it offers faster archive creation - and compatibility with 7zip. + The \c data directory contains the content that the installer extracts + during the installation. You must package the data as a 7zip archive (.7z). + You can use either the \l archivegen tool that is delivered with the Qt + Installer Framework or some other tool that generates 7zip archives. */ /*! @@ -715,6 +702,8 @@ \li \l repogen + \li \l archivegen + \endlist \section1 installerbase @@ -916,6 +905,21 @@ this makes it much easier for a content delivery system to distribute only new files, because only the updated components are assigned new SHA checksums. + \section1 archivegen + + You can use \c archivegen to package files and directories into 7zip (.7z) + archives. + + The \c archivegen tool expects the following parameters in the following + order: + + \code + archivegen <name.7z> <data> + \endcode + + Where \e <name.7z> is the path and file name of the archive to create and + \e <data> contains the paths and names of the files or directories to + package into the archive, separated by spaces. */ /*! |