summaryrefslogtreecommitdiffstats
path: root/doc/src/development/rcc.qdoc
blob: 00d62bf4ba36b449667ee43747bfe4e374ddfba2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \page rcc.html
    \title Resource Compiler (rcc)
    \ingroup qttools
    \keyword rcc

    The \c rcc tool is used to embed resources into a Qt application during
    the build process. It works by generating a C++ source file containing
    data specified in a Qt resource (.qrc) file.

    Usage:
    \snippet doc/src/snippets/code/doc_src_rcc.qdoc 0

    RCC accepts the following command line options:

    \table
    \header \o Option         \o Argument \o Description

    \row \o \c{-o} \o \c{file} \o Write output to \c{file} rather than to stdout.

    \row \o \c{-name} \o \c{name} \o Create an external initialization 
    	    	      	 	     function with \c{name}.

    \row \o \c{-threshold} \o \c{level} \o Specifies a threshold \c{level} (in 
    	    		      		   bytes) to use when deciding whether
					   to compress a file. If the file is 
					   smaller than the threshold \c{level}, 
					   it is not compressed. The default
					   threshold level is 70 bytes.
                                             
    \row \o \c{-compress} \o \c{level} \o Compress input files to the given
                                          compression \c{level}, which is an 
					  integer in the range 1 to 9. Level 1 
					  does the least compression but is 
					  fastest. Level 9 does the most 
					  compression but is slowest. To turn 
					  off compression, use \c{-no-compress}. 
					  The default value for \c{level} is -1,
					  which means use zlib's default 
					  compression level. 

    \row \o \c{-root} \o \c{path} \o Prefix the resource access path with \c{path}.
    	    	      	 	     The default is no prefix.

    \row \o \c{-no-compress} \o \o Disable compression.

    \row \o \c{-binary} \o \o Output a binary file for use as a dynamic resource.

    \row \o \c{-version} \o \o Display version information.

    \row \o \c{-help} \o \o Display usage information.

    \endtable

    See also \l{The Qt Resource System} for more information about embedding
    resources in Qt applications.
*/