doc/src/rcc.qdoc

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 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 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  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 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  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 */