|VERSION||V||Print program name and version and exit.|
|HELP||H||Print help for commands and options.|
|CONFIG||Show all information about the search for the configuration file and its content.|
|ARGTEST||This debug command accepts all kinds of parameters and prints one line for each parameter. All tools know the ARGTEST command.|
|EXPAND||This debug command accepts (like ARGTEST) all kinds of parameters and prints one line for each parameter. After that, the parameter is treated as a filename with wildcards and all matching files are searched. The special parameters '+h' and '_h' enable or disable the search for hidden directories and files (files beginning with a point) for the following parameters. All tools know the EXPAND command.|
|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 completely ignored.|
|COLORS||Ignore all parameters and print colored 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. All tools know the ERROR command.|
|FILETYPE||FT||Scan the header of the entered files and print file type and path for each file as list. All tools know the FILETYPE command.|
|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'). All tools know the FILEATTRIB command.|
|LIST||LS||List images files and print file and image type.|
|LIST-L||LL||List images files and print file and image type and geometry data. 'LIST-L' is a short cut for »LIST --long«.|
|LIST-LL||LLL||List images files and print file and image type and advanced geometry data. 'LIST-LL' is a short cut for »LIST --long --long«.|
|DECODE||DEC||Decode (export) the entered image files into PNG files. The default destination is
|ENCODE||ENC||Encode (import) the entered PNG files and convert them to to an internal image format (TPL, TEX, BREFT). The default destination is
|CONVERT||CV||Convert the entered image files into new file and image formats. The old file is replaced by the new one. The difference to ENCODE is only the default file name handling. If SOURCE starts with colon (
|COPY||CP||Copy and convert an image from 'source' to 'dest'. Multiple sources can be used, if 'dest' is a directory or contains at least one %-pattern.
This is an alternative for the ENCODE and DECODE commands. The default destination file format is selected by scanning the file extension of the destination. Option --transform may override this. Option --overwrite is set implicitly.
If SOURCE starts with colon (
|-a||--all||Convert all files and not only the files with changed file or image formats.|
|--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.
|-B||--brief||Create smaller output.|
|--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,
|--cmpr-default||rgb1[,rgb2]||Define 2 colors for the case, that all 16 pixels of a CMPR block are transparent. The default is to calculate an average color of all transparent pixels. Before v2.04 white was used.
2 RGB values (hex values with 6 digits each) are expected as parameter. If optional
Use parameter '
|--colors||[=modus]||Define the modus for colored text output. Allowed keywords are:
If a command is prefixed by
|--compatible||vers||The option expects a version number (format
|--config||file||Define a configuration file or a directory as source. In later case, file
If option is not not set, then file
|-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 CT-CODE support.|
|--de||Use german track and arena names.|
|-d||--dest||path||Define a destination path (directory/file). The destination
The path may contain escape sequences:
|-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
|-Y||--extended-errors||Enable extended error messages. This includes a source file and line reference. Logging level 1 activates it too.
|--fast-mipmaps||If resizing an image, use the old fast resize algorithm (default until v1.64a) instead of the new smart one. Both algorithms differ only, when creating a mipmap for images with odd width or odd height. The old algorithm is faster (factor 2-4) than the default algorithm, but the new algorithm creates better resized images.
|--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.|
|--le-code||[=param]||Enable LE-CODE and CT-CODE support. The optional parameter is deprecated and ignored.|
|-L||--logging||This debug option enables the logging of internal lists and maps. Set it up to three times to be more verbose.|
|-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 100 MiB; that should be enough for standard usage.|
|--max-mipmaps||num||Control the automatic mipmap creation. Values between 0 and 20 are allowed and the default is 4. The mipmap creation for an image stops, if the set number is reached. This option is ignored, if
|--max-width||maxwidth||Define the maximum terminal width (number of columns) for help and some other messages. The default is 120. This option is ignored if --width is set.|
|--mipmap-size||num||Define the minimal width and minimal height of a generated mipmap. Any value >0 is allowed. The default is 8. This option is ignored, if
|--mipmaps||If reading a source, scan for mipmaps and load them too. For PNG files, files named
|--n-mipmaps||num||Force the number of mipmaps. Values between 0 and 20 are allowed. Value
|--no-colors||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.|
|--no-mipmaps||If reading a source, ignore mipmaps. This disables not the creation of mipmaps (see -n-mipmaps).
|--no-pager||Forbid the internal usage of a pager.|
|--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 maximum existing index+1.
|-o||--overwrite||Overwrite already existing files without warning and ignore option --number.|
|-P||--patch||mode1.mode2...=file||This option specifies patch mode list and a file, separated by an equal sign. Mode is a point separated list of the keywords:
Abbreviations are allowed. The default is
If FILE starts with colon (
|--pre-convert||Convert the image before the image format for the destination file is selected. This results in a perhaps worser graphic and is only useful to control graphic conversions.|
|-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. In general: If set three times, different file format warnings are suppressed.|
|-r||--remove-dest||Remove already existing files before creating it. If set, --overwrite is ignored.
|--repair-magics||[=mode]||Control the reparing of missing or wrong magics of files and sub-files by analysing file path and file extension.
>>> THE RESULT MAY BE INVALID OUTPUT FILES! <<<
|--sections||Print in machine readable sections and parameter lines.|
|--strip||If creating a PNG file, don't add comments about creator and source formats.|
|-t||--test||Run in test mode, modify nothing.
>>> USE THIS OPTION IF UNSURE! <<<
|--timing||Activate the timing of some operations. Logging level 3 activates them too.|
|-x||--transform||list||Convert image formats. A comma separated list with terms is expected. A term have the syntax
Allowed file formats are:
All terms are managed as list. For each graphic the list is iterated until the first SRC tuple of a term matches the graphic. Then the destination tuple is used for the transformation.
|-u||--update||Update only existing files and don't create new files. 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.|
|-W||--warn||list||Enable or disable warnings. Parameter
|--width||width||Define the terminal 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.|