3. Commands

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.

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').

This commands helps to convert hex values into floating point numbers and vice versa. 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.

The special parameters "+" and "-" mean: Increment or decrement the previous value by the smallest possible value. Use different increments for floats and doubles.

Compare parts of 2 different LECODE binary files. SETTINGS is a string with plus and minus signs to switch between plus/minus modes, and some key letters to select parts: s:size, h:header, t:timestamp, b:body, p:parameters, d:data, c:code and a:all. In plus-mode, a test is enabled, in minus-mode it is disabled. Scanning starts in plus-mode.

Example: a-t: compare all except timestamps.

The exist status is OK (0) if nothing differ, DIFFER (2) if at least one test failed, or an error code.

Read the entered LEX files (text or binary) and encode (compile) them to binary files. The default destination is '%P/%N.lex'.

4. Options in alphabetic order

Options

Option

Param

Description

--200cc

[=mode]

Enables or disables 200cc support. Mode is one of OFF, AUTO (default) or ON (default, if option is used without parameter).

--allow-all

Usually commands accept only options with impact to the command. All other options fire a syntax error. But if --allow-all is set, all commands accept all options.

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

Suppress cross reference comments.

--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, '@param' values are scanned while reading the command line.

--colors

[=modus]

Define the modus for colored text output. Allowed keywords are: OFF or NO-COLORS to disable colors, AUTO (default) for automatic detection, ON for automatic detection but never OFF, 8-COLORS and 256-COLORS to force 8 or 256 color support. Without parameter, ON is used.

AUTO will enable colorized output only for terminals. AUTO and ON use environment variable TERM to find the correct color modus.

If a command is prefixed by 'C-', then --color=ON is used implicitly as default.

--compatible

vers

The option expects a version number (format '#.##' or 'v#.##') or a revision number (format 'r#') as parameter. If set, the tools try to create BMG and KMP text files, that are compatible to the entered version of the tools. This may override other legacy options.

-C

--complete

Append missing sections to the LEX 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 'name=expression'. The expression is calculated by the text parser.

--copy-tracks

directory

Define a search directory for all included tracks. Files found in this directory are copied to the directory specified by option --track-dir.

The path may contain escape sequences: %Q is replaced by the fully qualified source name. %P and %F are replaced by the source path or by the filename. %N and %E are replaced by source filename without extension or by the source extension. Finally, %T is replaced by the default extension of the destination format.

A '?' direct behind '%' in %E and %T conversions avoid that the same extension is used twice in row.

-D

--DEST

path

Like --dest, but create the directory path automatically.

--engine

list

Define probabilities for engine classes. LIST is a vector for 100cc,150cc,mirror If 200cc is enabled by --200cc, then vector is interpreted as 150cc,200cc,mirror. Any numbers are accepted. They are normalized to get a total of 100 percent. Use 0,0,0 to reset to Nintendos VR based choice.

-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 '-E$'.

-X

--export

Enable the export mode and create small and machine readable text files for easy post processing.

--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.

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.

--move-tracks

directory

Define a search directory for all included tracks. Files found in this directory are moved to the directory specified by option --track-dir. If moving fails, the file is copied and removed.

--no-colors

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 maximum existing index+1. --num is a short cut.

--order-all

Used together with option --order-by: Re-distribute the tracks of all cups beginning with Mushroom Cup.

--order-by

bmg

Load the BMG file and filter track names. Then before creating output files, re-distribute the tracks of the additonal cups (9-) to the same cups by the order of the read track names. Tracks without BMG reference are placed at the end of all tracks. This option modifes only the track order of the cups, but will not change any name.

This option specifies a BMG patch mode. Some of the modes need a 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 NOTEQUAL. Modes with text parameter are FORMAT, REGEXP and RM-REGEXP. Standalone modes are ID, ID-ALL, UNICODE, RM-ESCAPES, RM-CUPS, CT-COPY, CT-FORCE-COPY, CT-FILL, LE-COPY, LE-FORCE-COPY, LE-FILL, X-COPY, X-FORCE-COPY and X-FILL. Unique abbreviations are allowed.

The optional condition COND is either '?MID' or '!MID'. In case of '?MID', the patch is only applied if the message id MID already exists. In case of '!MID', the patch is only applied if the message id MID does not exists.

If this option is used multiple times, all patch files will be processed in the entered order.

--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.

--perf-mon

[=mode]

Enables or disables the performance monitor. Mode is one of OFF, AUTO (default) or ON (default, if option is used without parameter).

-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. --rm-dest is a short cut.

--repair-magics

[=mode]

Control the reparing of missing or wrong magics of files and sub-files by analysing file path and file extension. MODE is one of OFF (default), ANALYSE or REPAIR (default, if set without mode). OFF disables this feature, ANALYSE enables it for analysis only, and REPAIR repairs all magics while reading the files. Keyword FNAME can be appended (separated by a comma) to give filename scanning the highest priority.

>>> THE RESULT MAY BE INVALID OUTPUT FILES! <<<

--round

Print additional lines with rounded values (to 3 and 2 bytes for floats and 7 and 6 bytes for doubles).

--sections

Print in machine readable sections and parameter lines.

-t

--test

Run in test mode, modify nothing.

>>> USE THIS OPTION IF UNSURE! <<<

--track-dir

directory

Define a destination directory, where track files are copied, move or linked to. Usually it is .../Race/Course/.

Files are searched in directories defined by --copy-tracks, --move-tracks and --link-tracks in definition order. Already existing files are removed before operation.

-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.

--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.