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'). |
SYMBOLS | Print predefined symbols of text parser to standard output. The CTCODE specific symbols are included. | |
FUNCTIONS | Print a list with all parser functions including the CTCODE specific functions. If one key ore more key entered, then only functions that match at least one key are printed. | |
CALCULATE | Calculate each expression and print the result to standard output. | |
FLOAT | This commands helps to convert hex value into floating point numbers. For each non empty parameter, a line with 4 bytes hex and a float, 8 bytes hex and a double float, and the parameter itself is printed. If a parameter begins with 'x' or '0x', it is a hex string. Otherwise it is a floating point number. All conversions are done using big endian. | |
D | DUMP | Print an information dump for the CT-CODE of each source file. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input. |
CAT | Read the source files and print the CT-CODE part them as decoded text files to standard output. The output of all source files is concatenated. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input. | |
BMG | Read the source files and print a BMG message listing. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input. | |
DECODE | DEC | Read the source files and decode them to CT-TEXT files. The default destination is |
CREATE | C | Read the source files, scan the CT-CODE part and create an output file contolled by the keyword. BRRES, TEX0, CT-CODE and CT-TEXT files are accepted as input. Possible keywords are: CUP1, CRS1, xx-CODE, xx-TEX0, BMG, LIST, REF and |
Options | |||
---|---|---|---|
Option | Param | Description | |
--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 | 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 ' |
--crs1 | value | Store this value into all 8 members of the property array of the CRS1 header if reading a CT-TEXT. The default value is 0x800. | |
--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 |
--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! <<< |
||
--full | Cancel all previous --list and --rel and enter FULL mode for text output.
FULL mode is a combination of LIST and REF modes. |
||
-h | --help | Stop parsing the command line, print a help message and exit. | |
--hex | Normally and if available, names are printed for music and property slots. If this option is set, hex numbers are printed always. | ||
-i | --ignore | Ignore non existing source files without warning. | |
--list | Cancel all previous --rel and --full and enter LIST mode (default) for text output.
In LIST mode only a track list is generated. On scanning the tracks are automatically distributed to the cups. This makes rearanging very simple. |
||
--load-bmg | file | Load the file to fill an internal message pool. The option can be used multiple times to fill the message pool by different sources. A later message overrides the previous message. | |
-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. |
-N | --no-check | Do not make plausibility checks for KCL and KMP files. | |
--no-color | Deactive colorized text. This is the default, if an output file is not a terminal. | ||
--no-echo | Suppress output of @ECHO commands while scanning text files. | ||
-H | --no-header | Suppress the syntax information section in BMG text files. | |
-P | --no-param | Disable parameter support in decoded KMP 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. | |
--patch-names | If set, the names of the CUP1 and CSR1 sections are patched by the loaded BMG files directly after loading the source files. | ||
-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. | |
--ref | Cancel all previous --list and --full and enter REFERENCE mode for text output.
In REFERENCE mode all tracks and cups are printed separatly. After scanning the cup and track layout is the same as the origonal code file. |
||
-r | --remove-dest | Remove already existing files before creating it. If set, --overwrite is ignored. |
|
--sections | Print in machine readable sections and parameter lines. | ||
-t | --test | Run in test mode, modify nothing.
>>> USE THIS OPTION IF UNSURE! <<< |
|
-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. |