wit mix

1.   Syntax

wit MIX SOURCE... --dest|--DEST outfile
  where SOURCE    = infile [QUALIFIER]...
  where QUALIFIER = 'select' part_type
		  | 'as' [part_table '.'] [part_type]
		  | 'ignore' ruleset
		  | 'header'
		  | 'region'

2.   Options

3.   Description

To copy 2 or more DATA partitions together just type:
»wit MIX image1 image2 image3 --dest result.iso«

The output format can be selected by option or filename. See »Writing an image« for details.

To view what command MIX would to without creating a image use the option --test.

Use the option --id the set the disc id. The default id is WIT000. Use the option --name the set the disc name. The default disc name is a generic name that contains the IDs of all source images. See »Qualifier header« for additional information.

Use the option --region the set the disc region. The default region is generated from the ID. See »Qualifier region« for additional information.

wit MIX warns the user if the filename do not contain a slash ('/') or a point ('.'). This is because words without slash and points are reserved for qualifiers. In the moment 3 qualifiers are supported: 'select', 'psel' and 'as'.

The order of the following qualifiers does not care.

4.   Qualifier 'select' or 'psel'

Snytax: select mode
    or: psel   mode

If the parameter list should start with a minus sign ('-'), prefix it with a comma to prevent the detection as an option.

A later 'select' overrides the previous ones. The default is to select only DATA (type=0) partitions.

Examples

»wit MIX image1 select ,-upd image2 --dest outimage.iso«
This command mix all non UPDATE partitions of image1 and the DATA partition of image2. The leading comma of the select parameter prevents the detection as an option. The output is written to the PLAIN ISO file outimage.iso.

5.   Qualifier 'as'

Snytax: as ptab.
    or: as ptype
    or: as ptab.ptype

Without the qualifier 'as' a source partition ist stored in the same partition table and with the same partition type as the source. In other words: An UPDATE partition placed in partition table #2 is stored as UPDATE partition in partition table #2 again. The qualifer 'as' can override this default setting. A later 'as' overrides the previous ones.

Examples

»wit mix image1 select udpate as data --dest outimage.ciso«
This command will get the UPDATE partition of image1 and stores it as DATA partition. The output is written to the CISO file outimage.ciso.

6.   Qualifier 'ignore'

Snytax: ignore ruleset

'ignore' is a keyword in any case. ruleset is a list of rules described in »File Filters«. The qualifier works in the same way as the option --ignore-files. Each appearence of 'ignore' append more rules to the internal rule list.

When copying in scrubbing mode the system checks which sectors are used by a file. Each system and real file of the FST ('sys/...' and 'files/...') of the first DATA partition, that matches the rule set, is ignored for this sector search.

This means that the partition becomes invalid, because the content of some files is not copied. If such file is accessed the Wii will halt immediately, because the verification of the checksum calculation fails.

The advantage is to reduce the size of the image without a need to fake sign the partition. Use this qualifier in combination with option --overlay to create tricky combinations of partitions. It may help to reduce the size of the output image dramatically.

Examples

»wit mix image1 ignore "@ignorefile" --dest outimage.wdf«
Copy the DATA partition of image1 to the WDF file outimage.wdf and read file ignorefile for ignore rules.

Use the command »wit dump image1 --show usage --ignore-files ruleset« to test the scrubbing result of the ignore qualifier.

7.   Qualifier 'header'

Snytax: header

'header' is a keyword in any case. This qualifier can only used once. Multiple usage results in an error.

If set the disc header (first 256 bytes of the dics) are copyied from the related source image to the destination image. The automatic creation of ID and disc title is disabled. The patching options --id and --name can still override the ID and/or the disc title.

8.   Qualifier 'region'

Snytax: region

'region' is a keyword in any case. This qualifier can only used once. Multiple usage results in an error.

If set the region info (32 bytes at disc offset 0x4e000) are copyied from the related source image to the destination image. The automatic creation of the region info is disabled. The patching option --region can still override the region.

9.   --overlay

When mixing partitions, the source partitions are stored one behind the other and the total size of the output image becomes very large and exceeds sometimes the maximum allowed size.

The idea: Use the hole of one partition to store data of the other partitions. Option --overlay enabled this method.

There are two overlay alogithm implemented:

1. The first algorithm works only for two partitions. All holes of both partitions are used to find the optimal overlay. Both partitions are shifted until the smallest total image size is found.
2. The second algorithm works with any number of partitions. It find out the largest hole of each partition. Then it try will try all permutations of all source partitions to find the order with the smallest total image size.

   There are N! (=1*2*3*...*N) permutations for N source partitions. For 5 partitions there are 120 permutations and for 10 partitions there are 3 628 800 permutations. Because this large number of permutations the number of input partitions is limited to 12.

To view the effect of the --overlay option without creating a image use the option --test. If set twice an usage map is printed too.

Command reference

10.   Verification

With verbose level (--verbose) >=3 or test level (--test) >=2 an usage map is printed too.

11.   Usual error/exit codes:

0 == OK        : all done without errors.
WARNING        : a filename without '/' or '.' was used.
SYNTAX ERROR   : at least one syntax error in command line found.
SEMANTIC       : error in number of selected partitions.
READ ERROR     : error while reading a file.
WRITE ERROR    : error while writing a file.
CANT CREATE    : Can't create output file. (WBFS output is not supported)
INTERNAL ERROR : Internal verification test failed.