Example, where
VERSION | Print program name and version and exit. | |
HELP | H | Print help for commands and options. |
ARGTEST | This debug command accepts all kinds of parameters and prints one line for each parameter. | |
TEST | This debugging command accepts all options and parameters and prints a list of the internal option values. The command is designed to test the option parameters. The non option parameters are completly ignored. | |
COLORS | Ignore all parameters and print clored text for testing. | |
ERROR | ERR | Translate an exit code to a message name. If no exit code is entered, print a table with all error messages. |
FILETYPE | FT | Scan the header of the entered files and print file type and path for each file as list. |
FILEATTRIB | FA | Print a table with attributes for all known file types. If at least one keyword is entered, only matching file types are printed. A keyword is either a file type (like 'BRRES' or 'BMG') or one of the printed keywords (like 'ARCHIVE' or 'EXTRACT'). |
POINTS | PTS | Print a table with the points assigned to player after a versus or room race. |
LIST | LS | List a message file to proof the content. Patches are applied before listing. The lines are cut to fit the terminal width. |
DIFF | CMP | Compare two or more BMG (raw or text) files on string level and report mismatches for each string. If option --dest is set, than each source file is compared with a file in the destination. Patches are applied to all sources before comparing. |
CAT | Read the entered BMG files (text, binary or szs sub file) and print them as decoded text files to standard output. All BMG files of an archive (SZS,...) are concatenated to 1 source. The output of all source files is concatenated. | |
MIX | Read the entered BMG files (text, binary or szs sub file) and print them as decoded text files to standard output. All BMG files of every archives (SZS,...) are read. The output of all source files is combined and strings of later source files override prior defined strings. | |
DECODE | DEC | Read the entered message files and decode them to text files. All BMG files of an archive (SZS,...) are concatenated to 1 source. This command is similar to PATCH, but the result is always decoded. The default destination is |
ENCODE | ENC | Read the entered message files and encode them to BMG files. All BMG files of an archive (SZS,...) are concatenated to 1 source. This command is similar to PATCH, but the result is always encoded. The default destination is |
PATCH | PAT | Patch the entered files by using the patch list specified by option --patch-bmg. The coding of the source files is not changed. The default destination is Use »wszst patch --patch-bmg ...« to patch BMG files within a SZS file. |
Options | |||
---|---|---|---|
Option | Param | Description | |
--align | size | Define an align value for the sub sections in the archive. The value must be a power of 2 and the default value is 32 (0x20) | |
--allow-all | Usually commands accept only options with impact to the command. All other options fire a syntax error. But if This makes changing the command of a long command line without removing useless options easier. It also helps to override wrong option permissions. |
||
-A | --arenas | arenas | Define a new arena order. A comma separated list in the format
Arenas will only be exchanged so that always all arenas are assigned. But if using |
-B | --brief | If set, the information header in decoded text files is suppressed (for historical reasons same as --no-header). If set at least twice, all comments are suppressed and the output is packed without empty lines. If set 3 times, the |
|
--chdir | dir | Set a new working directory for all following options, for all parameters and for the command execution. This option can be used multiple times, but for parameter parsing and for command execution only the last usage is relevant. Nevertheless, |
|
--color | Force colorized text. This is the default, if an output file is a terminal. But colorized text is only supported for a few messages. | ||
-c | --const | list | Define constant values, that are used by the internal encoders and by the numeric options as predefined global variables. This option allows a conditional encoding of text files. It can be used multiple times for multiple definitions.
The Parameter is a comma separated list of terms and a term is ' |
--ct-code | Enable the CT-CODE modus. | ||
--de | Use german track and arena names. | ||
-d | --dest | path | Define a destination path (directory/file). The destination
The path may contain escape sequences:
A |
-D | --DEST | path | Like --dest, but create the directory path automatically. |
-E | --esc | char | Define an alternative escape character for destination files. The default is '%'. For Windows batch files it is a good choice to set |
-X | --export | Enable the export modus and create small and machine readable text files for easy post processing. The option works similar like |
|
--force | The tools analyse input files and reject files with invalid data structures. If --force is set, little repairable issues are ignored and a warning is printed.
Option »--kmp force« does the same, but only for KMP files. >>> THE RESULT MAY BE INVALID OUTPUT FILES! <<< |
||
-h | --help | Stop parsing the command line, print a help message and exit. | |
-i | --ignore | Ignore non existing source files without warning. | |
-l | --long | Print long numeric message IDs instead of alternative message names like Txx, Uxx or Mxx. | |
-M | --max-file-size | size | This security option defines the maximum file size for input files; larger files are ignored with a warning. The default unit is MiB and the default size is 25 MiB; that should be enough for standard usage. |
--msg | list | If this option is set, the BMG messages are filtered by this list. Only enabled messages are exported to the ouput BMG file (binary or text).
The parameter is a list of message ids (short MID, 'Txx' or 'Uxx' or Mxx' or hex number) or message ranges (MID:MID) or one of the keywords NONE, PARAM, CUPS, TRACKS, ARENAS, CHAT, CTCODE, CTTRACKS or |
|
--no-bmg-color | If set, suppress the output of '\c{color}}' escape sequences for colors definitions in BMG text output to be compatible with old versions of the tools. | ||
--no-color | Deactive colorized text. This is the default, if an output file is not a terminal. | ||
-H | --no-header | Suppress the syntax information section in BMG text files. | |
--number | If a file already exist, append a number directly before the file extension to make the filename unique. If other numbered files already exist (ignoring case), use the maximal existing index+1. |
||
-o | --overwrite | Overwrite already existing files without warning and ignore option --number. | |
-P | --patch-bmg | mode[=param] | This option specifies a BMG patch mode. Some of the modes need parameter or a file name of a BMG patch file (raw or text BMG), both separated by an equal sign. Modes with required file names are PRINT, REPLACE, INSERT, OVERWRITE, DELETE, MASK, EQUAL and
If this option is used multiple times, all patch files will be processed in the entered order. |
--points | list | This option creates the new message 3FF0 to hold a description of the versus points table. It defines a new table for the points assigned to players after a versus or room race. The parameter is a blank or comma and slash (next row) separated list with numbers (points) between 0 and 255 and the following keywords: |
|
-p | --preserve | Preserve file times (atime+mtime) while converting or copying files. | |
-q | --quiet | Be quiet and print only error messages. Multiple usage is possible. The impact is command dependent. | |
-r | --remove-dest | Remove already existing files before creating it. If set, --overwrite is ignored. |
|
--sections | Print in machine readable sections and parameter lines. | ||
-1 | --single-line | If set, don't print continuation lines for BMG text output. If set twice, print only single text lines but not value lines. | |
-t | --test | Run in test mode, modify nothing.
>>> USE THIS OPTION IF UNSURE! <<< |
|
-T | --tracks | tracks | Define a new track order. A comma separated list in the format
Tracks will only be exchanged so that always all tracks are assigned. But if using |
-u | --update | Create only files that do not exist. Already existing files are ignored without warning. If set, --overwrite and --remove-dest are ignored. | |
-v | --verbose | Be verbose and print more progress information. Multiple usage is possible. The impact is command dependent. | |
-V | --version | Stop parsing the command line, print a version info and exit. | |
--width | width | Define the width (number of columns) for help and some other messages and disable the automatic detection of the terminal width. | |
--xhelp | Stop parsing the command line and print a help message with all commands included. Exit after printing. |