mkqnx6fsimg

Runs on:

Linux, Mac, Microsoft Windows

Options:

-?

(QNX Neutrino 7.0 or later) Display some help information.

-D

Treat undeclared intermediate directories as errors. If there's a target filesystem entry of /x/y, and /x has never occurred explicitly in the buildfile, the patch file, the input directory, or as a child of a recursively included directory, then /x is considered an undeclared intermediate directory.

-d

Display warnings for undeclared intermediate directories.

-f path

Fill the specified text file with a list of all files in the output image, including a hash of the file contents, and data similiar to that returned by the ls -l command. The file is truncated if it already exists. Each line has the form:

target-path uid:gid mode_in_octal size [SHA256]

You can express the mode_in_octal as a 6-digit octal number; see the st_mode member in the stat structure.

-h

(QNX Neutrino 7.0 or later) Import hard links from the host filesystem as hard links. The default behavior is to create copies of the linked files.

-l inputline

(“el”) Process inputline before interpreting the buildfile. Input lines given to mkqnx6fsimg should be quoted to prevent interpretation by the shell. Multiple -l options are processed in the order specified. This option is especially useful for setting global attributes when the input is a directory only.

-n[n..]

Don't use timestamps in the files. Using the -n option permits identical images in binary format. One n strips timestamps from files that vary from run to run. More than one strips ALL time information, which is necessary on Windows NTFS with daylight saving time.

-o directory

(“oh”) Specify a directory to be used for all permanent build artifacts, other than the output image itself.

-p patchfile

Apply patching instructions from this file (see “Patch files,” below).

-r rootdir

This option doesn't immediately affect where mkqnx6fsimg searches for host files; it only adds standard search paths under rootdir to the MKIFS_PATH environment variable. Because this variable isn't used as the default value for the search attribute (unlike with mkifs), you must do the following to make mkqnx6fsimg behave like mkifs when searching for files:

1. Add the line [search=${MKIFS_PATH}] near the beginning of your buildfile. For more information, see the search attribute and the MKIFS_PATH description.
2. Set the PROCESSOR and PROCESSOR_BASE environment variables based on the target platform.

Then, when searching for files, mkqnx6fsimg will search the default paths used for storing binaries within the rootdir directory before searching the default paths within ${QNX_TARGET}.

You can define multiple -r options; each adds a set of paths to search for files. For an explanation of how multiple -r options are handled, see the mkifs -r option.

-v[v..]

Operate verbosely. Specifying additional v options increases the verbosity. The default is quiet operation.

Description:

The mkqnx6fsimg utility reads a text buildfile and/or a specified directory and produces a binary image file containing a Power-Safe (fs-qnx6.so) filesystem created from the given input. You can copy this file to target media at a later stage.

If you don't specify either a buildfile or a directory, a buildfile is expected as input from standard input. The output is always an image file; if you don't specify outputfile, image-file data will be produced on standard output.

License checking

The mkqnx6fsimg utility checks for a valid QNX license key before performing any operation. If the license check fails, the utility stops running and displays a diagnostic message. A license check may fail if the license key is expired, missing, or not currently activated, or if the key doesn’t contain the permissions needed to run the utility.

Buildfiles

The mkqnx6fsimg command uses the same buildfile grammar as mkifs, but supports a different set of attributes. The buildfile is basically just a list of files that you want to be included in the Power-Safe image file when it's built by mkqnx6fsimg. As well as identifying the files to be included, you can specify various attributes that are used to set parameters of the filesystem and the files in it. For example, you can specify the maximum size of the filesystem, or the user and group IDs of the individual files.

