diff -r 4816d766a08a -r f345bda72bc4 Symbian3/PDK/Source/GUID-50CA6507-18AF-58D7-8494-2FECF8FDBDF3.dita --- a/Symbian3/PDK/Source/GUID-50CA6507-18AF-58D7-8494-2FECF8FDBDF3.dita Tue Mar 30 11:42:04 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-50CA6507-18AF-58D7-8494-2FECF8FDBDF3.dita Tue Mar 30 11:56:28 2010 +0100 @@ -1,74 +1,74 @@ - - - - - -How -to use CapCheck -

CapCheck is a tool that allows you to compare the capabilities -of binaries within your ROM log with a list of expected capabilities, called -an Expected Capability List. This is to make sure that the applications within -your ROM image have the correct access rights.

-

The Expected Capability list is a text file listing the capabilities you -expect to find in your ROM log file. This can be created manually or, as a -starting point, by using the standard output from CapSearch without -specifying any capabilities. To be useful, this seeded list must then be modified -appropriately to include expected capabilities only. All the capabilities -are listed in hexadecimal format.

-

All the permissible capabilities are defined in a Symbian Capability List, -which is a file called e32capability.h, located in <EPOCROOT>\epoc32\include.

-

To use the CapCheck tool, you need to define the name -and location of the ROM log file, the file listing the expected capabilities, -and the name and location of the Symbian Capability list.

-

The results are displayed in a report, in HTML format.

-
Command line syntax

The command line syntax to -be used for CapCheck is shown below.

>CapCheck.pl --r <rom_log_file> -e <expected_capability_list> -s <Symbian_capability_list> -[-R <HTML_report>]

Mandatory arguments are -r, -e and -s.

Arguments

The following arguments are used.

- - - -

-r <rom_log_file>

-

The name and location of the ROM log file to be checked, in relation -to the directory where the tool is run from, for example .\input\rom.log. -This is mandatory.

-
- -

-e <expected_capability_list>

-

The name of the file listing the capabilities you expect to find -in the ROM. This file is a text file created by you, either manually, or by -using CapSearch. This flag is mandatory.

-
- -

-s <Symbian_capability_list>

-

The name of the Symbian Capability List, listing all the capabilities -available to search, and their corresponding values (<EPOCROOT>\epoc32\include\e32capability.h.

-
- -

-R <HTML_report>

-

Defines the name of the HTML report to be generated in the working -directory. If not specified, the default name is CapCheckReport.html. -This is optional.

-
- -

-h

-

Displays help information (optional).

-
- - -

Example

A full example of how to use the CapSearch tool -is shown below:

>CapCheck.pl -r .\input\rom.log -e MyExpectedCapabilityList.txt -s e32capability.h -R results.html
-
-CapCheck -report - file format -CapSearch -Guide -CapImportCheck -Guide + + + + + +How +to use CapCheck +

CapCheck is a tool that allows you to compare the capabilities +of binaries within your ROM log with a list of expected capabilities, called +an Expected Capability List. This is to make sure that the applications within +your ROM image have the correct access rights.

+

The Expected Capability list is a text file listing the capabilities you +expect to find in your ROM log file. This can be created manually or, as a +starting point, by using the standard output from CapSearch without +specifying any capabilities. To be useful, this seeded list must then be modified +appropriately to include expected capabilities only. All the capabilities +are listed in hexadecimal format.

+

All the permissible capabilities are defined in a Symbian Capability List, +which is a file called e32capability.h, located in <EPOCROOT>\epoc32\include.

+

To use the CapCheck tool, you need to define the name +and location of the ROM log file, the file listing the expected capabilities, +and the name and location of the Symbian Capability list.

+

The results are displayed in a report, in HTML format.

+
Command line syntax

The command line syntax to +be used for CapCheck is shown below.

>CapCheck.pl +-r <rom_log_file> -e <expected_capability_list> -s <Symbian_capability_list> +[-R <HTML_report>]

Mandatory arguments are -r, -e and -s.

Arguments

The following arguments are used.

+ + + +

-r <rom_log_file>

+

The name and location of the ROM log file to be checked, in relation +to the directory where the tool is run from, for example .\input\rom.log. +This is mandatory.

+
+ +

-e <expected_capability_list>

+

The name of the file listing the capabilities you expect to find +in the ROM. This file is a text file created by you, either manually, or by +using CapSearch. This flag is mandatory.

+
+ +

-s <Symbian_capability_list>

+

The name of the Symbian Capability List, listing all the capabilities +available to search, and their corresponding values (<EPOCROOT>\epoc32\include\e32capability.h.

+
+ +

-R <HTML_report>

+

Defines the name of the HTML report to be generated in the working +directory. If not specified, the default name is CapCheckReport.html. +This is optional.

+
+ +

-h

+

Displays help information (optional).

+
+ + +

Example

A full example of how to use the CapSearch tool +is shown below:

>CapCheck.pl -r .\input\rom.log -e MyExpectedCapabilityList.txt -s e32capability.h -R results.html
+
+CapCheck +report - file format +CapSearch +Guide +CapImportCheck +Guide
\ No newline at end of file