Keyword reference

This page lists the keywords starting from S to Z.

secondary

secondary = <source-file> <destination-image-file> [File-attribute-list] [Override-Attribute-list]

rombuild only

A standard executable file that is loaded by the kernel; this is the file server. All subsequent files can be loaded through the file server.

As with all standard executable files, this is loaded, relocated and stripped of its relocation information.

section

rombuild only

ROMs can be sectioned into two parts allowing the upper part of the ROM to be switched for language variations and file patching. This is independent of the extension ROM mechanism.

This keyword appears at the point in the obey file where the ROM to be split. All files before this line appear in the first (constant) section: Files after appear in the second (patch/language) section.

SECTION2

SECTION2 <anything>

BUILDROM only

Provides support for rombuild's capability to create ROMs divided into two sections.

The two sections are termed the upper and lower section. The upper section can be replaced without needing to change the lower section. This facility is most often used to put localised resource files into the upper section. This keyword provides BUILDROM's support for gathering marked obey source lines and placing them in the upper section of the ROM.

All lines beginning with the SECTION2 keyword are removed from the .iby file and are placed into a separate list with the SECTION2 keyword removed. When BUILDROM encounters the section keyword, the accumulated SECTION2 list is inserted after the section line, and subsequent SECTION2 keywords are removed as they occur. If no section keyword is found the accumulated SECTION2 list is emitted after the end of the input file(s).

For example:

LANGUAGE_CODE 01
LANGUAGE_CODE 10
DEFAULT_LANGUAGE 10
file=sourcedir\myapp.dll destdir\myapp.dll
SECTION2 REM bitmaps for myapp
SECTION2 bitmap=MULTI_LINGUIFY( MBM sourcedir\myapp destdir\myapp )
file=sourcedir\myengine.dll destdir\myengine.dll
section 0x800000
file=sourcedir\example destdir\example
SECTION2 data=sourcedir\example2 destdir\example2
      

becomes:

file=sourcedir\myapp.dll destdir\myapp.dll
file=sourcedir\myengine.dll destdir\myengine.dll

section 0x800000
REM bitmaps for myapp
data=sourcedir\myapp.M01_rom destdir\myapp.M01
data=sourcedir\myapp.M10_rom destdir\myapp.MBM

file=sourcedir\example destdir\example
data=sourcedir\example2 destdir\example2

See also MULTI_LINGUIFY.

sectorsize

sectorsize=<number of bytes>

rofsbuild only

Configures the number of bytes in each sector for the file system in data-drive images.

singlekernel

singlekernel

rombuild only

Specifies that this ROM image has one kernel executable within it. This is the default.

Note that this keyword is mutually exclusive with multikernel keyword.

sisfile

sisfile = <source-file>

BUILDROM only

Specifies the sis files to be installed on the data drive.

Note: A directory containing sis files can also be provided as input to this keyword.

spidata

spidata = <source-file> <original-destination-file> <spi-id> <target-spi-dir>

BUILDROM only

Specifies input files used to create a static plug-in information (SPI) file.

Its parameters are:

source-file

The location of the source file. This is the resource file to build into the SPI file.

original-destination-file

The location that the resource should be placed in if the SPI file is not created.

spi-id

Name of the SPI file in which the resource should be stored. For ECom, this is ecom.spi.

target-spi-dir

The directory in which to create the SPI file in the ROM image.

An SPI file concatenates several resource files together. It is currently used to record the ECom plug-ins that are in ROM. This allows the ECom framework to register the ROM-based plug-ins without having to scan the file system for individual resource files. IBY files are not expected to use the spidata keyword directly for this purpose: instead, they should use the ECOM_PLUGIN macro (see __ECOM_PLUGIN) which BUILDROM converts to the required spidata statement.

Note that creation of SPI files is optional (see BUILDROM). If it is switched on:

  • the spidata statements are processed to determine which SPI files need to be created. spitool is called to create an SPI file, and a data statement is generated in the final IBY file to include an SPI file in ROM.

  • copies of each SPI file are placed in the same directory as the created ROM image. This is necessary for the possibility of creating extension/composite ROMs.

  • any resource files included in an SPI file are not placed in the ROM image. This avoids duplication and an unnecessary increase in the size of the ROM.

