Update copyright headers
[qt:qt.git] / doc / src / development / rcc.qdoc
1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://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: http://www.gnu.org/copyleft/fdl.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 doc/src/snippets/code/doc_src_rcc.qdoc 0
40
41     RCC accepts the following command line options:
42
43     \table
44     \header \o Option         \o Argument \o Description
45
46     \row \o \c{-o} \o \c{file} \o Write output to \c{file} rather than to stdout.
47
48     \row \o \c{-name} \o \c{name} \o Create an external initialization 
49                                      function with \c{name}.
50
51     \row \o \c{-threshold} \o \c{level} \o 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 \o \c{-compress} \o \c{level} \o Compress input files to the given
61                                           compression \c{level}, which is an
62                                           integer in the range 1 to 9. Level 1
63                                           does the least compression but is
64                                           fastest. Level 9 does the most
65                                           compression but is slowest. To turn
66                                           off compression, use \c{-no-compress}.
67                                           The default value for \c{level} is -1,
68                                           which means use zlib's default
69                                           compression level.
70
71     \row \o \c{-root} \o \c{path} \o Prefix the resource access path with \c{path}.
72                                      The default is no prefix.
73
74     \row \o \c{-no-compress} \o \o Disable compression.
75
76     \row \o \c{-binary} \o \o Output a binary file for use as a dynamic resource.
77
78     \row \o \c{-version} \o \o Display version information.
79
80     \row \o \c{-help} \o \o Display usage information.
81
82     \endtable
83
84     See also \l{The Qt Resource System} for more information about embedding
85     resources in Qt applications.
86 */