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-50CA6507-18AF-58D7-8494-2FECF8FDBDF3" xml:lang="en"><title>How

    13 to use CapCheck</title><prolog><metadata><keywords/></metadata></prolog><conbody>

    14 <p> <codeph>CapCheck</codeph> is a tool that allows you to compare the capabilities

    15 of binaries within your ROM log with a list of expected capabilities, called

    16 an Expected Capability List. This is to make sure that the applications within

    17 your ROM image have the correct access rights. </p>

    18 <p>The Expected Capability list is a text file listing the capabilities you

    19 expect to find in your ROM log file. This can be created manually or, as a

    20 starting point, by using the standard output from <codeph>CapSearch</codeph> without

    21 specifying any capabilities. To be useful, this seeded list must then be modified

    22 appropriately to include expected capabilities only. All the capabilities

    23 are listed in hexadecimal format. </p>

    24 <p>All the permissible capabilities are defined in a Symbian Capability List,

    25 which is a file called <filepath>e32capability.h</filepath>, located in <filepath>&lt;EPOCROOT&gt;\epoc32\include</filepath>. </p>

    26 <p>To use the <codeph>CapCheck</codeph> tool, you need to define the name

    27 and location of the ROM log file, the file listing the expected capabilities,

    28 and the name and location of the Symbian Capability list. </p>

    29 <p>The results are displayed in a report, in HTML format. </p>

    30 <section><title>Command line syntax</title> <p>The command line syntax to

    31 be used for <codeph>CapCheck</codeph> is shown below. </p> <p> <codeph>&gt;CapCheck.pl

    32 -r <rom_log_file> -e           <expected_capability_list> -s <Symbian_capability_list>

    33 [-R           &lt;HTML_report&gt;]</codeph> </p> <p>Mandatory arguments are <codeph>-r</codeph>, <codeph>-e</codeph> and <codeph>-s</codeph>. </p> <p><b>Arguments</b> </p> <p>The following arguments are used. </p> <table id="GUID-C88DC3A2-B2DD-57C8-8F39-01B8FE2CEF34">

    34 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/>

    35 <tbody>

    36 <row>

    37 <entry><p> <codeph>-r &lt;rom_log_file&gt;</codeph> </p> </entry>

    38 <entry><p>The name and location of the ROM log file to be checked, in relation

    39 to the directory where the tool is run from, for example <filepath>.\input\rom.log</filepath>.

    40 This is mandatory. </p> </entry>

    41 </row>

    42 <row>

    43 <entry><p> <codeph>-e &lt;expected_capability_list&gt;</codeph> </p> </entry>

    44 <entry><p>The name of the file listing the capabilities you expect to find

    45 in the ROM. This file is a text file created by you, either manually, or by

    46 using <codeph>CapSearch</codeph>. This flag is mandatory. </p> </entry>

    47 </row>

    48 <row>

    49 <entry><p> <codeph>-s &lt;Symbian_capability_list&gt;</codeph> </p> </entry>

    50 <entry><p>The name of the Symbian Capability List, listing all the capabilities

    51 available to search, and their corresponding values (<filepath>&lt;EPOCROOT&gt;\epoc32\include\e32capability.h</filepath>. </p> </entry>

    52 </row>

    53 <row>

    54 <entry><p> <codeph>-R &lt;HTML_report&gt;</codeph> </p> </entry>

    55 <entry><p>Defines the name of the HTML report to be generated in the working

    56 directory. If not specified, the default name is <filepath>CapCheckReport.html</filepath>.

    57 This is optional. </p> </entry>

    58 </row>

    59 <row>

    60 <entry><p> <codeph>-h</codeph> </p> </entry>

    61 <entry><p>Displays help information (optional). </p> </entry>

    62 </row>

    63 </tbody>

    64 </tgroup>

    65 </table> <p><b>Example</b> </p> <p>A full example of how to use the <codeph>CapSearch</codeph> tool

    66 is shown below: </p> <codeblock id="GUID-5AFC93AE-DCE6-5981-984F-73968E9962E4" xml:space="preserve">&gt;CapCheck.pl -r .\input\rom.log -e MyExpectedCapabilityList.txt -s e32capability.h -R results.html</codeblock> </section>

    67 </conbody><related-links>

    68 <link href="GUID-48326B53-0814-57B9-A744-78AA219D3480.dita"><linktext>CapCheck

    69 report - file format</linktext></link>

    70 <link href="GUID-3C042957-E7C7-53EC-9397-E5650D2D61AA.dita"><linktext>CapSearch

    71 Guide</linktext></link>

    72 <link href="GUID-C244E0D1-DF89-5C86-9C4C-419900BE0DDA.dita"><linktext>CapImportCheck

    73 Guide</linktext></link>

    74 </related-links></concept>