diff -r 578be2adaf3e -r 307f4279f433 Adaptation/GUID-BF04B68E-7F77-5D99-A0F6-2842758EFD4D.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Adaptation/GUID-BF04B68E-7F77-5D99-A0F6-2842758EFD4D.dita Fri Oct 15 14:32:18 2010 +0100 @@ -0,0 +1,185 @@ + + + + + +ROFSBUILD +

ROFSBUILD is the Symbian platform non-XIP (execute-in-place) ROM +builder. It is normally invoked through BUILDROM, +the Symbian platform ROM configuration tool that acts as a front-end +to ROFSBUILD.

+

ROFSBUILD understands a sub-set of the BUILDROM OBEY file syntax.

+
+
ROFSBUILD +command syntax

If the OBY files are encoded in UTF-8 with +non-ASCII character support, use the following the ROFSBUILD command +syntax:

ROFSBUILD [options] [–oby-charset=utf-8 <obyfile>]

If the OBY files are encoded in local character set with non-ASCII +characters support, use the following the ROFSBUILD command syntax:

ROFSBUILD [options] <obeyfile>

options can be one or more +of the following:

+ + + +

–argfile=<parameter file>

+

Accepts a parameter file, which contains a list of command-line +parameters specific to the ROM tools, as input.

+
+ +

-v

+

Verbose mode.

+
+ +

-?

+

Displays more detailed help for the command.

+
+ +

-s[log|screen|both]

+

Displays a summary of the size to the specified destination, +i.e. to the log, to the screen or to both the log and the screen.

+
+ +

-d<bitmask>

+

Sets the trace bitmask; this only applies to debug builds.

The simplest way of specifying this is to use a string of hexadecimal +characters starting with 0x (e.g 0x01234567). However, any string +that can be interpreted and translated into a valid TUint value may +be used. See the standard C function strtoul().

+
+ +

-compress

+

Compresses executable files where possible using the inflate +(Deflate, Huffman+LZ77) algorithm unless the -compressionmethod keyword is used to override the default.

+
+ +

-compressionmethod [none | inflate | bytepair]

+

Can be used either with the -compress keyword +or alone.

+ + + +

none

+

No compression is used.

+
+ +

Inflate

+

Compresses executable files using the default (Deflate, +Huffman+LZ77) algorithm.

+
+ +

bytepair

+

Compresses executable files using the bytepair algorithm. +Bytepair compression allows faster decompression than the default +Deflate, Huffman+LZ77 algorithm and supports demand paging by performing +compression and decompression of code in independent 4 KB pages.

+
+ + +

+ + +

-coreimage <core image file>

+

Uses the specified core image file as the basis for creating +the extension.

+
+ +

-datadrive=<obeyfile_1>,[...,<obeyfile_n>]

+

Specifies the data drive description IBY or OBY file.

+
+ +

-lowmem

+

Reduces the physical memory consumption during image generation.

+
+ +

-loglevel<level>

+

Level of information to log file. The following valid log +levels are available:

+ + + +

0

+

Default level of information to log file.

+
+ +

1

+

Logs the host or the ROM filenames, the file size, and the +hidden attribute in addition to the loglevel 0 information.

+
+ +

2

+

Logs the E32 file header attributes such as UIDs, data size, +heap size, stack size, VID, SID, and priority in addition to the loglevel 1 information.

+
+ + +

+
+ +

-wstdpath

+

Displays a warning if a file is placed in a non-standard +directory when PlatSecEnforceSysBin is set to OFF.

For example, the following instruction in +OBY file leads to a warning when -wstdpath is used +and PlatSecEnforceSysBin is OFF:

File=ABI_DIR/BUILD_DIR/hello.exe myfolder/bin/hello.exe

+
+ +

-j<NUM_OF_WORKING_THREADS>

+

Specifies the number of working threads that can run concurrently +to create a ROFS image. The <NUM_OF_WORKING_THREADS> must be an integer in the range 1-128.

If the -j option is not specified or an invalid value is specified, ROFSBUILD +automatically takes the number of working threads in the following +ways:

    +
  • If the NUMBER_OF_PROCESSORS environment variable is set properly, +ROFSBUILD uses the number of processors as the number of working threads.

  • +
  • If the NUMBER_OF_PROCESSORS environment variable is not set or +is invalid, the default value 8 is used as the number +of working threads.

  • +
+
+ +

-cache

+

Enables cache mechanism. It ensures that ROFSBUILD uses +cached executable files while creating a ROFS image. This allows ROFSBUILD +to reuse or generate cached files.

Notes:

    +
  • The cache mechanism +is disabled by default.

  • +
  • The cached files +are stored on the hard disk.

  • +
  • The cache command +line options (-cache, -nocache, +and -cleancache) are mutually exclusive. This means +that you can use only one cache option at a time.

  • +
+
+ +

-nocache

+

Disallows ROFSBUILD from using cached files while creating +a ROFS image.

+
+ +

-cleancache

+

Deletes all cached files from the hard disk.

+
+ +

-symbols

+

Generates symbols for each data or executable specified +in the OBY file.

Note: The symbols file is not generated +by default.

+
+ +

-smr=<smrhcr_rofsbuild_obeyfile_1>,[…, <smrhcr_rofsbuild_obeyfile_n>]

+

Creates SMR partition images.

+
+ + +

-prependepocroot

+

Prepends EPOCROOT to the file location, if the specified +location starts from \epoc32 without EPOCROOT.

+
+ + +

<obeyfile> is a standard text file +containing statements that are used to control the operation of the +tool.

See the OBEY files reference for the full syntax.

+
\ No newline at end of file