doc/src/development/rcc.qdoc
changeset 0 1918ee327afb
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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 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          \o Writes output to file rather than
       
    61                                              stdout.
       
    62 
       
    63     \row    \o \c{-name}      \o \c name  \o Creates an external initialization
       
    64                                              function with name.
       
    65 
       
    66     \row    \o \c{-threshold} \o \c level \o Specifies a threshold (in bytes)
       
    67                                              to use when compressing files. If
       
    68                                              the file is smaller than the
       
    69                                              threshold, it will not be
       
    70                                              compressed, independent of what
       
    71                                              the compression level is.
       
    72                                              
       
    73     \row    \o \c{-compress}  \o \c level \o Compresses input files with the
       
    74                                              given level. Level is an integer
       
    75                                              from 1 to 9 - 1 being the fastest,
       
    76                                              producing the least compression;
       
    77                                              9 being the slowest, producing
       
    78                                              the most compression.
       
    79 
       
    80     \row    \o \c{-root}      \o \c path  \o Prefixes the resource access path
       
    81                                              with root path.
       
    82 
       
    83     \row    \o \c{-no-compress} \o        \o Disables all compression.
       
    84 
       
    85     \row    \o \c{-binary}    \o          \o Outputs a binary file for use as
       
    86                                              a dynamic resource.
       
    87 
       
    88     \row    \o \c{-version}   \o          \o Displays version information.
       
    89 
       
    90     \row    \o \c{-help}      \o          \o Displays usage information.
       
    91     \endtable
       
    92 
       
    93     See also \l{The Qt Resource System} for more information about embedding
       
    94     resources in Qt applications.
       
    95 */