| Options | |||
|---|---|---|---|
| Option | Param | Description | |
| -T | --titles | file | Read file for disc titles. |
| --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 for WBFS partitions using '/proc/partitions' or searching hard disks in '/dev/'. | |
| -A | --all | Use all WBFS partitions found. | |
| -p | --part | part | Define a primary WBFS file or partition. Multiple usage possible. |
| --no-check | Disable automatic check of WBFS before modifications. | ||
| --wbfs-alloc | mode | Select one WBFS block allocation modus:
|
|
| --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 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. |
| -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. |
| -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 |
||
| -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 |
|
| -i | --ignore | Ignore non existing files/discs without warning. If set twice then all non Wii and GameCube ISO images are ignored too. | |
| --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 |
||
| --links | Detect soft and hard linked source files while composing or extracting discs and try to create hard links instead of independent copies on the destination file system. | ||
| -q | --quiet | Be quiet and print only error messages. | |
| -v | --verbose | Show a runtime summary for each job. If set twice enable progress information. If set three times the progress information is more detailed. | |
| -P | --progress | Print progress counter. If --verbose is set at least twice, printing is enabled too. If progress is enabled, the default of --dsync is changed. | |
| --scan-progress | Print a message for each found image while scanning the file system. | ||
| --sections | Print in machine readable sections and parameter lines. | ||
| -L | --logging | This debug option enables the logging of internal memory maps. If set twice second level memory maps are printed too. | |
| -t | --test | Run in test mode, modify nothing. >>> USE THIS OPTION IF UNSURE! <<< |
|
| --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
All keywords can be prefixed by |
|
| --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 |
|
| --common-key | index | This patching option defines the common key index as part of the TICKET. Keywords |
|
| --ios | ios | This patching option defines the system version (IOS to load) within TMD. The format is |
|
| --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. | ||
| --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: |
|
| --raw | Abbreviation of »--psel RAW«. | ||
| -R | --remove | Remove source files/discs if operation is successful. If the source is an extracted file systems (FST) it isn't removed. | |
| --trunc | Truncate WBFS until operation finished. | ||
| -e | --newer | If source and destination have valid mtimes: Copy only if source is newer. | |
| --sync-all | Synchronize the destination with all sources like --sync. But use the include and exclude lists only to create the sync list and remove all disc on the destination WBFS that are not part of the sync list. | ||
| -y | --sync | Synchronize the destination with all sources: Remove and copy discs until the destination WBFS contains exactly the same discs as all sources together. Remove and add only discs in respect to the include and exclude lists. | |
| -u | --update | Copy only non existing discs. | |
| -o | --overwrite | Overwrite already existing discs. | |