diff -r 578be2adaf3e -r 307f4279f433 Adaptation/GUID-003D2C5B-09DC-5BD1-AF45-A0FCB56F567B.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Adaptation/GUID-003D2C5B-09DC-5BD1-AF45-A0FCB56F567B.dita Fri Oct 15 14:32:18 2010 +0100 @@ -0,0 +1,172 @@ + + + + + +ROMBUILD +

ROMBUILD is the Symbian platform binary 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 ROMBUILD.

+
+
ROMBUILD +command syntax

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

ROMBUILD [options] [–oby-charset=utf-8 <obyfile>] [-datadrive=<fat.oby>]

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

ROMBUILD [options] <obeyfile> [-datadrive=<fat.oby>]

The following command line options are supported:

+ + + +

–argfile=<parameter file>

+

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

+
+ +

-?

+

Displays more detailed help for the command.

+
+ +

-coff-header

+

Uses a PE-COFF header instead of a Symbian platform header. PE-COFF is a Portable Executable–Common Object File +Format and is a Microsoft extension to the COFF standard.

+
+ +

-compress

+

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

+
+ +

-compressionmethod [none | inflate | bytepair]

+

Specifies the compression algorithm to use. 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 ROM image file>

+

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

If the given core ROM image file +is invalid or does not exist, an error message is displayed.

+
+ +

-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 (for example, 0x01234567). However, any +string that can be interpreted and translated into a valid TUint value +may be used. See the standard C function strtoul().

+
+ +

-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.

+
+ + +

+
+ +

-no-header

+

Suppresses the image loader header.

+
+ +

-no-sorted-romfs

+

Does not add sorted entry arrays (6.1 compatible). It is +a table of offsets for the subdirectories and files which are not +in the sorted order.

+
+ +

-r<fileName>

+

Compares the generated ROM image with the ROM image whose +file name is specified.

+
+ +

-s[log|screen|both]

+

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

+
+ +

-v

+

Verbose mode.

+
+ +

-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 ROM 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, ROMBUILD +uses the following ways to determine the number of working threads:

    +
  • If the NUMBER_OF_PROCESSORS environment variable is set correctly, +ROMBUILD 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.

  • +
+
+ +

-gendep

+

Generates a dependencies file describing internal dependencies +among executables or dlls in a ROM image.

Note: You can +only generate dependence information in the paged section of a ROM +image.

+
+ +

-symbols

+

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

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

+
+ + +

<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