prevnext   » WIT: Wiimms ISO Tools » wit: Wiimms ISO Tool » wit dump

wit dump

Dump the data structure and content of Wii and GameCube ISO files, cert.bin, ticket.bin, tmd.bin, header.bin, boot.bin, fst.bin and of DOL-files. The file type is detected automatically by analyzing the content.

Contents

1.   Syntax

wit DUMP [source]...

2.   Options

Options
Option Param Description
-T --titles file Read file for disc titles. -T/ disables automatic search for title files.
--utf-8 Enables UTF-8 support for filenames (default).
--no-utf-8 Disables UTF-8 support for filenames.
--lang lang Define the language for titles.
-a --auto Search WBFS partitions using '/proc/partitions' or searching hard disks in '/dev/' and use all readable as source. This works like »wwt --auto --all«.
-s --source path Use the entered file or directory as source.

If parameter PATH contains at least one wildcard (e.g. '*.wbfs'), then PATH is used as search pattern and all found files are added. In order to use this variant, the calling shell must not interpret the wildcards. Therefore, the parameter must usually be enclosed in single or double quotes.

Directories are expanded to all containing files but hidden files (file names begins with a point) are ignored. If a command needs only images then non image files of the directory are ignored without notification. The option --no-expand suppress the directory expansion.

--no-expand Do not expand directories to the containing files or images. This option does not change the behavior of --recurse.
-r --recurse path If path is not a directory, then it is used as a simple source file like --source.

If parameter PATH contains at least one wildcard (e.g. '*.wbfs'), then PATH is used as search pattern and all found files are added. In order to use this variant, the calling shell must not interpret the wildcards. Therefore, the parameter must usually be enclosed in single or double quotes.

Directories are scanned for source files recursively. The option --rdepth limits the search depth. Hidden files and hidden sub directories (file names begins with a point) and files with non supported file types (non ISO files for most commands) are ignored without notification.

--rdepth depth Set the maximum recurse depth for option --recurse. The default search depth is 10.
-x --exclude id A comma separated list with ID4 and ID6 values is expected. '.' is a wildcard for exact 1 character and '+' is a wildcard for any number characters. If the parameter begins with a '@' the given file is read and each line is scanned for one ID. Images with the given ID are excluded from operation. Each use of this option expands the exclude list. See --include-first for precedence issues.
-X --exclude-path file_or_dir Scan the ID of the source and add it to the exclude list. If the source is a directory then scan all images of the directory. Images with the given ID are excluded from operation. Each use of this option expands the exclude list. See --include-first for precedence issues.
-n --include id A comma separated list with ID values is expected. '.' is a wildcard for exact 1 character and '+' is a wildcard for any number characters. If the parameter begins with a '@' the given file is read and each line is scanned for one ID. Only images with the given ID are included into the operation. Each use of this option expands the include list. See --include-first for precedence issues.
-N --include-path file_or_dir Scan the ID of the source and add it to the include list. If the source is a directory then scan all images of the directory. Only images with the given ID are included into the operation. Each use of this option expands the include list. See --include-first for precedence issues.
--include-first The options --include, --include-path, --exclude and --exclude-path decide which discs are included into the operation. If neither include nor exclude options are used, than all disc are included into the operation. If only include options are used, than only the specified discs are operated. If only exclude options are used, than all all discs but not the excluded are operated.

If include and exclude options are used together and --include-first is not set, than all discs are operated that are specified by any include option and not by any exclude option. If --include-first is set, than all discs are ignored that are specified by any exclude option and not by any include option.

-1 --one-job Execute only the first job and exit. This is a shortcut for »--job-limit 1«.
--job-limit num Execute only the first 'num' jobs and exit. If done without errors the exit status is OK (zero).
--ignore-fst Disable composing and ignore FST directories as input. This legacy option is a shortcut for --allow-fst=off.
--ignore-setup While composing ignore the file 'setup.txt', which defines some partition parameters.
--psel list This option set the scrubbing mode and defines, which disc partitions are handled. It expects a comma separated list of keywords, numbers and names; all together called parameter. All parameters are case insensitive and non ambiguous abbreviations of keywords are allowed.

