source: trunk/doc/src/rcc.qdoc@ 348

Last change on this file since 348 was 2, checked in by Dmitry A. Kuminov, 16 years ago

Initially imported qt-all-opensource-src-4.5.1 from Trolltech.
File size: 4.2 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*!
43 \page rcc.html
44 \title Resource Compiler (rcc)
45 \ingroup buildsystem
46 \ingroup qttools
47 \keyword rcc
48
49 The \c rcc tool is used to embed resources into a Qt application during
50 the build process. It works by generating a C++ source file containing
51 data specified in a Qt resource (.qrc) file.
52
53 Usage:
54 \snippet doc/src/snippets/code/doc_src_rcc.qdoc 0
55
56 RCC accepts the following command line options:
57
58 \table
59 \header \o Option \o Argument \o Description
60
61 \row \o \c{-o} \o \o Writes output to file rather than
62 stdout.
63
64 \row \o \c{-name} \o \c name \o Creates an external initialization
65 function with name.
66
67 \row \o \c{-threshold} \o \c level \o Specifies a threshold (in bytes)
68 to use when compressing files. If
69 the file is smaller than the
70 threshold, it will not be
71 compressed, independent of what
72 the compression level is.
73
74 \row \o \c{-compress} \o \c level \o Compresses input files with the
75 given level. Level is an integer
76 from 1 to 9 - 1 being the fastest,
77 producing the least compression;
78 9 being the slowest, producing
79 the most compression.
80
81 \row \o \c{-root} \o \c path \o Prefixes the resource access path
82 with root path.
83
84 \row \o \c{-no-compress} \o \o Disables all compression.
85
86 \row \o \c{-binary} \o \o Outputs a binary file for use as
87 a dynamic resource.
88
89 \row \o \c{-version} \o \o Displays version information.
90
91 \row \o \c{-help} \o \o Displays usage information.
92 \endtable
93
94 See also \l{The Qt Resource System} for more information about embedding
95 resources in Qt applications.
96*/
Note: See TracBrowser for help on using the repository browser.