|
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-922E4771-C1FD-5C88-9C11-57499684DB97" xml:lang="en"><title>SPITOOL</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
13 <p>SPITOOL is a utility for creating static plug-in information (SPI) |
|
14 files, which contain registration data for ROM-based plug-ins. </p> |
|
15 <p>The tool is normally invoked by <xref href="GUID-E4447BEF-33D2-5099-BCC1-C72FBB3B0463.dita">BUILDROM</xref>, |
|
16 though it can be used independently (for example, for test purposes). </p> |
|
17 <section id="GUID-E67FF051-D423-4DBC-A3AB-24155F7743D3"> </section> |
|
18 <section id="GUID-C173E1BC-BEDD-5843-B395-2DF6123D5F18"><title>SPITOOL |
|
19 command syntax</title> <codeblock id="GUID-06FB9E43-C48E-5CCF-862A-1D709DC905AD" xml:space="preserve">spitool [options] files directories</codeblock> <p>The tool creates an SPI file by concatenating the specified input |
|
20 files, using the options specified. </p> <p>You can specify the input |
|
21 files by specifying the full path to each file, or by specifying a |
|
22 directory name, in which case all files from that directory are included. </p> <p> <codeph>options</codeph> can be one or more of the following: </p> <table id="GUID-704075C3-49BD-5305-A2B5-4D8C4523EE48"> |
|
23 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
24 <tbody> |
|
25 <row> |
|
26 <entry><p>-t<SPIFileName> </p> </entry> |
|
27 <entry><p> <codeph><SPIFileName></codeph> is the name for the produced |
|
28 SPI file (e.g. <filepath>ecom.spi</filepath>) </p> </entry> |
|
29 </row> |
|
30 <row> |
|
31 <entry><p>-d<TargetDir> </p> </entry> |
|
32 <entry><p> <codeph><TargetDir></codeph> is the directory where |
|
33 the SPI file should be created. The directory name should end with |
|
34 a <codeph>\</codeph>. </p> </entry> |
|
35 </row> |
|
36 <row> |
|
37 <entry><p>-i<Existing> </p> </entry> |
|
38 <entry><p> <codeph><Existing></codeph> is the path of an existing |
|
39 SPI file to which to concatenate the specified input files. </p> <p>If this option is used, then the specified file is used as a base |
|
40 for the new output file. The output file will contain the contents |
|
41 of the existing file with new input files appended. The location of |
|
42 the output file is still specified using the <codeph>-d</codeph> and <codeph>-t</codeph> options. </p> </entry> |
|
43 </row> |
|
44 <row> |
|
45 <entry><p>-uid[1 | 2 | 3]=<UIDValue> </p> </entry> |
|
46 <entry><p>Specifies that input files should be filtered by their UID |
|
47 values. </p> <p>This option can be used multiple times, so a list |
|
48 of valid UID1 values can be specified, and similarly for UID2 and |
|
49 UID3 values. The UIDs of each input file are compared with this list, |
|
50 and if a UID value matches a relevant value in the UID lists, then |
|
51 that file is included in the SPI file. If the file does not match |
|
52 any values, it is excluded. </p> <p>Use 1, 2, or 3 in the option keyword |
|
53 to specify to which of the three UIDs the filter should apply. <codeph><UIDValue></codeph> should be a UID value in decimal or hexadecimal |
|
54 (0x....). </p> </entry> |
|
55 </row> |
|
56 <row> |
|
57 <entry><p>-existinguid[1 | 2 | 3]=<UIDValue> </p> </entry> |
|
58 <entry><p>Test that files concatenated in an existing SPI file use |
|
59 the specified UID value. This allows the possibility of checking that |
|
60 the correct type of files are being concatenated together. </p> <p>Use 1, 2, or 3 in the option to specify to which of the three UIDs |
|
61 the test should apply. <codeph><UIDValue></codeph> should be a |
|
62 UID value in decimal or hexadecimal (0x....). </p> </entry> |
|
63 </row> |
|
64 <row> |
|
65 <entry><p>-existinguidcrc=<CRCValue> </p> </entry> |
|
66 <entry><p>Test that files concatenated in an existing SPI file use |
|
67 the specified CRC checksum value. A file's CRC is generated from all |
|
68 three of its UIDs. </p> <p> <codeph><CRCValue></codeph> should |
|
69 be a value in decimal or hexadecimal (0x....). </p> </entry> |
|
70 </row> |
|
71 <row> |
|
72 <entry><p>-hide <ResourceFileNames> </p> </entry> |
|
73 <entry><p>Marks a resource file as hidden in the SPI file. </p> <p><ResourceFileNames> is a list of resource file names separated |
|
74 by a space or comma, which need to be marked as hidden in the SPI |
|
75 file. </p> </entry> |
|
76 </row> |
|
77 </tbody> |
|
78 </tgroup> |
|
79 </table> </section> |
|
80 </conbody></concept> |