|
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-D9D20EE0-AC86-512A-91C0-EA0ACF3912A7" xml:lang="en"><title>Package-Header</title><abstract><p>The Package-Header includes package names for each of the supported |
|
13 languages, a unique identifier of the package, major version, minor version, |
|
14 build number of the package and package options. </p></abstract><prolog><metadata><keywords/></metadata></prolog><refbody> |
|
15 <refsyn id="GUID-4B9A1617-AAAA-4F8F-BB42-EA31098D6F60"><title>Syntax</title> <codeblock id="GUID-927D44CD-DB14-53E0-8734-873811937B97" xml:space="preserve">#{"Package name for language 1", ...}, (package-uid), major, minor, build-number[, package-options, ...]</codeblock> <p>For example: </p> <codeblock id="GUID-149C7501-7316-54F6-BEC2-B0A741755972" xml:space="preserve">#{"MyApp-EN", "MyApp-FR", "MyApp-Zulu"}, (0x1000001F), 1, 2, 3, TYPE=SA |
|
16 </codeblock> <ul> |
|
17 <li id="GUID-903FAC8D-2C01-504F-B52C-7CAE67DFBA11"><p> <b>Package Name</b>: |
|
18 Identifies the package in the installation dialogs and in the list of installed |
|
19 packages. The package name is language-dependent. The number of package names |
|
20 must equal the number of languages specified in the languages line and must |
|
21 be in the same order. </p> </li> |
|
22 <li id="GUID-A9A4ECAA-590F-57ED-99AF-CA99E2A9BE53"><p> <b>Package UID</b>: |
|
23 Identifies the package when installing, upgrading and removing the package. |
|
24 All package files require a UID. </p> <p>The UID, known as the package UID |
|
25 or pUID specified in the package header of an application (SISAPP) uniquely |
|
26 identifies the package. The installation fails if another installed package |
|
27 has the same pUID, unless the second package is a patch or an upgrade. The |
|
28 package creator is responsible for ensuring that the pUID is correctly allocated |
|
29 to ensure uniqueness. It can have the same value as the SID of an executable |
|
30 installed by the package. </p> <p>Package UIDs and SIDs are allocated through <xref href="https://www.symbiansigned.com" scope="external">https://www.symbiansigned.com</xref>. </p> <p>If |
|
31 the pUID is in the protected range, (less than 0x80000000), or if the package |
|
32 is installing an EXE whose SID is in the protected range, the package must |
|
33 be trusted. </p> </li> |
|
34 <li id="GUID-F012A4EF-7BCA-5D3F-8E59-AEECFE4CF171"><p> <b>Major, Minor versions</b>: |
|
35 Specifies the major and minor version numbers of the package and are required |
|
36 for version control. For example, <codeph>AppName 3.1</codeph> specifies major |
|
37 build 3, and minor build 1. </p> </li> |
|
38 <li id="GUID-8762C9E4-CF64-538F-82C3-A8E7B10C6AEC"><p> <b>Build Number</b>: |
|
39 Specifies the build number of the application. </p> </li> |
|
40 <li id="GUID-A16794C7-9FA9-5772-86D6-AC9A6120B1CD"><p> <b>Package-Options</b>: |
|
41 Specifies the various options that can be provided within package header. |
|
42 See the <xref href="GUID-D9D20EE0-AC86-512A-91C0-EA0ACF3912A7.dita#GUID-D9D20EE0-AC86-512A-91C0-EA0ACF3912A7/GUID-3F2B03BC-69F1-5498-8684-F6855D7E0F85">Package-Options</xref> section |
|
43 for details. </p> </li> |
|
44 </ul> <p id="GUID-3F2B03BC-69F1-5498-8684-F6855D7E0F85"><b>Package-Options</b> </p> <p>The |
|
45 following table lists the <codeph>Package-Options</codeph> that can be used: </p> <table id="GUID-5A361C0B-BF5C-50A3-AAA6-829F83D7134E"> |
|
46 <tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/> |
|
47 <thead> |
|
48 <row> |
|
49 <entry>Abbreviation</entry> |
|
50 <entry>Name</entry> |
|
51 <entry>Description</entry> |
|
52 </row> |
|
53 </thead> |
|
54 <tbody> |
|
55 <row> |
|
56 <entry/> |
|
57 <entry><p> <codeph>TYPE=Package-Type</codeph> </p> </entry> |
|
58 <entry><p>Specifies the <xref href="GUID-D9D20EE0-AC86-512A-91C0-EA0ACF3912A7.dita#GUID-D9D20EE0-AC86-512A-91C0-EA0ACF3912A7/GUID-3C2E7248-23BD-5A9C-BC4F-2F86B1A94002">Package-Type</xref> that |
|
59 identifies the purpose of the package. </p> </entry> |
|
60 </row> |
|
61 <row> |
|
62 <entry><p> <codeph>SH</codeph> </p> </entry> |
|
63 <entry><p> <codeph>SHUTDOWNAPPS</codeph> </p> </entry> |
|
64 <entry><p>Shuts down all applications on the device. </p> <p>Software installer |
|
65 terminates running applications on the device as needed during the installation |
|
66 process, so this flag is deprecated. </p> </entry> |
|
67 </row> |
|
68 <row> |
|
69 <entry><p> <codeph>NC</codeph> </p> </entry> |
|
70 <entry><p> <codeph>NOCOMPRESS</codeph> </p> </entry> |
|
71 <entry><p>Files are not compressed within the SIS file. </p> </entry> |
|
72 </row> |
|
73 </tbody> |
|
74 </tgroup> |
|
75 </table> <p id="GUID-3C2E7248-23BD-5A9C-BC4F-2F86B1A94002"><b>Package-Type</b> </p> <p>The |
|
76 following table lists the <codeph>Package-Type</codeph> that can be used within <codeph>Package-Options</codeph>: </p> <table id="GUID-B63C3151-7392-5136-9D87-E12C1BE6F991"> |
|
77 <tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/> |
|
78 <thead> |
|
79 <row> |
|
80 <entry>Abbreviation</entry> |
|
81 <entry>Name</entry> |
|
82 <entry>Description</entry> |
|
83 </row> |
|
84 </thead> |
|
85 <tbody> |
|
86 <row> |
|
87 <entry><p> <codeph>SA</codeph> </p> </entry> |
|
88 <entry><p> <codeph>SISAPP</codeph> </p> </entry> |
|
89 <entry><p>Specifies the package that contains an application. This is the |
|
90 default type. For details on upgrading applications, see <xref href="GUID-7FD72D9F-D65E-5248-A296-F2196F1DF5CF.dita">Upgrade |
|
91 Types</xref>. </p> </entry> |
|
92 </row> |
|
93 <row> |
|
94 <entry><p> <codeph>SP</codeph> </p> </entry> |
|
95 <entry><p> <codeph>SISPATCH</codeph> </p> </entry> |
|
96 <entry><p>Specifies a package that patches an existing component. It can be |
|
97 uninstalled separately from the package it patches. For more details, see <xref href="GUID-7FD72D9F-D65E-5248-A296-F2196F1DF5CF.dita">Upgrade Types</xref>. </p> </entry> |
|
98 </row> |
|
99 <row> |
|
100 <entry><p> <codeph>PU</codeph> </p> </entry> |
|
101 <entry><p> <codeph>PARTIALUPGRADE</codeph> </p> </entry> |
|
102 <entry><p>Specifies a package that partially upgrades an existing component. |
|
103 This is a variation of <codeph>SA</codeph> in that files which are present |
|
104 in the original package but not specified in the <codeph>PU</codeph> package |
|
105 are not removed. For more details, see <xref href="GUID-7FD72D9F-D65E-5248-A296-F2196F1DF5CF.dita">Upgrade |
|
106 Types</xref>. </p> </entry> |
|
107 </row> |
|
108 <row> |
|
109 <entry><p> <codeph>PA</codeph> </p> </entry> |
|
110 <entry><p> <codeph>PIAPP</codeph> </p> </entry> |
|
111 <entry><p>Specify this type to create applications that are preinstalled |
|
112 on media cards. </p> </entry> |
|
113 </row> |
|
114 <row> |
|
115 <entry><p> <codeph>PP</codeph> </p> </entry> |
|
116 <entry><p> <codeph>PIPATCH</codeph> </p> </entry> |
|
117 <entry><p>Specify this type to create patches that are preinstalled on media |
|
118 cards.</p> </entry> |
|
119 </row> |
|
120 </tbody> |
|
121 </tgroup> |
|
122 </table> <p>The following table explains the <codeph>RU</codeph> flag: </p> <table id="GUID-82539F7C-94B5-5D0D-A6CF-61253B5DCF8B"> |
|
123 <tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/> |
|
124 <thead> |
|
125 <row> |
|
126 <entry>Abbreviation</entry> |
|
127 <entry>Name</entry> |
|
128 <entry>Description</entry> |
|
129 </row> |
|
130 </thead> |
|
131 <tbody> |
|
132 <row> |
|
133 <entry><p> <codeph>RU</codeph> </p> </entry> |
|
134 <entry><p> <codeph>ROMUPGRADE</codeph> </p> </entry> |
|
135 <entry><p>This flag is required with the <codeph>SA</codeph> package type |
|
136 to carry out a full upgrade of an application in ROM. For details on using |
|
137 the RU flag for an upgrade of type SA, see <xref href="GUID-7FD72D9F-D65E-5248-A296-F2196F1DF5CF.dita">Upgrade |
|
138 Types</xref>. </p> </entry> |
|
139 </row> |
|
140 </tbody> |
|
141 </tgroup> |
|
142 </table> <p><b>Notes</b>:</p><ul> |
|
143 <li><p> All numbers can be hexadecimal. </p></li> |
|
144 <li><p>These options are mutually exclusive.</p></li> |
|
145 </ul> </refsyn> |
|
146 </refbody></reference> |