Each parameter becomes a rule and each rule is appended to a rule list. Rules prefixed by a minus sign are DENY rules. Rules prefixed by a plus sign or without a prefix are ALLOW rules. Each partition is compared with each rule until a rule matches the partition. If a match it found, the partition is enabled for a ALLOW rule or disabled for a DENY rule.

The allowed keywords are: DATA, UPDATE, CHANNEL, PTAB0 .. PTAB3, ID, ALL, WHOLE and RAW. The following input formats are accepted too: ptype, #index, #<index, #<=index, #>index, #>=index and #tab_index.part_index.

--raw Abbreviation of »--psel RAW«.
--pmode p-mode This options set the prefix mode for listed or extracted files. One of the following values is allowed: AUTO, NONE, POINT, ID, NAME, INDEX, COMBI. The default value is 'AUTO'.
--flat While extracting a disc image strip all path names of the source file and store all files in the same directory. This option sets the default for --pmode to NONE.
-F --files ruleset Append file select rules. This option can be used multiple times to extend the rule list. Rules beginning with a '+' or a '-' are allow or deny rules rules. Rules beginning with a ':' are macros for predefined rule sets.
--copy-gc If extracting a GameCube disc image, don't extract the real files to '/files/...'. Instead create a copy of the source image and store it as 'game.iso'. If the source image is already in this format, try to create a hard link and copy only if it fails.
--neek Abbreviation of »--psel data --pmode none --files :neek --copy-gc«. The old name --sneek is accepted too.
-L --logging This debug option enables the logging of internal memory maps. If set twice second level memory maps are printed too.
-l --long Images: If set at least once a memory map for each partition is printed. If set twice or more a memory map for whole ISO image is printed.

DOL files: If set, a third table with delta values between the virtual address and the file offset is printed.

-+ --show list This option allows fine control over the things that are to be printed. The parameter is a comma separated list of the following keywords, case is ignored: NONE, INTRO, HEADER, SLOTS, GEOMETRY, D-ID, P-ID, P-TAB, P-INFO, P-MAP, D-MAP, W-MAP, TICKET, TMD, USAGE, PATCH, RELOCATE, FILES, UNUSED, OFFSET, SIZE, PATH and ALL. There are some combined keys: ID := D-ID,P-ID, PART := P-INFO,P-ID,P-MAP,TICKET,TMD, DISC := FILES,D-ID,D-MAP, MAP := P-MAP,D-MAP,W-MAP.

All keywords can be prefixed by '+' to enable that option, by a '-' to disable it or by a '=' to enable that option and disable all others.

The additional keywords DEC and HEX can be used to set a prefered number format. -HEADER suppresses the output of header lines.

The commands recognize only some of these keywords and ignore the others. If --show is set, option --long is ignored for selecting output elements.

--enc encoding Define the encoding mode. The mode is one of NONE, HASHONLY, DECRYPT, ENCRYPT, SIGN or AUTO. The case of the keywords is ignored. The default mode is 'AUTO'.
--modify list This patching option defines the impact of the options --name and --id. It expects a comma separated list of the following keywords (case ignored) as parameter: NONE, DISC, BOOT, TICKET, TMD, WBFS, TT, ALL and AUTO (default).

All keywords can be prefixed by '+' to enable that option, by a '-' to disable it or by a '=' to enable that option and disable all others.