In a buildfile, a pound sign (#) indicates a comment; anything between it and the end of the line is ignored. There must be a space between a buildfile command and the pound sign.

Each line is in the form:

[attributes] file_specification

where the attributes (with the enclosing square brackets) and the file specification are both optional.

You can use an attribute:

• on the same line as a filename, in which case the attribute modifies only that file. In this example, the attribute modifies only file A:

  [attribute] A
  B
  C
  

• on a line by itself, in which case the attribute modifies all subsequent files. In this example, the attribute modifies files A, B, and C:

  [attribute]
  A
  B
  C
  

Attributes provide information about the file following the attribute. They are enclosed in square brackets; when combining attributes (e.g., to specify both the user ID and the group ID), enclose both attribute tokens in the same pair of square brackets. For example:

# correct way
[uid=5 gid=5] filename
# incorrect way
[uid=5] [gid=5] filename

There are two types of attributes:

boolean attributes

Those prefixed with a plus (+) or minus (-) sign.

value attributes

Those ending with an equals sign (=) followed by a value. Don't put any spaces around the equals sign.

?+bigendian 

You can enclose a filename in double quotes (") if it includes spaces or unusual characters.

Attributes

In mkqnx6fsimg buildfiles, the following attributes are supported:

• acl=acl_spec
• +|-alimit
• +|-bigendian
• blksize=size_spec
• +|-boot_cls
• +|-boot_quiet
• cd=pathname
• cksum=number
• +|-dflt_boot
• dom=ref
• dperms=dperms_spec
• drop=[pattern]
• +|-dupignore
• filter=filter_spec
• +|-followlink
• +|-fsys_lfncks
• gid=id_spec
• +|-include
• max_sectors=count
• mtime=time_spec
• +|-name_enc
• namedom=nr
• newdom=nr,key[,type[,hmac]]
• num_blocks=count
• num_groups=count
• num_inodes=count
• num_sectors=count
• +|-optional
• perms=perms_spec
• prefix=path
• reserve=number
• search=path[:path...]
• sector_size=size_spec
• sha256=hex_string
• type=file_type
• uid=id_spec
• usage=usage
• uuid=uuid
• vol_name=string

The following attributes are recognized, but not semantically supported by mkqnx6fsimg:

• mountperms=perms_spec

Although default values are defined to generate a 256 MB image, you should explicitly specify at least the image size, preferably by specifying at least num_sectors, to ensure that the image produced is fully compatible with your specific target device.

An OR-bar indicates that either the first element or the second element must be present, but not both (e.g., +|-bigendian means either +bigendian or -bigendian, but not +-bigendian).

acl attribute

acl=acl_spec

The components are as follows:

tag

One of u (user), g (group), or o (other).

opt_qualifier

Either empty or a decimal numeric user ID or group ID if tag was uor g.

permset

The set of permissions granted. Valid characters are r (read), w (write), x (execute), and - (a fill character that doesn't affect permissions). The r, w, and x characters can appear in any order, but at most once each.

This is fairly similar to the “short text” form of ACLs in other implementations of IEEE 1003.1e draft 17 ACLs, with a few exceptions:

• Only single-character tags are allowed.
• The qualifier, if given, must be numeric.
• No whitespace or other characters are allowed.
• The mask can't be explicitly specified.

For more information about ACLs, see “Access Control Lists” in the “Working with Files” chapter of the QNX Neutrino User's Guide.

alimit attribute (boolean)

+|-alimit

Set the allocation limit extended mode bit (QNX6FS_EMODE_ALIMIT) for files that the attribute applies to. When this bit is set, operations fail with ENOSPC if they attempt to grow the file to a size that would cause the mounted volume's free space to drop below its allocation limit value. (For information on setting the allocation limit, see the alimit option for fs-qnx6.so.) The default is QNX6FS_EMODE_ALIMIT is not set.

If the file you set the allocation limit extended mode bit for is a directory, any new files created within that directory inherit the set bit.

bigendian attribute (boolean)

+|-bigendian

Set the byte order for the Power-Safe filesystem to either big (via +bigendian) or little (via -bigendian) endian. The default is host's native endianness.

blksize attribute

blksize=size_spec

Set the block size for the Power-Safe filesystem. The block size determines the minimum allocatable amount in the filesystem. You can specify any power-of-two block size from 512 to 32768 bytes. The size_spec argument is an integer, optionally followed by K (the case doesn't matter). The default value is 4096 bytes.

boot_cls attribute (boolean)

+|-boot_cls

Clear (+) or don't clear (-) the screen while booting. The default is not to clear.

boot_quiet attribute (boolean)

+|-boot_quiet

If set, instructs the boot loader to silently boot the latest boot image, without presenting a boot-image selection menu. The default is not to boot quietly.

cd attribute

cd=pathname

Set the current working directory to the specified pathname before attempting to open the host file. The default is the directory from which you invoked mkqnx6fsimg.

You can specify variables in the attribute's value. For information on how they're expanded (i.e., evaluated to a value used in their place), see the mkxfs section on processing variables.

In the pathname, you can use forward slashes (/) as directory delimiters, even on Windows. It is strongly recommended to do so, because backslashes may adversely affect the functionality of your buildfile.

cksum attribute

cksum=number

Specify the expected checksum (as calculated by the cksum utility) of the file that the attribute applies to. If you specify this attribute, mkqnx6fsimg calculates the checksum of the host file imported into the image and compares it to the expected value; if a mismatch is detected, the program terminates with an error.

dflt_boot attribute (boolean)

+|-dflt_boot

Specify the boot image to use by default at system startup. You can set this to true on at most one file in the image. That file must be a regular file and reside in /.boot/ in the target filesystem.

Since the boot loader chooses the .boot entry with the most recent st_mtime as the default boot image, this flag may affect the modification time of the file it was set on. The file's st_mtime is modified, if necessary, such that it's one more than the maximum of all modification times in .boot.

dom attribute

dom=ref

dperms attribute

dperms=dperms_spec

Set the access permissions of the directory. The dperms_spec can be one of the following:

• a number (just as with the chmod command)
• an asterisk (*) to use the host directory's permissions. For directories that don't exist on the host but are created in the buildfile, the permissions are 0755 (rwxr-xr-x). For more information about these target-only directories, see the explanation about directory permissions in the Building Embedded Systems guide.
• a symbolic mode string to delete, add, or set permissions. This string is similar (but not identical) to chmod's and is as follows (with spaces added for clarity):

  [who] operator permissions[, ...]

  The components are as follows:

  who

  A combination of zero or more of the following:

  Character	Meaning
  u	User
  g	Group
  o	Others
  a	All (the default if you don't specify who)

  operator

  One of the following:

  Character	Meaning
  -	Delete the specified permissions
  =	Explicitly set the permissions
  +	Add the specified permissions

  permissions

  A combination of one or more of the following:

  Character	Meaning
  r	Read permission
  w	Write permission
  x	Execute permission, or search permission for directories
  s	When executed, set the user ID
  g	When executed, set the group ID
  t	Sticky bit

  You can include multiple symbolic mode strings, separating them with commas (,).

The default dperms_spec is *.

drop attribute

drop=[pattern[|pattern]...]

(QNX Neutrino 7.1 or later) Specify patterns of file names that you want to ignore when recursively importing host directories. Each pattern is a simple filename wildcard pattern that can include the following meta-characters:

?

Match exactly one arbitrary character.

*

Match zero or more arbitrary characters.

\

Treat the next character literally.

For example:

[drop=*.sym] bin
[drop=*.a|*.dll] lib

Note the following:

• Exclusion applies only during the recursive inclusion of directories; it doesn't apply to any items that you explicitly name in the buildfile.
• Exclusion applies only to files and symbolic links, not subdirectories.
• The pattern is compared only to the filename portion of the items encountered during directory import, not to any directory components of their pathnames.
• The pattern refers to both the host and the target filename (because individual names can't be altered during recursive inclusion).
• Pattern-matching is case-sensitive (as it would on the target).

Specifying the drop attribute without a pattern turns off exclusion in subsequent directories (unless you specify another drop attribute).

dupignore attribute

+|-dupignore

Specify whether mkqnx6fsimg should ignore duplicate file entries. When buildfiles are defined from templates by external tools, or when the content is split across multiple files that are then combined with the include attribute, there might be multiple entries defining the same target path. Enabling this attribute (+dupignore) allows you to continue using your buildfile structures when you can't change some parts of the image specification and might have to handle duplicate file entries.

If this attribute is undefined for a file entry, the default value is disabled (-dupignore).

When an entry is ignored, mkqnx6fsimg reports it if the verbosity level is greater than one (e.g., if -vv is used).

For file entries to be considered duplicates, the target path is the only thing that must match. Other attributes that affect files, such as uid, gid, and perms can differ, but the dupignore settings in effect for any entries containing a given target path determine which entry gets included in the image. It's up to the buildfile writer or systems integrator who generates the target image to ensure that what's included at a given target path has all the appropriate attribute settings.

[-dupignore] sshd = path/to/sshd

[+dupignore, uid=0] xyz = /etc/abc

[+dupignore, uid=1] xyz = /vars/def

In this last example, the two host files specified for the common target location are not identical, but again, the target path is the only thing that determines whether their entries are duplicates.

filter attribute

filter=filter_spec

Run the host file through the filter program specified, presenting the host file data as standard input to the program and using the standard output from the program as the data to be placed into the Power-Safe filesystem. Default is no filter. You can specify a filter_spec of none. This is useful if you need to override a global filter specification.

followlink attribute (boolean)

[+|-followlink]

Whether to resolve any symbolic links and include the target files or directories instead of the links.

If you specify +followlink (enable the attribute), whenever an item taken from the host filesystem is a symbolic link, mkqnx6fsimg follows the link and includes its target. If you omit the attribute, this is the default behavior.

If you specify -followlink (disable it):

• If a symbolic link is named explicitly in the buildfile and is a link to a directory, mkqnx6fsimg follows the link and recurses into the directory. For directory links included indirectly as part of an explicitly named parent directory, they will not be followed but included as symbolic links.
• If the symbolic link is a link to a file, mkqnx6fsimg includes the link itself in the image filesystem. It's up to you to include in the image whatever the link points to.

fsys_lfncks attribute (boolean)

+|-fsys_lfncks

This attribute determines whether checksums are calculated for long filenames in the Power-Safe filesystem. The default is true.

gid attribute

gid=id_spec

Set the group ID number for the file. The value of this attribute may be either a number or an asterisk (*). If it's an asterisk, the group ID is taken from the host file; for an inline file, the group ID is the group of the user running mkqnx6fsimg. The default value for this attribute is *.

include attribute (boolean)

+|-include

(QNX Neutrino 7.1 or later) Include files as part of the buildfile being processed. You can apply this attribute to a single file:

[+include] buildfile_path

or as a global attribute:

[+include]
buildfile_path_1
buildfile_path_2
...
buildfile_path_n
[-include]

You can specify variables in the attribute's value. For information on how they're expanded (i.e., evaluated to a value used in their place), see the mkxfs section on processing variables.

Each buildfile_path can be an absolute or a relative path. If buildfile_path starts with a slash (“/”) on a Linux or Mac development host, or a disk volume label followed by a backslash (“\”) on a Windows host, it's absolute and mkqnx6fsimg searches for the file in that exact host location. For more details on specifying absolute paths, see the buildfile path description above. If the path starts with another character sequence, it's a relative path, and mkqnx6fsimg searches the following directories (in this order):

• the current directory
• all paths specified by search attributes
• the boot/build directory under the current root (specified with the -r command-line option)
• the boot/build directory under ${QNX_TARGET}/${PROCESSOR}

Note that you can't use the target=host notation for the paths.

If an include file can't be found, the result depends on the optional attribute. If +optional is set, the missing file is skipped; otherwise, mkqnx6fsimg terminates with an error.

Buildfiles are processed top-down, and buildfile inclusion happens in place: when an include attribute is found, the included buildfile is loaded and processed; when processing is completed, mkqnx6fsimg returns to the including buildfile.

You can nest buildfile inclusions, but any circular inclusion is treated as an error. For example, the inclusion hierarchy A(B(D),C(E,F)) is valid, but A(A) and A(B(C(B))) aren't. If you include a buildfile more than once (which could easily happen with nested include files), the repeated inclusion is ignored, and mkqnx6fsimg issues a diagnostic message.

The default is -include, which causes files (if found) to be added to the filesystem, not to the buildfile.

max_sectors attribute

max_sectors=count

Set the maximum size of the storage medium, in sectors, that this filesystem supports. This attribute allows you to use the output filesystem image on media that are larger than what num_sectors specifies, either now or later in its lifetime.

You specify count using the following format:

absolute_value[:multiple_of] | *spare[%][:multiple_of]

where absolute_value, spare, and multiple_of are integers, optionally followed by K, M, or G.

If absolute_value is specified, it specifies the exact maximum number of sectors supported by the filesystem.

If the alternative value (indicated by a leading asterisk (*)), is used, then mkqnx6fsimg automatically determines the required number of sectors and adds spare extra sectors to the result. If spare is followed by %, then mkqnx6fsimg adds spare percent of the required sector count.

If multiple_of is specified, mkqnx6fsimg rounds up the maximum number of sectors to the next multiple of multiple_of that is an integer. This option allows you to align image sizes to disk cylinder sizes.

If you specify this attribute, mkqnx6fsimg creates an expandable filesystem. In this case, mkqnx6fsimg rounds up the specified maximum number of sectors to yield the maximum capacity. This capacity is the maximum number of sectors that the filesystem can support, which may be larger than what's specified by max_sectors. For information on expanding a filesystem to fit the partition it is installed on, see the chkqnx6fs -x option.

Also, mkqnx6fsimg calculates the bitmap file size based on the max_sectors setting. For information on the bitmap file, see the “Power-Safe filesystem” chapter in the QNX Neutrino System Architecture Guide.

mountperms attribute

This attribute is supposed to set the access permissions for the filesystem mountpoint. Since the Power-Safe filesystem has no provision to store mount information, this attribute is silently disregarded.

mtime attribute

mtime=time_spec

Set the timestamps of the files or directories to the specified time. The time_spec must be either:

• a single asterisk (*), meaning that the host file's timestamp should be used (the default behavior)

  or:

• in a format based on ISO8601:

  YYYY-MM-DD-HH:MM:SS
  

  You must provide all six elements. The time is always interpreted as UTC.

Timestamps specified with the mtime attribute aren't affected by the -n option.

name_enc attribute

+|-name_enc

Specify whether the file's name should be encrypted. If this attribute is set (+name_enc) for any file, then a filename encryption domain must have been specified using the namedom attribute (see below). The default is unset (-name_enc), meaning the name is unencrypted.

namedom attribute

namedom=nr

Specify which static domain should be used for name encryption. This attribute can be specified at most once per filesystem, and must be provided to use filename encryption (see name_enc).

The given nr must be the non-zero number of a static domain defined anywhere in the build file using the newdom attribute (see below). The default is no filename encryption.

newdom attribute

newdom=nr,key[,type[,hmac]]

Define a new static domain to be created. Here, nr is the domain number, key is the key used to lock/unlock the domain, type describes the cipher to use for encryption, and hmac defines a digest type to use for authentication.

num_blocks attribute

num_blocks=count

For a Power-Safe filesystem, you must use the following formula to determine the maximum number of blocks:

((num_bytes - 16384) rounded down to a multiple of 4096) / blksize

((num_bytes - (12288 + abs(blksize - 12288) + blksize) rounded down to a multiple of 4096) / blksize

The count argument is an integer, optionally followed by K, M, or G (the case doesn't matter). The default is 65532, which is the block count resulting from the above formula for the default number of sectors, using the default sector size and block size.

num_groups attribute

num_groups=count

Set the number of allocation groups in the Power-Safe filesystem. Valid values are in the range 1–64. QNX recommends that you do not set this attribute and instead let mkqnx6fsimg calculate a reasonable number of allocation groups. When mkqnx6fsimg calculates the value, it selects one in the range 4–64.

num_inodes attribute

num_inodes=count

Set the number of file metadata entries (inodes) in the filesystem. One individual inode is required for each file, directory, or symbolic link. This means that the inode count ultimately limits the number of files in the filesystem. You specify count using the following format:

absolute_value | *spare[%]

where absolute_value and spare are integers, optionally followed by K, M, or G.

If absolute_value is specified, it specifies the exact number of inodes in the resulting filesystem.

If the alternative value (indicated by a leading *) is used, mkqnx6fsimg automatically determines the required number of inodes and adds spare additional inodes to the result. If spare is followed by %, then mkqnx6fsimg adds spare percent of the required inode count.

For example, if a buildfile specifies a total of 1000 items (files, directories, and so on), then the total number of required inodes is 1002 (including / and /.boot). The following buildfile entry creates a filesystem with 1012 inodes (1002 + 10):

num_inodes=*10

Alternatively, the following entry creates a filesystem with 1102 inodes (1002 + 1002*10%):

num_inodes=*10%

The number of inodes determines the inodes file size. For information on the inodes file, see the “Power-Safe filesystem” chapter in the QNX Neutrino System Architecture Guide.

num_sectors attribute

num_sectors=count

Set the total number of sectors occupied by your image. This is the best way to ensure that your image will fit a specific target device.

You specify count using the following format:

absolute_value[:multiple_of] | *spare[%][:multiple_of]

where absolute_value, spare, and multiple_of are integers, optionally followed by K, M, or G.

If absolute_value is specified, it specifies the exact number of sectors in the resulting image.

If the alternative value (indicated by a leading asterisk (*)), is used, then mkqnx6fsimg automatically determines the number of sectors required and adds spare extra sectors to the result. If spare is followed by %, then mkqnx6fsimg adds spare percent of the required sector count.

If multiple_of is specified, mkqnx6fsimg rounds up the number of sectors to the next multiple of multiple_of that is an integer. This option allows you to align image sizes to disk cylinder sizes.

The default num_sectors value is 524288 (512k).

optional attribute (boolean)

+|-optional

If this attribute is enabled and the host file can't be found, output a warning and continue building the embedded filesystem. If it's disabled and the host file can't be found, output an error message and exit. The default setting is enabled.

This attribute applies only to those items explicitly included in the buildfile.

perms attribute

perms=perms_spec

Set the access permissions of the file, hard link, or symbolic link. The perms_spec can be one of the following:

• a number (just as with the chmod command)
• an asterisk (*) to use the host file's permissions (or 0666 for inline files)
• a symbolic mode string to delete, add, or set permissions. This string is similar (but not identical) to chmod's and is as follows (with spaces added for clarity):

  [who] operator permissions[, ...]

  The components are as follows:

  who

  A combination of zero or more of the following:

  Character	Meaning
  u	User
  g	Group
  o	Others
  a	All (the default if you don't specify who)

  operator

  One of the following:

  Character	Meaning
  -	Delete the specified permissions
  =	Explicitly set the permissions
  +	Add the specified permissions

  permissions

  A combination of one or more of the following:

  Character	Meaning
  r	Read permission
  w	Write permission
  x	Execute permission, or search permission for directories
  s	When executed, set the user ID
  g	When executed, set the group ID
  t	Sticky bit

  You can include multiple symbolic mode strings, separating them with commas (,).

The default perms_spec is *.

prefix attribute

prefix=path

Set the prefix on the target file names. The default is the empty string.

You can specify variables in the attribute's value. For information on how they're expanded (i.e., evaluated to a value used in their place), see the mkxfs section on processing variables.

In the prefix path, you can use forward slashes (/) as directory delimiters, even on Windows. It is strongly recommended to do so, because backslashes may adversely affect the functionality of your buildfile.

reserve attribute

reserve=number

Set the percentage of filesystem blocks to reserve for reclaim, as an integer in the range [0, 99]. The default value is 3.

search attribute

search=path[:path...]

This attribute specifies that mkqnx6fsimg should search for the file in the named path locations on the host system. The search directory portion of the host file name isn't included in the name that's stored in the Power-Safe filesystem. The default setting is empty, meaning only the current working directory will be searched for the host files. To make mkqnx6fsimg include the directories named in the MKIFS_PATH variable in the host locations that it searches, see the -r rootdir explanation above.

You can specify variables in the attribute's value. For information on how they're expanded (i.e., evaluated to a value used in their place), see the mkxfs section on processing variables.

sector_size attribute

sector_size=size_spec

Specify the sector size of the filesystem's target device. The size_spec argument is an integer. Valid values are 512 and 4096 (or 4k or 4K); the default is 512.

sha256 attribute

sha256=hex_string

Specify the expected SHA256 hash of the file that the attribute applies to. If you specify this attribute, mkqnx6fsimg calculates the SHA256 hash of the host file imported into the image and compares it to the expected value; if a mismatch is detected, the program terminates with an error. You must specify the expected hash as a string of 64 hexadecimal digits, without a prefix or any delimiters. For example, instead of specifying 0xaa,0xbb,0xcc,..., specify aabbcc....

type attribute

type=file_type

Sets the type of the files being created in the Power-Safe filesystem. Allowable types are:

• hlink—a hard link (see below)
• link—a symbolic link
  Note: Symbolic links in the target filesystem are not resolved by mkqnx6fsimg and must not be used in the pathnames of other buildfile items. For an example, see the note in the mkifs type attribute.
• file—a regular, everyday file (the default)
• dir—a directory

[type=dir]/usr/bin=/usr/nto/x86_64/bin

/usr/bin=/usr/nto/x86_64/bin

You must always specify hard links using commands of the form:

[type=hlink] link-path=target-path

where link-path is the new link to create and target-path is an existing path in the Power-Safe filesystem being created. You can't specify attributes such as uid, gid, or permissions for hard links. If you define any of these attributes together with the [type=hlink] attribute, they're silently ignored.

uid attribute

uid=id_spec

Set the user ID number for the file. The value of this attribute may be either a number or an asterisk (*). If it's an asterisk, the user ID is taken from the host file; for an inline file, the user ID is the user running mkqnx6fsimg. The default value for this attribute is *.

usage attribute

usage=usage

Give a hint about the expected predominant usage of the Power-Safe filesystem. This hint will affect default values chosen for blksize, num_blocks, num_groups, and num_inodes. Valid values are:

• d or desktop
• m or media
• r or runtime

There is no default.

uuid attribute

uuid=uuid

Use this attribute to provide an explicit universally-unique identifier (UUID) for the Power-Safe filesystem. The UUID string must be in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, where X is a hexadecimal digit. The default is to use an IPv4/random-number-based UUID. Note that when you set the UUID, you must not provide a volume name.

vol_name attribute

vol_name=string

Set the volume name to the given string. The maximum volume label length is 16 characters. Note that when you specify a volume name, you must not provide a UUID. The default is to use the UUID.

Patch files

Patch files let you override the user ID, group ID, and permissions of certain files, depending on their location and filename pattern. Patches are applied after all files have been collected (from the buildfile and/or the specified directory). Consequently, patch files can override settings specified in the buildfile.

Patch files must contain only lines of the form:

#comment

or:

type:path:pattern:uid:gid:perms

In comment lines, # must be the very first character. The entire line is regarded as a comment and is ignored.

The type is either d or f, optionally followed by r. Type d patches are applied only to directories, and type f patches are applied only to files. An r indicates that the patch should be applied recursively within path; without r, the patch is applied to path only.

The pattern is a filename pattern that specifies which files to apply the patch to. The uid and gid must be decimal numbers, while perms must be an octal number (see chmod). Note that it isn't possible to set only the user ID, group ID, or permissions; for each match, all three are affected.

Examples:

Here's a sample buildfile, my_qnx6fs.bld:

# A sample buildfile for mkqnx6fsimg
[num_sectors=256k]
/home/thaupt

In this example, we've specified a sector count of 256k (i.e., 256*1024). With the default sector size of 512 bytes, this results in an image size of 128 MB. The files and subdirectories from the /home/thaupt directory on the host system are to be recursively copied into the root directory of the Power-Safe filesystem. To create a Power-Safe filesystem image file using above buildfile, invoke mkqnx6fsimg as follows:

mkqnx6fsimg my_qnx6fs.bld my_qnx6fs.img

This creates the my_qnx6fs.img file containing the Power-Safe filesystem, which you could then copy to a target system's hard-disk partition as follows:

dd if=my_qnx6fs.img of=/dev/hd0t179 count=262144

Environment variables:

PFS

Specifies the Path Field Separator (PFS). The mkqnx6fsimg utility automatically sets this variable to the character used to separate paths in path lists. That is, mkqnx6fsimg sets the variable to “;” on a Windows host and to “:” on a Linux or macOS host.

To keep buildfiles host OS-independent, use this environment variable instead of the OS-specific characters; for example, instead of writing:

[search=/a/b:/x/y/z]

write:

[search=/a/b${PFS}/x/y/z]

The mkqnx6fsimg utility will set the environment variable to the path separator appropriate for the host platform.

Exit status:

0

Successful completion.

1

An error occurred.