If SPI creation is switched off all resource files are placed in the ROM image in the locations specified by the <original-destination-file> parameters of the spidata statements.

spidatahide

spidatahide = <source-file> <spi-id> <target-spi-dir>

BUILDROM only

Specifies the files that need to be marked as hidden in the static plug-in information (SPI) file, to hide the associated ECom plug-in in the ROM.

Its parameters are:

source-file

The location of the source file to be marked as hidden in the SPI file.

spi-id

The SPI file name in which the resource should be stored. For ECom, this is ecom.spi or ecom.snn.

target-spi-dir

The directory in which to create the SPI file in the ROM image.

The file is marked as hidden in the SPI file by writing the data length of the file as 0. A resource language file can be overridden using this keyword in the IBY file. If you intend to hide both the resource file and the DLL, use the HIDE_ECOM_PLUGIN macro (see _HIDE__ECOM_PLUGIN), which enables BUILDROM to generate the required spidatahide statement.

Note that creation of SPI files is optional (see BUILDROM). If BUILDROM is allowed to generate the SPI files, the spidatahide statements are processed to determine which resource file should be hidden in the SPI files that are to be created. The BUILDROM calls the spitool to create an SPI file, and a data statement is added to the final .IBY file to include the SPI file in the ROM.

srecordbase

srecordbase = <hex-address>

rombuild only

Destination address for S-record download.

srecordfilename

srecordfilename = <srec-file-name>

rombuild only

rombuild can write an image in Motorola S-record format. This happens if a name for the output file is specified here. A filename of "*" can be specified, which means use the file name specified on the romname keyword and append .screc.

stack

stack = <hex-size>

rombuild only

Overrides the default stack size for the executable.

stackreserve

stackreserve = <hex-size>

rombuild only

Overrides the maximum size of the stack.

stop

stop

rombuild and rofsbuild

Stops processing the obey file. The rom image is not generated.

time

time = dd/mm/yyyy hh:mm:ss

rombuild and rofsbuild

If specified, overwrites the date-time stamp of the ROM image with this value. If not specified, the image is time and date stamped from the system clock of the build PC.

TODAY

TODAY

BUILDROM only

A pre-defined substitution. This is replaced with today's date in the format dd/mm/yy

Note that there is no UNDEFINE facility, and substitutions are applied in an unspecified order.

trace

trace = <32 bit hex-number>

rombuild and rofsbuild

Turns on rombuild tracing. This is internal to Symbian.

uid1

uid1 = <uid-value>

rombuild only

Overrides the first UID for the executable.

uid2

uid2 = <uid-value>

rombuild only

Overrides the second UID for the executable.

uid3

uid3 = <uid-value>

rombuild only

Overrides the third UID for the executable.

unicode

unicode

rombuild only

Indicates that this is a Unicode build; this is the default if not present and ascii is not coded.

variant[[HWVD]]

variant[[HWVD]] = <source-file> <destination-image-file> [File-attribute-list] [Override-Attribute-list]

rombuild only

Defines hardware variants.

It should be applied to the variant DLL. The ecust.dll of each hardware variant to be supported, and must specify a suitable HWVD. Note that the HWVD must be enclosed within square brackets.

version

version = [ <major> ] [ .<minor> ] [ (<build>) ]

rombuild and rofsbuild

The ROM version number as represented by its three component values.

volume

volume=<volume label>

rofsbuild only

Configures the volume label for the file system in data-drive images.

WARNING

WARNING <anything at all>

BUILDROM only

Prints the rest of the line following the WARNING keyword to standard output, and reports the source file name and the line number.

zdriveimagename

zdriveimagename = <image name.img>

BUILDROM only

Specifies the name of the Z drive description image file( ROM, ROFS, extension ROFS or CORE image).