Skip to content
GitLab
Select Git revision
  • 6.2
  • dev default
  • 6.2.2
  • 5.12
  • 5.12.12
  • 6.2.1
  • 6.2.0
  • 6.1
  • 6.1.3
  • 6.0
  • 6.1.2
  • 6.1.1
  • 5.12.11
  • 6.1.0
  • 5.15
  • 6.0.0
  • 5.15.2
  • 5.12.10
  • 5.15.1
  • 5.12.9
  • v5.15.0-alpha1
  • v5.12.7
  • v5.14.1
  • v5.9.9
  • v5.14.0
  • v5.14.0-rc2
  • v5.14.0-rc1
  • v5.12.6
  • v5.14.0-beta3
  • v5.13.2
  • v5.14.0-beta2
  • v5.14.0-beta1
  • v5.14.0-alpha1
  • v5.12.5
  • v5.13.1
  • v5.13.0
  • v5.13.0-rc3
  • v5.12.4
  • v5.13.0-rc2
  • v5.13.0-rc1
Find file BlameHistoryPermalink
rcc.qdoc 4.78 KiB
1 
/****************************************************************************
2 
**
3 
** Copyright (C) 2016 The Qt Company Ltd.
4 
** Contact: https://www.qt.io/licensing/
5 
**
6 
** This file is part of the documentation of the Qt Toolkit.
7 
**
8 
** $QT_BEGIN_LICENSE:FDL$
9 
** Commercial License Usage
10 
** Licensees holding valid commercial Qt licenses may use this file in
11 
** accordance with the commercial license agreement provided with the
12 
** Software or, alternatively, in accordance with the terms contained in
13 
** a written agreement between you and The Qt Company. For licensing terms
14 
** and conditions see https://www.qt.io/terms-conditions. For further
15 
** information use the contact form at https://www.qt.io/contact-us.
16 
**
17 
** GNU Free Documentation License Usage
18 
** Alternatively, this file may be used under the terms of the GNU Free
19 
** Documentation License version 1.3 as published by the Free Software
20 
** Foundation and appearing in the file included in the packaging of
21 
** this file. Please review the following information to ensure
22 
** the GNU Free Documentation License version 1.3 requirements
23 
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
24 
** $QT_END_LICENSE$
25 
**
26 
****************************************************************************/
27
28 
/*!
29 
    \page rcc.html
30 
    \title Resource Compiler (rcc)
31 
    \ingroup qttools
32 
    \keyword rcc
33
34 
    The \c rcc tool is used to embed resources into a Qt application during
35 
    the build process. It works by generating a C++ source file containing
36 
    data specified in a Qt resource (.qrc) file.
37
38 
    Usage:
39 
    \snippet snippets/code/doc_src_rcc.qdoc 0
40
41 
    RCC accepts the following command line options:
42
43 
    \table
44 
    \header \li Option         \li Argument \li Description
45
46 
    \row \li \c{-o} \li \c{file} \li Write output to \c{file} rather than to stdout.
47
48 
    \row \li \c{-name} \li \c{name} \li Create an external initialization
49 
                                     function with \c{name}.
50
51 
    \row \li \c{-threshold} \li \c{level} \li Specifies a threshold \c{level} (as a
52 
                           percentage) to use when deciding whether to compress
53 
                           a file. If the reduction in the file size is greater than
54 
                           the threshold \c{level}, it is compressed; otherwise,
55 
                           the uncompressed data is stored instead. The default
56 
                           threshold level is 70%, meaning that compressed files
57 
                           which are 30% or less of their original size are
58 
                           stored as compressed data.
59
60 
    \row \li \c{-compress-algo} \li \c{algorithm} \li The algorithm to compress files with.
61 
                            Supported algorithms are \c{zstd}, \c{zlib}, and \c{none}, which
62 
                            respectively mean to compress the content using the
63 
                            \l{Zstandard}{https://zstd.net} library, \l{zlib}{https://zlib.net}
64 
                            library, and no compression. The default is \c{zstd} if that
65 
                            library was found at compile time, \c{zlib} if not.
66
67 
    \row \li \c{-compress} \li \c{level} \li Compress input files to the given compression
68 
                            \c{level}, which is algorithm-dependent. If the algorithm is
69 
                            \c{zstd}, the valid levels are 1 to 19, with the special values of
70 
                            0 and -1 meaning \c{libzstd}'s and \c {rcc}'s default compressions.
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108
If the algorithm is \c{zlib}, the level is an integer in the range 1 to 9. For both algorithms, level 1 does the least compression but is fastest. Levels 9 or 19 do the most compression but are slowest. To turn off compression, use \c{-no-compress}. The default value for \c{level} is -1. \row \li \c{-root} \li \c{path} \li Prefix the resource access path with \c{path}. The default is no prefix. \row \li \c{-no-compress} \li \li Disable compression. \row \li \c{-binary} \li \li Output a binary file for use as a dynamic resource. \row \li \c{-version} \li \li Display version information. \row \li \c{-help} \li \li Display usage information. \row \li \c{-t, --temp <file>} \li \li Use temporary <file> for big resources. \row \li \c{--namespace} \li \li Turn off namespace macros. \row \li \c{--verbose} \li \li Enable verbose mode. \row \li \c{--list} \li \li Only list .qrc file entries, do not generate code. \row \li \c{-project} \li \li Output a resource file containing all files from the current directory. \endtable See also \l{The Qt Resource System} for more information about embedding resources in Qt applications. */