--name name This patching option changes the name (disc title) of the disc to the given parameter. Up to 63 characters are expected. The disc header and boot.bin are objects to modify. The option --modify selects the objects.
--id id This patching option changes the ID of the disc to the given parameter. 1 to 6 characters are expected. Only defined characters not equal '.' are modified. The plus sign '+' is a wildcard for multiple '.' to fill the complete entered ID to 6 characters. The disc header, boot.bin, ticket.bin and tmd.bin are objects to modify. The option --modify selects the objects.
--disc-id id This patching option changes the ID of the disc header to the given parameter. 1 to 6 characters are expected. Only defined characters not equal '.' are modified. The plus sign '+' is a wildcard for multiple '.' to fill the complete entered ID to 6 characters. Option --disc-id overrides the definition of option --id.
--boot-id id This patching option changes the ID of boot.bin to the given parameter. 1 to 6 characters are expected. Only defined characters not equal '.' are modified. The plus sign '+' is a wildcard for multiple '.' to fill the complete entered ID to 6 characters. Option --boot-id overrides the definition of option --id.
--ticket-id id This patching option changes the ID of ticket.bin to the given parameter. 1 to 4 characters are expected. Only defined characters not equal '.' are modified. The plus sign '+' is a wildcard for multiple '.' to fill the complete entered ID to 4 characters. Option --ticket-id overrides the definition of option --id.
--tmd-id id This patching option changes the ID of tmd.bin to the given parameter. 1 to 4 characters are expected. Only defined characters not equal '.' are modified. The plus sign '+' is a wildcard for multiple '.' to fill the complete entered ID to 4 characters. Option --tmd-id overrides the definition of option --id.
--tt-id id This is a short cut for »--ticket id --tmd id«. If TICKET and TMD differ, the game will freeze after loading. So it makes only sense to change TICKET and TMD IDs together.
--wbfs-id id This patching option changes the ID of the WBFS header to the given parameter if adding a file to a WBFS or if creating a WBFS file. 1 to 6 characters are expected. The already patched disc ID of the source is used as base and only defined characters not equal '.' are modified. The plus sign '+' is a wildcard for multiple '.' to fill the complete entered ID to 6 characters. Option --wbfs-id overrides the definition of option --id.
--region region This patching option defines the region of the disc. The region is one of JAPAN, USA, EUROPE, KOREA, FILE or AUTO (default). The case of the keywords is ignored. Unsigned numbers are also accepted.
--common-key index This patching option defines the common key index as part of the TICKET. Keywords 0, STANDARD, 1 and KOREAN are accepted.
--ios ios This patching option defines the system version (IOS to load) within TMD. The format is 'HIGH:LOW' or 'HIGH-LOW' or 'LOW'. If only LOW is set than HIGH is assumed as 1 (standard IOS).
--http This patching option replaces 'https' request to 'http' in the files 'main.dol' and 'rel/StaticR.rel', if the files exist. It also replaces the sub-domain 'naswii' to 'nas'.
--domain domain This patching option replaces the domain 'nintendowifi.net' by the new domain. The length of the new domain must not be larger than the old length (16 characters).

If the new domain length is not larger than 11, then 'gamespy.com' of 'sake.gamespy.com' is replaced too. This is a special support for 'Super Smash Bros. Brawl'.

--security-fix Try to fix a security bug in the game. This is game dependent.
--wiimmfi Patch the images for Wiimmfi, the new custom server. It is a short cut for »--http --domain wiimmfi.de --security-fix«.
--rm-files ruleset This patching option defines filter rules to remove real files and directories from the FST of the DATA partition. Fake signing of the TMD is necessary. The processing order of file options is: »--rm-files --zero-files --ignore-files«.
--zero-files ruleset This patching option defines filter rules to zero (set size to zero) real files of the FST of the DATA partition. Fake signing of the TMD is necessary. The processing order of file options is: »--rm-files --zero-files --ignore-files«.
--ignore-files ruleset This option defines filter rules to ignore real files of the FST of the DATA partition. Fake signing is not necessary, but 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 processing order of file options is: »--rm-files --zero-files --ignore-files«.
--align-part size If creating or moving partitions the beginning of each partition is set to an offset that is a multiple of the align size. Size must be a power of 2 and at least 32 KiB (=default).
--align-files If creating a partition the file 'align-files.txt' is read. Files listed with values >=0x8000 (Wii sector size) are automatically aligned to 0x8000.
--disc-size size Define a minimal (virtual) ISO disc size.

3.   Description

Command DUMP is an universial info dumper. It scans each source and then dumps file format related information.

The folowing file formats are supported: