Symbian3/SDK/Source/GUID-9C57F0C6-E2E3-58A2-907D-924A7E22EA97-GENID-1-13-1-1-5-1-4-1.dita
changeset 8 ae94777fff8f
equal deleted inserted replaced
7:51a74ef9ed63 8:ae94777fff8f
       
     1 <?xml version="1.0" encoding="utf-8"?>
       
     2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
       
     3 <!-- This component and the accompanying materials are made available under the terms of the License 
       
     4 "Eclipse Public License v1.0" which accompanies this distribution, 
       
     5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->
       
     6 <!-- Initial Contributors:
       
     7     Nokia Corporation - initial contribution.
       
     8 Contributors: 
       
     9 -->
       
    10 <!DOCTYPE concept
       
    11   PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
       
    12 <concept id="GUID-9C57F0C6-E2E3-58A2-907D-924A7E22EA97-GENID-1-13-1-1-5-1-4-1" xml:lang="en"><title>Resource
       
    13 compiler tool: rcomp</title><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    14 <section id="GUID-9C57F0C6-E2E3-58A2-907D-924A7E22EA97-GENID-1-13-1-1-5-1-4-1-2-1"><title>Purpose</title> <p>The
       
    15 resource compiler, <filepath>rcomp</filepath>, compiles source <filepath>rss</filepath> resource
       
    16 files into a <filepath>rsc</filepath> resource data file which can be used
       
    17 by applications, and a <filepath>rsg</filepath> resource header file. The
       
    18 operation of the resource compiler is usually wrapped in an <filepath>abld</filepath> batch
       
    19 file. That provides the most commonly used <filepath>rcomp</filepath> functionality,
       
    20 but does not provide some of the debugging options available directly through <filepath>rcomp</filepath>. </p><p><b>Note</b>:
       
    21 From Symbian^4 onwards, <filepath>rcomp</filepath> supports long strings and
       
    22 supplementary characters (not included in code point range of BMP) of the
       
    23 range <codeph>0x10000</codeph> to <codeph>0x10ffff</codeph> in rss files.</p> </section>
       
    24 <section id="GUID-C8BD2B09-0D01-4CE3-B575-0A076F1E926D"><title>Command line syntax</title><userinput>rcomp [—v] [—p] [—l]
       
    25 [—force] [—u] [—o <varname>DataOutputFile</varname>] [-{<varname>uid2</varname>,<varname>uid3</varname> }]
       
    26 [—h <varname>HeaderOutputFile</varname>] [—s <varname>SourceFileName</varname>]
       
    27 [—i <varname>BaseInputFileName</varname>]</userinput> <p><b>Arguments</b> </p> <table id="GUID-787D72D2-564C-569A-B7C4-B244DD46C87E">
       
    28 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/>
       
    29 <tbody>
       
    30 <row>
       
    31 <entry><p> <codeph>-v</codeph>  </p> </entry>
       
    32 <entry><p>verbose output. </p> </entry>
       
    33 </row>
       
    34 <row>
       
    35 <entry><p> <codeph>-p</codeph>  </p> </entry>
       
    36 <entry><p>parser debugging </p> </entry>
       
    37 </row>
       
    38 <row>
       
    39 <entry><p> <codeph>-l</codeph>  </p> </entry>
       
    40 <entry><p>Check localisation comments </p> </entry>
       
    41 </row>
       
    42 <row>
       
    43 <entry><p> <codeph>-force</codeph>  </p> </entry>
       
    44 <entry><p>Emit warnings if the localisation comment tags are not present </p> </entry>
       
    45 </row>
       
    46 <row>
       
    47 <entry><p> <codeph>-u</codeph>  </p> </entry>
       
    48 <entry><p>generate Unicode resource binary </p> </entry>
       
    49 </row>
       
    50 <row>
       
    51 <entry><p> <codeph>-o</codeph>  <varname>DataOutputFile</varname>  </p> </entry>
       
    52 <entry><p>Specify full path and name for data output file <varname>DataOutputFile</varname>.
       
    53 If this is not specified, no data output file is created. </p> </entry>
       
    54 </row>
       
    55 <row>
       
    56 <entry><p>[-{<varname>uid2</varname>,<varname>uid3</varname> }] </p> </entry>
       
    57 <entry><p>Second and third UIDs for the resource file </p> </entry>
       
    58 </row>
       
    59 <row>
       
    60 <entry><p> <codeph>-h</codeph>  <varname>HeaderOutputFile</varname>  </p> </entry>
       
    61 <entry><p>Specify header output file <varname>HeaderOutputFile</varname>;
       
    62 this is the name only, and does not include the path. If this is not specified,
       
    63 no header output file is created. </p> </entry>
       
    64 </row>
       
    65 <row>
       
    66 <entry><p> <codeph>-s</codeph>  <varname>SourceFileName</varname>  </p> </entry>
       
    67 <entry><p>Specify resource compiler source file <varname>SourceFileName</varname> (output
       
    68 of pre-processor <varname>BaseInputFileName</varname>.rpp). If not specified,
       
    69 or specified as <codeph>-s-</codeph>, source is read from the standard input. </p> </entry>
       
    70 </row>
       
    71 <row>
       
    72 <entry><p> <codeph>-i</codeph>  <varname>BaseInputFileName</varname>  </p> </entry>
       
    73 <entry><p>The file given to the pre-processor </p> </entry>
       
    74 </row>
       
    75 </tbody>
       
    76 </tgroup>
       
    77 </table> <p><b>Output files</b> </p> <table id="GUID-2CF9D84F-B657-56FF-8AB3-DF14CE693ED5">
       
    78 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/>
       
    79 <tbody>
       
    80 <row>
       
    81 <entry><p> <varname>DataOutputFile</varname>  </p> </entry>
       
    82 <entry><p>The resource data referred to by the application at run-time. Note
       
    83 that the generated file can have any name. However, before the resource file
       
    84 can be used it must be renamed to have an extension <filepath>.rsc</filepath>. </p> </entry>
       
    85 </row>
       
    86 <row>
       
    87 <entry><p> <varname>HeaderOutputFile</varname>  </p> </entry>
       
    88 <entry><p>The generated header file, which contains <codeph>#define</codeph> statements
       
    89 for each resource defined in the source file. </p> </entry>
       
    90 </row>
       
    91 </tbody>
       
    92 </tgroup>
       
    93 </table> </section>
       
    94 </conbody></concept>