|
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-BF04B68E-7F77-5D99-A0F6-2842758EFD4D" xml:lang="en"><title>ROFSBUILD</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
13 <p>ROFSBUILD is the Symbian platform non-XIP (execute-in-place) ROM |
|
14 builder. It is normally invoked through <xref href="GUID-E4447BEF-33D2-5099-BCC1-C72FBB3B0463.dita">BUILDROM</xref>, |
|
15 the Symbian platform ROM configuration tool that acts as a front-end |
|
16 to ROFSBUILD. </p> |
|
17 <p>ROFSBUILD understands a sub-set of the BUILDROM OBEY file syntax. </p> |
|
18 <section id="GUID-492BCD7C-64FD-46A7-BAAD-170AE46FDF2A"> </section> |
|
19 <section id="GUID-B6CB21A1-2D96-5AF1-9193-FC03F4511080"><title>ROFSBUILD |
|
20 command syntax</title><p>If the OBY files are encoded in UTF-8 with |
|
21 non-ASCII character support, use the following the ROFSBUILD command |
|
22 syntax:</p><codeblock id="GUID-379818BF-A17B-5CAF-A311-3EE4142EE51D-GENID-1-2-1-8-1-1-6-1-1-6-1-2-4-3" xml:space="preserve">ROFSBUILD [options] [–oby-charset=utf-8 <obyfile>] </codeblock><p>If the OBY files are encoded in local character set with non-ASCII |
|
23 characters support, use the following the ROFSBUILD command syntax:</p><codeblock id="GUID-B3A01582-9631-57C6-A654-D5539DF1AE54-GENID-1-2-1-8-1-1-6-1-1-6-1-2-4-5" xml:space="preserve">ROFSBUILD [options] <obeyfile></codeblock><p> <codeph>options</codeph> can be one or more |
|
24 of the following: </p> <table id="GUID-FC77DA02-6ECE-5817-9550-A6004A8592AC"> |
|
25 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
26 <tbody> |
|
27 <row> |
|
28 <entry><p> <codeph>–argfile=<parameter file></codeph> </p> </entry> |
|
29 <entry><p>Accepts a parameter file, which contains a list of command-line |
|
30 parameters specific to the ROM tools, as input. </p> </entry> |
|
31 </row> |
|
32 <row> |
|
33 <entry><p> <codeph>-v</codeph> </p> </entry> |
|
34 <entry><p>Verbose mode. </p> </entry> |
|
35 </row> |
|
36 <row> |
|
37 <entry><p> <codeph>-?</codeph> </p> </entry> |
|
38 <entry><p>Displays more detailed help for the command. </p> </entry> |
|
39 </row> |
|
40 <row> |
|
41 <entry><p> <codeph>-s[log|screen|both] </codeph> </p> </entry> |
|
42 <entry><p>Displays a summary of the size to the specified destination, |
|
43 i.e. to the log, to the screen or to both the log and the screen. </p> </entry> |
|
44 </row> |
|
45 <row> |
|
46 <entry><p> <codeph> -d<bitmask></codeph> </p> </entry> |
|
47 <entry><p>Sets the trace bitmask; this only applies to debug builds. </p> <p>The simplest way of specifying this is to use a string of hexadecimal |
|
48 characters starting with 0x (e.g 0x01234567). However, any string |
|
49 that can be interpreted and translated into a valid TUint value may |
|
50 be used. See the standard C function strtoul(). </p> </entry> |
|
51 </row> |
|
52 <row> |
|
53 <entry><p> <codeph>-compress</codeph> </p> </entry> |
|
54 <entry><p>Compresses executable files where possible using the inflate |
|
55 (Deflate, Huffman+LZ77) algorithm unless the <codeph>-compressionmethod</codeph> keyword is used to override the default. </p> </entry> |
|
56 </row> |
|
57 <row> |
|
58 <entry><p> <codeph>-compressionmethod [none | inflate | bytepair] </codeph> </p> </entry> |
|
59 <entry><p>Can be used either with the <codeph>-compress</codeph> keyword |
|
60 or alone. </p> <p><table id="GUID-9D1C2D75-A0F5-5A60-ADC1-7357287B3B43"> |
|
61 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
62 <tbody> |
|
63 <row> |
|
64 <entry><p> <codeph>none </codeph> </p> </entry> |
|
65 <entry><p>No compression is used. </p> </entry> |
|
66 </row> |
|
67 <row> |
|
68 <entry><p>I<codeph>nflate</codeph> </p> </entry> |
|
69 <entry><p>Compresses executable files using the default (Deflate, |
|
70 Huffman+LZ77) algorithm. </p> </entry> |
|
71 </row> |
|
72 <row> |
|
73 <entry><p> <codeph>bytepair </codeph> </p> </entry> |
|
74 <entry><p>Compresses executable files using the bytepair algorithm. |
|
75 Bytepair compression allows faster decompression than the default |
|
76 Deflate, Huffman+LZ77 algorithm and supports demand paging by performing |
|
77 compression and decompression of code in independent 4 KB pages. </p> </entry> |
|
78 </row> |
|
79 </tbody> |
|
80 </tgroup> |
|
81 </table> </p> </entry> |
|
82 </row> |
|
83 <row> |
|
84 <entry><p> <codeph>-coreimage <core image file> </codeph> </p> </entry> |
|
85 <entry><p>Uses the specified core image file as the basis for creating |
|
86 the extension. </p> </entry> |
|
87 </row> |
|
88 <row> |
|
89 <entry><p> <codeph>-datadrive=<obeyfile_1>,[...,<obeyfile_n>]</codeph> </p> </entry> |
|
90 <entry><p>Specifies the data drive description IBY or OBY file. </p> </entry> |
|
91 </row> |
|
92 <row> |
|
93 <entry><p> <codeph>-lowmem</codeph> </p> </entry> |
|
94 <entry><p>Reduces the physical memory consumption during image generation. </p> </entry> |
|
95 </row> |
|
96 <row> |
|
97 <entry><p> <codeph>-loglevel<level></codeph> </p> </entry> |
|
98 <entry><p>Level of information to log file. The following valid log |
|
99 levels are available: </p> <p><table id="GUID-D14FA9B9-5FD9-5F43-A980-313E08E9E5A0"> |
|
100 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/> |
|
101 <tbody> |
|
102 <row> |
|
103 <entry><p> <codeph>0</codeph> </p> </entry> |
|
104 <entry><p>Default level of information to log file. </p> </entry> |
|
105 </row> |
|
106 <row> |
|
107 <entry><p> <codeph>1</codeph> </p> </entry> |
|
108 <entry><p>Logs the host or the ROM filenames, the file size, and the |
|
109 hidden attribute in addition to the <codeph>loglevel 0</codeph> information. </p> </entry> |
|
110 </row> |
|
111 <row> |
|
112 <entry><p> <codeph>2</codeph> </p> </entry> |
|
113 <entry><p>Logs the E32 file header attributes such as UIDs, data size, |
|
114 heap size, stack size, VID, SID, and priority in addition to the <codeph>loglevel 1</codeph> information. </p> </entry> |
|
115 </row> |
|
116 </tbody> |
|
117 </tgroup> |
|
118 </table> </p> </entry> |
|
119 </row> |
|
120 <row> |
|
121 <entry><p> <codeph>-wstdpath</codeph> </p> </entry> |
|
122 <entry><p>Displays a warning if a file is placed in a non-standard |
|
123 directory when <codeph>PlatSecEnforceSysBin</codeph> is set to <codeph>OFF</codeph>. </p><p> For example, the following instruction in |
|
124 OBY file leads to a warning when <codeph>-wstdpath</codeph> is used |
|
125 and <codeph>PlatSecEnforceSysBin</codeph> is <codeph>OFF</codeph>:</p><p><codeph>File=ABI_DIR/BUILD_DIR/hello.exe myfolder/bin/hello.exe</codeph></p> </entry> |
|
126 </row> |
|
127 <row> |
|
128 <entry><p> <codeph>-j<NUM_OF_WORKING_THREADS></codeph> </p> </entry> |
|
129 <entry><p>Specifies the number of working threads that can run concurrently |
|
130 to create a ROFS image. The <codeph><NUM_OF_WORKING_THREADS></codeph> must be an integer in the range 1-128. </p> <p>If the <codeph>-j</codeph> option is not specified or an invalid value is specified, ROFSBUILD |
|
131 automatically takes the number of working threads in the following |
|
132 ways: </p> <ul> |
|
133 <li id="GUID-4EE0BEB1-C6AE-559A-99E6-4713F721DDB6"><p>If the <codeph>NUMBER_OF_PROCESSORS</codeph> environment variable is set properly, |
|
134 ROFSBUILD uses the number of processors as the number of working threads. </p> </li> |
|
135 <li id="GUID-541008FB-8416-5582-86E2-254FA001FC00"><p>If the <codeph>NUMBER_OF_PROCESSORS</codeph> environment variable is not set or |
|
136 is invalid, the default value <codeph>8</codeph> is used as the number |
|
137 of working threads. </p> </li> |
|
138 </ul> </entry> |
|
139 </row> |
|
140 <row> |
|
141 <entry><p> <codeph>-cache</codeph> </p> </entry> |
|
142 <entry><p>Enables cache mechanism. It ensures that ROFSBUILD uses |
|
143 cached executable files while creating a ROFS image. This allows ROFSBUILD |
|
144 to reuse or generate cached files. </p> <p> <b>Notes</b>: </p> <ul> |
|
145 <li id="GUID-9B7056D4-EF5B-533B-9E9F-50AD9A7BF498-GENID-1-2-1-8-1-1-6-1-1-6-1-2-4-7-1-3-14-2-3-1"><p>The cache mechanism |
|
146 is disabled by default. </p> </li> |
|
147 <li id="GUID-AF355401-C732-5FB5-A472-D7EEB294E4E0-GENID-1-2-1-8-1-1-6-1-1-6-1-2-4-7-1-3-14-2-3-2"><p>The cached files |
|
148 are stored on the hard disk. </p> </li> |
|
149 <li id="GUID-7EEA01CD-E155-535B-915B-DE22C42FEDD0-GENID-1-2-1-8-1-1-6-1-1-6-1-2-4-7-1-3-14-2-3-3"><p>The cache command |
|
150 line options (<codeph>-cache</codeph>, <codeph>-nocache</codeph>, |
|
151 and <codeph>-cleancache</codeph>) are mutually exclusive. This means |
|
152 that you can use only one cache option at a time. </p> </li> |
|
153 </ul> </entry> |
|
154 </row> |
|
155 <row> |
|
156 <entry><p> <codeph>-nocache</codeph> </p> </entry> |
|
157 <entry><p>Disallows ROFSBUILD from using cached files while creating |
|
158 a ROFS image. </p> </entry> |
|
159 </row> |
|
160 <row> |
|
161 <entry><p> <codeph>-cleancache</codeph> </p> </entry> |
|
162 <entry><p>Deletes all cached files from the hard disk. </p> </entry> |
|
163 </row> |
|
164 <row> |
|
165 <entry><p><codeph>-symbols</codeph></p></entry> |
|
166 <entry><p>Generates symbols for each data or executable specified |
|
167 in the OBY file. </p><p><b>Note</b>: The symbols file is not generated |
|
168 by default.</p></entry> |
|
169 </row> |
|
170 <row> |
|
171 <entry><p><codeph>-smr=<smrhcr_rofsbuild_obeyfile_1>,[…, <smrhcr_rofsbuild_obeyfile_n>]</codeph></p></entry> |
|
172 <entry><p>Creates SMR partition images.</p></entry> |
|
173 </row> |
|
174 <row> |
|
175 |
|
176 <entry><p><codeph>-prependepocroot</codeph></p></entry> |
|
177 <entry><p>Prepends EPOCROOT to the file location, if the specified |
|
178 location starts from <codeph>\epoc32</codeph> without <codeph>EPOCROOT</codeph>.</p></entry> |
|
179 </row> |
|
180 </tbody> |
|
181 </tgroup> |
|
182 </table> <p> <codeph><obeyfile></codeph> is a standard text file |
|
183 containing statements that are used to control the operation of the |
|
184 tool. </p> <p>See the <xref href="GUID-9CF985F1-C100-5999-9410-58B7865A1E18.dita">OBEY files</xref> reference for the full syntax. </p> </section> |
|
185 </conbody></concept> |