mksysimage.py

Syntax:

 mksysimage  [-o output] [options]... [board_name.external]

Runs on:

QNX Neutrino

Options:

-c, --mksysimage-config-file: Specify the configuration file used for the mksysimage.py utility.
-f, --force: Force the overwriting of existing tar files.
-g, --osversion-content: Specify any additional content for the os.version file.
-G, --no-gen, --no-generation: Run only mktar and imaging components.
--gen-ifs-options: Specify the options for gen-ifs.py (see gen-ifs.py --help).
--image-config-path: Specify the path of the configuration files for the mkimage utility.
-k, --mkimage-options: Specify the options for mkimage.py options (see mkimage.py --help).
-m, --mktar-options: Specify the options for mktar.py (see mktar.py --help).
--no-gen-ifs: Don't generate IFS files.
--no-mkimage: Don't generate the mkimage part of the process.
--no-mktar: Don't generate the mktar part of the process.
--no-gen-osversion: Don't generate an os.version.
-o, --output-path: Write image and tar files to the specified path. If a -t option is specified, tar files are written to the path specified.
-q, --quiet: Prevent any output.
-t, --tar-file-path: Read and write tar files to and from the specified path.
-v, --verbose: Increase the verbosity.

If you specify both the -p and -m options, any intermediate directories you have created have mode u+wx.

Description:

The mksysimage.py utility is a Python script that invokes other utilities to generate tar files and images for each platform. By default, mksysimage.py reads a configuration file from %QNX_TARGET%/<platform>/sd-boot/config/<platform>-mksysimage.cfg. This configuration file defines the .tar files and images created during the image-generation process. The image variants for each platform are defined within the configuration file. By default, for each image variant, mksysimage.py generates two tar files and one image. The tar file <platform>-os.tar contains two QNX CAR2 filesystems that include all files except MLO and IFS files. The tar file <platform>-dos-<image_variant> contains a FAT16 filesystem that includes all bootup files, such as MLO and IFS files. The final generated image includes these two tar files.

You can change the default configuration file associated with mksysimage.py (where the default file is located at %QNX_CAR_DEPLOYMENT%/<platform>/sd-boot/config/platform-mksysimage.cgf), or specify your own by using the -c option in mksysimage.py. Setting this option will enable you to further customize your tar files and images. For more information about changing the configuration file for mksysimage.py, see "Configuration file for mksysimage.py" in Building and Customizing Target Images. For information about calculating the size of images and partitions, see "Calculate the size of an image/partition" in in Building and Customizing Target Images. If you want mksysimage.py to generate only certain file types, use the following options:

To generate only:	Use the following options on the command line for mksysimage.py:
IFS files	`mksysimage -o outputpath <board>.external --no-mkimage --no-mktar --no-gen-osversion`
TAR files	`mksysimage -o outputpath <board>.external --no-mktar`
mkimage	`mksysimage -o outputpath <board>.external --no-gen-ifs --no-gen-mktar --nogen-osversion`

Examples:

To run mksysimage.py, you need to specify the platform, its variant, and the output path.

The following example reads the default configuration file for the omap5uevm platform and creates three images and their corresponding tar files in the specified output path called /tmp.

%QNX_TARGET%/scripts/mksysimage.py -o /tmp/ omap5uevm.external

Exit status:

0: The specified image file was created successfully.
>0: An error occurred.

Caveats:

None.