ref: 3649cec52d57dc55e6b9cf499346f37c3ac8cbd1
dir: /doc/fix.htm/
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>RGBFix</title>
<link rel="stylesheet" type="text/css" href="./style.css">
</head>
<body>
<h1>RGBFix Documentation</h1>
<h2>Table of Contents</h2>
<ul>
<li><a href="#history">History</a>
<li><a href="#usage">Usage</a>
<li><a href="#options">Options</a>
</ul>
<h2 id="history">History</h2>
<table>
<caption>The history of RGBFix</caption>
<thead>
<tr>
<th scope="col">Version</th>
<th scope="col">Dated</th>
<th scope="col">Release notes</th>
</tr>
</thead>
<tr>
<td>1.0</td>
<td>1 Oct. 96</td>
<td>First release</td>
</tr>
<tr>
<td>1.01</td>
<td>3 Dec. 96</td>
<td>-t didn't Work. Fixed.</td>
</tr>
<tr>
<td>1.02</td>
<td>20 July 1997</td>
<td>RGBFix can now also truncate the ROM-images to a valid size.</td>
</tr>
</table>
<h2 id="usage">Usage</h2>
<pre> rgbfix [options] image[.gb]</pre>
<p>Options are preceded by a dash (-) and go as follows:
<pre> t<b>name</b> : Change title field of image
p : Pad image to valid size
v : Validate header
d : Debug, don't change image
r : Truncate image to valid size
q : Quiet mode, suppresses text except errors
h : Short help text</pre>
<p><strong>Note:</strong> RGBFix was previously released by me as a standalone program known as GBFix. I have chosen to release it in the ASMotor package instead from now on. Its usage has changed a bit from that of GBFix for the sake of consistence with the other ASMotor tools. Being part of RGBDS means RGBFix’s
distribution now follows the same rules as the rest of the ASMotor package. GBFix still follows its own rules.</p>
<h2 id="options">Options</h2>
<p>How to use the various options.
<h3>Titlefield</h3>
<p>This option changes the titlefield of the image to the string you specify truncated to a maximum of 16 characters. No uppercase conversion is performed.
<pre> rgbfix -tASMOTOR foobar.gb</pre>
<h3>Pad Image</h3>
<p>Pad the image to a valid size. 32Kb, 64Kb, 128Kb, 256Kb and 512Kb. RGBFix intelligently decides which one to use. The cartridge size byte in the image header is left unchanged. If you find this undesireable use the Validate Header option.
<pre> rgbfix -p foobar.gb</pre>
<h3>Truncate Image</h3>
<p>Truncates the image to a valid size. 32Kb, 64Kb, 128Kb, 256Kb and 512Kb. RGBFix intelligently decides which one to use. The cartridge size byte in the image header is left unchanged. If you find this undesireable use the Validate Header option.
<pre> rgbfix -r foobar.gb</pre>
<h3>Validate Header</h3>
<p>Examines the header for errors and validates them if any.
Areas examined:
<ul>
<li>Nintendo Character Area
<li>ROM size byte
<li>Cartridge type byte
<li>Checksums
</ul>
<pre> rgbfix -v foobar.gb</pre>
<h3>Debug</h3>
<p>Pretends it performs the desired changes.
<pre> rgbfix -tASMOTOR -p -v -d foobar.gb</pre>
<hr>
<p>Last updated 18 July 1997 by <a href="mailto:[email protected]">Carsten Sorensen</a></p>
</body>
</html>