|
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 reference |
|
11 PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> |
|
12 <reference id="GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE" xml:lang="en"><title>InterpretSIS |
|
13 Examples</title><abstract><p>This section explains the following InterpretSIS examples:</p><ul> |
|
14 <li><xref href="GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE.dita#GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE/GUID-5ddda82b-39b2-4240-b89b-3f796f8f8e94">Overriding |
|
15 the installation drive specified in the PKG file</xref></li> |
|
16 <li><xref href="GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE.dita#GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE/GUID-0bddead5-381b-4d8c-9437-74a4d9ef48b5">Configuring |
|
17 the content of ROM drive</xref></li> |
|
18 <li><xref href="GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE.dita#GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE/GUID-bd93fd67-d9b3-491b-802c-27cbd1038c0e">Configuring |
|
19 the registry version</xref></li> |
|
20 <li><xref href="GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE.dita#GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE/GUID-1df8c2ad-3bab-4b03-8245-b37826c2910d">Installing |
|
21 system upgrade packages</xref></li> |
|
22 <li><xref href="GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE.dita#GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE/GUID-2e68d8df-461c-428e-9874-9b0df47072f0">Uninstalling |
|
23 preinstalled packages</xref></li> |
|
24 <li><xref href="GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE.dita#GUID-882DCE58-5E5F-44D2-9E84-093709EAA4BE/GUID-b4a2d72c-95ab-44e6-8bf3-5cba3957c67e">Supporting |
|
25 device variant creation</xref></li> |
|
26 </ul></abstract><prolog><metadata><keywords/></metadata></prolog><refbody> |
|
27 <section id="GUID-5DDDA82B-39B2-4240-B89B-3F796F8F8E94"><title>Overriding |
|
28 the installation drive specified in the PKG file</title><p>You can override |
|
29 the target drive definition defined in the PKG file by specifying the <codeph>–s</codeph> option |
|
30 and providing the drive location at the command prompt as explained in the |
|
31 following example: </p> <p>If <filepath>file1.sis</filepath> contains the |
|
32 following three files to install: </p> <ul> |
|
33 <li id="GUID-6C6573D5-8C70-57C7-90BC-5E81DEBCCCAC"><p> <filepath>!:\file1.txt</filepath> </p> </li> |
|
34 <li id="GUID-661199AC-5E93-54AE-ABF4-E207462425B0"><p> <filepath>c:\file2.txt</filepath> </p> </li> |
|
35 <li id="GUID-2CB80A26-24A5-5F0F-80F5-94792753E865"><p> <filepath>d:\file3.txt</filepath> </p> </li> |
|
36 </ul> <p>and the <filepath>d</filepath> drive is defined in the configuration |
|
37 file as: </p> <codeblock id="GUID-DA091A3B-4A93-510A-96C2-7744FB1566EA" xml:space="preserve">DRIVE = c:\drive_d d</codeblock> <p>then, |
|
38 if you run the InterpretSIS tool with the following options and arguments: </p> <p><userinput>interpretsis |
|
39 –z c:\rom_drive -c c:\system_drive –s file1.sis +d</userinput> </p> <p> <filepath>file1.txt</filepath>, <filepath>file2.txt</filepath> and <filepath>file3.txt</filepath> are all installed to the <filepath>D</filepath> drive. </p> <p>If |
|
40 you do not specify the drive at the command prompt </p> <p><userinput>interpretsis |
|
41 –z c:\rom_drive -c c:\system_drive –s file1.sis</userinput> </p> <p>then <filepath>file1.txt</filepath>, <filepath>file2.txt</filepath> and <filepath>file3.txt</filepath> are all installed to the default system drive (<filepath>C</filepath> drive). </p></section> |
|
42 <section id="GUID-0BDDEAD5-381B-4D8C-9437-74A4D9EF48B5"><title>Configuring |
|
43 the content of ROM drive</title><p>Sometimes it is impractical and unnecessary |
|
44 to create a ROM drive with thousands of files for each product. The contents |
|
45 of the ROM drive can alternatively be specified as multiple LOG and OBY files |
|
46 using the <codeph>–r</codeph> option as shown in the following example: </p> <p><userinput>interpretsis |
|
47 -r rofsbuild_log_file1,rofsbuild_log_file2,...</userinput> </p> <p>ROM stub |
|
48 SIS files must be present in the directory defined by the <codeph>–t</codeph> option: </p> <p><userinput>interpretsis |
|
49 -r rofsbuild_log_file1,rofsbuild_log_file2 –t .\romdrive\system\data</userinput> </p></section> |
|
50 <section id="GUID-BD93FD67-D9B3-491B-802C-27CBD1038C0E"><title>Configuring |
|
51 the registry version</title><p>Device creators can generate SIS Registry entry |
|
52 files that are compatible with previous versions of Symbian platform. To achieve |
|
53 this, use the <varname>-k </varname> option to specify which version of the |
|
54 SIS Registry must be used to create the files. For example: </p> <p><userinput>interpretsis |
|
55 -k 5.1</userinput> </p> <p>If the SISRegistry version is not specified on |
|
56 the command line using the <codeph>–k</codeph> option, <b>InterpretSIS</b> generates |
|
57 SISRegistry according to the ROM marker file found in <filepath>z:\system\install\</filepath>. </p> <p>This |
|
58 marker file has the format <filepath>sisregistry_x.y.txt</filepath>, with |
|
59 x-y as the major-minor version number. If a marker file is not found and a |
|
60 version has not been specified on the command line, InterpretSIS by default |
|
61 generates version 5.1 SIS Registry entries. </p></section> |
|
62 <section id="GUID-1DF8C2AD-3BAB-4B03-8245-B37826C2910D"><title>Installing |
|
63 system upgrade packages</title><p>The InterpretSIS tool supports system upgrades |
|
64 for preinstalled packages. However, it cannot validate certificate chains. |
|
65 Therefore, even if signatures that chain back to a root certificate exists |
|
66 in the SWI certificate store trusted for system upgrades, <codeph>InterpretSIS</codeph> cannot |
|
67 determine that <codeph>RU</codeph> SIS files can be installed without a corresponding |
|
68 ROM Stub SIS file. </p> <p>To overcome this limitation, device creators can |
|
69 use the <codeph>+sucert</codeph> option in conjunction with the <codeph>–s</codeph> option. |
|
70 This indicates the SIS file is signed with a <codeph>SU</codeph> certificate. |
|
71 With this flag set, <codeph>InterpretSIS</codeph> can eclipse ROM files and |
|
72 override files from other packages. </p> <p><userinput>interpretsis -s file1.sis |
|
73 [+sucert] –s file2.sis</userinput> </p> <p> <b>Note:</b> Eclipsing can also |
|
74 be achieved using the <codeph>–e</codeph> option with <codeph>InterpretSIS</codeph>. |
|
75 However, the usage of <codeph>sucert</codeph> flag allows the SIS files to |
|
76 be re-installed by using the backup and restore functionality. It also represents |
|
77 the <codeph>SU</codeph> cert flag in the SIS Registry entries correctly. </p></section> |
|
78 <section id="GUID-2E68D8DF-461C-428E-9874-9B0DF47072F0"><title>Uninstalling |
|
79 preinstalled packages</title><p>Run <codeph>IntepretSIS</codeph> at the command |
|
80 prompt. Specify <codeph>–x</codeph> option with a comma seperated list of |
|
81 package UIds to remove preinstalled packages and associated files. </p> <p><userinput>interpretsis |
|
82 <options> –x <package UID>,<package UID>.</userinput> </p> <p>This |
|
83 command removes all upgrades and does not check for dependencies. </p> <p> <b>Notes:</b> </p> <ul> |
|
84 <li id="GUID-7D027408-D7A6-5358-9472-532605975B73"><p>The <codeph>-x</codeph> option |
|
85 cannot be used in conjunction with the <codeph>–s</codeph> option while installing |
|
86 SIS files. </p> </li> |
|
87 <li id="GUID-5BA93014-50B1-569E-8151-2439C710CE1C"><p>InterpretSIS cannot |
|
88 remove preinstalled packages from an external media card. These are packages |
|
89 that are installed to a media drive with the <codeph>+mccardalone</codeph> or <codeph>+mccardalonenr</codeph> option. |
|
90 These packages are not registered in the SIS Registry. </p> </li> |
|
91 </ul></section> |
|
92 <section id="GUID-B4A2D72C-95AB-44E6-8BF3-5CBA3957C67E"><title>Supporting |
|
93 device variant creation</title><p>InterpretSIS supports device variant creation |
|
94 through a configuration file. The configuration file must be specified using |
|
95 the -i option in the command line as shown in the following example: </p> <p><userinput>interpretsis |
|
96 -i config.txt</userinput> </p> <p>You can configure the following parameters: </p> <ul> |
|
97 <li id="GUID-2FEB48CA-AFE8-571F-A257-715C6962BB3A"><p> <b>HAL attribute values</b> </p> <p>Refer |
|
98 to <codeph>HALData::TAttribute</codeph> for a list of HAL attributes supported |
|
99 by the <codeph>InterpretSIS</codeph> tool. </p> <codeblock id="GUID-4F7A6D29-08F5-5915-83B6-7E61D6A570CF" xml:space="preserve">// The device specific version number, |
|
100 //as defined by the Symbian device creator. |
|
101 // |
|
102 // <numeric type> |
|
103 MANUFACTURERSOFTWAREREV = 0x200 |
|
104 </codeblock> </li> |
|
105 <li id="GUID-FCF6187B-323E-5FFF-98D5-B950492EC4B3"><p> <b>Additional Drives</b> </p> <p>Use |
|
106 the <codeph>DRIVE</codeph> keyword to define additional directories in the |
|
107 configuration file. As the drives on the device can be located internally |
|
108 (system drive) or externally (removable media drive), the keyword <codeph>ext</codeph> can |
|
109 be used to indicate that the defined drive is external: </p> <codeblock id="GUID-793972C9-569C-5A12-9808-9DA7FA47CE14" xml:space="preserve">DRIVE = Path drive-letter [ext]</codeblock> <p>By defining drives as <codeph>ext</codeph>, the device creators can create |
|
110 independent memory card images on them. The following examples represent paths |
|
111 to the <filepath>e</filepath> drive and <filepath>f</filepath> drive. </p> <codeblock id="GUID-FBB9549E-16F3-526C-BF2F-3DEAD2466AF6" xml:space="preserve">DRIVE = d:\drive_e e ext |
|
112 DRIVE = d:\drive_f f</codeblock> </li> |
|
113 <li id="GUID-E8D473F4-5D85-5FE4-A5B8-0ED60D670EEC"><p> <b>Language</b> </p> <p>Use |
|
114 the <codeph>LANGUAGE</codeph> keyword to define the SIS file installation |
|
115 preference language. The associated data is a decimal number as defined in <codeph>TLanguage</codeph> enum. </p> <codeblock id="GUID-1364BD16-E151-5986-8CE1-018F415109E7" xml:space="preserve">// Language code for the device |
|
116 // Refer TLanguage enum for language values |
|
117 // <numeric type> |
|
118 LANGUAGE = 2 // French |
|
119 </codeblock> </li> |
|
120 <li id="GUID-7162D239-9BA4-5789-B710-B3C7BE995E7C"><p> <b>Device Supported |
|
121 Language</b> </p> <p>Use the <codeph>DEVICE_SUPPORTED_LANGUAGE</codeph> keyword |
|
122 to define the languages supported by the Symbian device. This enables <codeph>IntepretSIS</codeph> to |
|
123 install language specific files for only those languages that are supported |
|
124 by the Symbian device. That is, during installation, the languages supported |
|
125 by the Symbian device are matched with the languages supported in the SIS |
|
126 file. When an exact match is found, the files corresponding to that language |
|
127 are copied to the Symbian device. If an exact match is not found for any of |
|
128 the device supported languages, the files for all equivalent languages (supported |
|
129 by the SIS files) corresponding to each of the device supported languages |
|
130 are copied to the Symbian device. </p> <p>For example, if the SIS file supports |
|
131 UK English(01), French(02) and International English(47), and the Symbian |
|
132 device supports only American English(10) then during installation, as an |
|
133 exact match for American English is not found, the files for UK English and |
|
134 International English (both equivalent match) are copied to the Symbian device. |
|
135 See <xref href="GUID-10A50B7C-63DB-599B-86C1-17989595CBD2.dita">Equivalent Languages |
|
136 Reference</xref> for a list of all language equivalents supported by Symbian |
|
137 Foundation. </p> <p>The following example illustrates the usage of <codeph>DEVICE_SUPPORTED_LANGUAGE</codeph> in |
|
138 the configuration file: </p> <codeblock id="GUID-7286DDA4-24BB-5D62-824F-9CCB23B077AB" xml:space="preserve">// Language supported by the device |
|
139 // Refer TLanguage enum for language values |
|
140 DEVICE_SUPPORTED_LANGUAGE = 01 |
|
141 DEVICE_SUPPORTED_LANGUAGE = 02 |
|
142 </codeblock><note> During installation, if an exact or an equivalent language |
|
143 match is not found in the SIS file, the files for the first language that |
|
144 is specified in the SIS file are copied to the Symbian device. </note></li> |
|
145 </ul></section> |
|
146 </refbody></reference> |