| 1 | /****************************************************************************
|
|---|
| 2 | **
|
|---|
| 3 | ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
|
|---|
| 4 | ** All rights reserved.
|
|---|
| 5 | ** Contact: Nokia Corporation (qt-info@nokia.com)
|
|---|
| 6 | **
|
|---|
| 7 | ** This file is part of the documentation of the Qt Toolkit.
|
|---|
| 8 | **
|
|---|
| 9 | ** $QT_BEGIN_LICENSE:LGPL$
|
|---|
| 10 | ** Commercial Usage
|
|---|
| 11 | ** Licensees holding valid Qt Commercial licenses may use this file in
|
|---|
| 12 | ** accordance with the Qt Commercial License Agreement provided with the
|
|---|
| 13 | ** Software or, alternatively, in accordance with the terms contained in
|
|---|
| 14 | ** a written agreement between you and Nokia.
|
|---|
| 15 | **
|
|---|
| 16 | ** GNU Lesser General Public License Usage
|
|---|
| 17 | ** Alternatively, this file may be used under the terms of the GNU Lesser
|
|---|
| 18 | ** General Public License version 2.1 as published by the Free Software
|
|---|
| 19 | ** Foundation and appearing in the file LICENSE.LGPL included in the
|
|---|
| 20 | ** packaging of this file. Please review the following information to
|
|---|
| 21 | ** ensure the GNU Lesser General Public License version 2.1 requirements
|
|---|
| 22 | ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|---|
| 23 | **
|
|---|
| 24 | ** In addition, as a special exception, Nokia gives you certain additional
|
|---|
| 25 | ** rights. These rights are described in the Nokia Qt LGPL Exception
|
|---|
| 26 | ** version 1.1, included in the file LGPL_EXCEPTION.txt in this 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 have questions regarding the use of this file, please contact
|
|---|
| 37 | ** Nokia at qt-info@nokia.com.
|
|---|
| 38 | ** $QT_END_LICENSE$
|
|---|
| 39 | **
|
|---|
| 40 | ****************************************************************************/
|
|---|
| 41 |
|
|---|
| 42 | /*!
|
|---|
| 43 | \page rcc.html
|
|---|
| 44 | \title Resource Compiler (rcc)
|
|---|
| 45 | \ingroup qttools
|
|---|
| 46 | \keyword rcc
|
|---|
| 47 |
|
|---|
| 48 | The \c rcc tool is used to embed resources into a Qt application during
|
|---|
| 49 | the build process. It works by generating a C++ source file containing
|
|---|
| 50 | data specified in a Qt resource (.qrc) file.
|
|---|
| 51 |
|
|---|
| 52 | Usage:
|
|---|
| 53 | \snippet doc/src/snippets/code/doc_src_rcc.qdoc 0
|
|---|
| 54 |
|
|---|
| 55 | RCC accepts the following command line options:
|
|---|
| 56 |
|
|---|
| 57 | \table
|
|---|
| 58 | \header \o Option \o Argument \o Description
|
|---|
| 59 |
|
|---|
| 60 | \row \o \c{-o} \o \c{file} \o Write output to \c{file} rather than to stdout.
|
|---|
| 61 |
|
|---|
| 62 | \row \o \c{-name} \o \c{name} \o Create an external initialization
|
|---|
| 63 | function with \c{name}.
|
|---|
| 64 |
|
|---|
| 65 | \row \o \c{-threshold} \o \c{level} \o Specifies a threshold \c{level} (in
|
|---|
| 66 | bytes) to use when deciding whether
|
|---|
| 67 | to compress a file. If the file is
|
|---|
| 68 | smaller than the threshold \c{level},
|
|---|
| 69 | it is not compressed. The default
|
|---|
| 70 | threshold level is 70 bytes.
|
|---|
| 71 |
|
|---|
| 72 | \row \o \c{-compress} \o \c{level} \o Compress input files to the given
|
|---|
| 73 | compression \c{level}, which is an
|
|---|
| 74 | integer in the range 1 to 9. Level 1
|
|---|
| 75 | does the least compression but is
|
|---|
| 76 | fastest. Level 9 does the most
|
|---|
| 77 | compression but is slowest. To turn
|
|---|
| 78 | off compression, use \c{-no-compress}.
|
|---|
| 79 | The default value for \c{level} is -1,
|
|---|
| 80 | which means use zlib's default
|
|---|
| 81 | compression level.
|
|---|
| 82 |
|
|---|
| 83 | \row \o \c{-root} \o \c{path} \o Prefix the resource access path with \c{path}.
|
|---|
| 84 | The default is no prefix.
|
|---|
| 85 |
|
|---|
| 86 | \row \o \c{-no-compress} \o \o Disable compression.
|
|---|
| 87 |
|
|---|
| 88 | \row \o \c{-binary} \o \o Output a binary file for use as a dynamic resource.
|
|---|
| 89 |
|
|---|
| 90 | \row \o \c{-version} \o \o Display version information.
|
|---|
| 91 |
|
|---|
| 92 | \row \o \c{-help} \o \o Display usage information.
|
|---|
| 93 |
|
|---|
| 94 | \endtable
|
|---|
| 95 |
|
|---|
| 96 | See also \l{The Qt Resource System} for more information about embedding
|
|---|
| 97 | resources in Qt applications.
|
|---|
| 98 | */
|
|---|
