Regenerate wwwman

This commit is contained in:
ISSOtm
2019-11-01 17:35:46 +01:00
parent e93d65d736
commit a1d132cd35
9 changed files with 161 additions and 74 deletions

View File

@@ -3,7 +3,7 @@
<!-- This is an automatically generated file. Do not edit. <!-- This is an automatically generated file. Do not edit.
This file is part of RGBDS. This file is part of RGBDS.
Copyright (c) 2010-2018, Anthony J. Bentley and RGBDS contributors. Copyright (c) 2010-2019, Anthony J. Bentley and RGBDS contributors.
SPDX-License-Identifier: MIT SPDX-License-Identifier: MIT
--> -->
@@ -39,6 +39,7 @@
[<code class="Fl">-M</code> <var class="Ar">dependfile</var>] [<code class="Fl">-M</code> <var class="Ar">dependfile</var>]
[<code class="Fl">-o</code> <var class="Ar">outfile</var>] [<code class="Fl">-o</code> <var class="Ar">outfile</var>]
[<code class="Fl">-p</code> <var class="Ar">pad_value</var>] [<code class="Fl">-p</code> <var class="Ar">pad_value</var>]
[<code class="Fl">-r</code> <var class="Ar">recursion_depth</var>]
<var class="Ar">file</var></td> <var class="Ar">file</var></td>
</tr> </tr>
</table> </table>
@@ -46,7 +47,9 @@
<section class="Sh"> <section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> <h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The <code class="Nm">rgbasm</code> program creates an object file from an The <code class="Nm">rgbasm</code> program creates an object file from an
assembly source file. Its arguments are as follows: assembly source file. The input <var class="Ar">file</var> can be a file path,
or <code class="Cm">-</code> denoting <code class="Cm">stdin</code>. Its
arguments are as follows:
<dl class="Bl-tag"> <dl class="Bl-tag">
<dt><a class="permalink" href="#b"><code class="Fl" id="b">-b</code></a> <dt><a class="permalink" href="#b"><code class="Fl" id="b">-b</code></a>
<var class="Ar">chars</var></dt> <var class="Ar">chars</var></dt>
@@ -85,6 +88,10 @@ The <code class="Nm">rgbasm</code> program creates an object file from an
<dt><a class="permalink" href="#p"><code class="Fl" id="p">-p</code></a> <dt><a class="permalink" href="#p"><code class="Fl" id="p">-p</code></a>
<var class="Ar">pad_value</var></dt> <var class="Ar">pad_value</var></dt>
<dd>When padding an image, pad with this value. The default is 0x00.</dd> <dd>When padding an image, pad with this value. The default is 0x00.</dd>
<dt><a class="permalink" href="#r"><code class="Fl" id="r">-r</code></a>
<var class="Ar">recursion_depth</var></dt>
<dd>Specifies the recursion depth at which RGBASM will assume being in an
infinite loop.</dd>
<dt><a class="permalink" href="#V"><code class="Fl" id="V">-V</code></a></dt> <dt><a class="permalink" href="#V"><code class="Fl" id="V">-V</code></a></dt>
<dd>Print the version of the program and exit.</dd> <dd>Print the version of the program and exit.</dd>
<dt><a class="permalink" href="#v"><code class="Fl" id="v">-v</code></a></dt> <dt><a class="permalink" href="#v"><code class="Fl" id="v">-v</code></a></dt>
@@ -95,12 +102,19 @@ The <code class="Nm">rgbasm</code> program creates an object file from an
</section> </section>
<section class="Sh"> <section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> <h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
Assembling a basic source file is simple: You can assemble a source file in two ways. Straight forward way:
<div class="Bd Pp Bd-indent"> <div class="Bd Pp Bd-indent">
<pre> <pre>
$ rgbasm -o bar.o foo.asm $ rgbasm -o bar.o foo.asm
</pre> </pre>
</div> </div>
<p class="Pp">Pipes way:</p>
<div class="Bd Pp Bd-indent">
<pre>
$ cat foo.asm | rgbasm -o bar.o -
$ rgbasm -o bar.o - &lt; foo.asm
</pre>
</div>
<p class="Pp">The resulting object file is not yet a usable ROM image &#x2014; <p class="Pp">The resulting object file is not yet a usable ROM image &#x2014;
it must first be run through <a class="Xr">rgblink(1)</a> and it must first be run through <a class="Xr">rgblink(1)</a> and
<a class="Xr">rgbfix(1)</a>.</p> <a class="Xr">rgbfix(1)</a>.</p>
@@ -122,7 +136,7 @@ $ rgbasm -o bar.o foo.asm
</div> </div>
<table class="foot"> <table class="foot">
<tr> <tr>
<td class="foot-date">February 24, 2018</td> <td class="foot-date">July 8, 2019</td>
<td class="foot-os">RGBDS Manual</td> <td class="foot-os">RGBDS Manual</td>
</tr> </tr>
</table> </table>

View File

@@ -426,11 +426,11 @@ PUSHA EQUS &quot;push af\npush bc\npush de\npush hl\n&quot;
<p class="Pp">Note that a colon (:) following the label-name is not allowed. <p class="Pp">Note that a colon (:) following the label-name is not allowed.
String equates can't be exported or imported.</p> String equates can't be exported or imported.</p>
<p class="Pp"><b class="Sy">Important note</b>: An EQUS can be expanded to a <p class="Pp"><b class="Sy">Important note</b>: An EQUS can be expanded to a
string that contains another EQUS and it will be expanded as well. This string that contains another EQUS and it will be expanded as well. If
means that, if you aren't careful, you may trap the assembler into an this creates an infinite loop, RGBASM will error out once a certain
infinite loop if there's a circular dependency in the expansions. Also, depth is reached. See the -r command-line option. Also, a MACRO can have
a MACRO can have inside an EQUS which references the same MACRO, which inside an EQUS which references the same MACRO, which has the same
has the same problem.</p> problem.</p>
</dd> </dd>
<dt><b class="Sy">MACRO</b></dt> <dt><b class="Sy">MACRO</b></dt>
<dd> <dd>
@@ -534,16 +534,16 @@ LoopyMacro MyVars,54
you can only use the first 9 like this. If you want to use the rest, you you can only use the first 9 like this. If you want to use the rest, you
need to use the keyword <code class="Ic">SHIFT</code>.</p> need to use the keyword <code class="Ic">SHIFT</code>.</p>
<p class="Pp">Line continuations work as usual inside macros or lists of <p class="Pp">Line continuations work as usual inside macros or lists of
arguments of macros. Strings, however, are a bit trickier. The following arguments of macros. However, some characters need to be escaped, as in
example shows how to use strings as arguments for a macro:</p> the following example:</p>
<div class="Bd Pp Bd-indent"> <div class="Bd Pp Bd-indent">
<pre> <pre>
PrintMacro : MACRO PrintMacro : MACRO
PRINTT \1 PRINTT \1
ENDM ENDM
PrintMacro STRCAT(\&quot;Hello\&quot;\, \ PrintMacro STRCAT(&quot;Hello&quot;\, \
\&quot; world\\n\&quot;) &quot; world\\n&quot;)
</pre> </pre>
</div> </div>
<p class="Pp"><code class="Ic">SHIFT</code> is a special command only <p class="Pp"><code class="Ic">SHIFT</code> is a special command only
@@ -1189,15 +1189,45 @@ The most basic string expression is any number of characters contained in double
This will examine the type of the symbol and insert its value accordingly. This will examine the type of the symbol and insert its value accordingly.
If symbol is a string symbol, the symbols value is simply copied. If it's a If symbol is a string symbol, the symbols value is simply copied. If it's a
numeric symbol, the value is converted to hexadecimal notation and inserted numeric symbol, the value is converted to hexadecimal notation and inserted
as a string.</p> as a string with a dollar prepended.</p>
<p class="Pp">HINT: The <b class="Sy">{symbol}</b> construct can also be used <p class="Pp">It's possible to change the way numeric symbols are converted by
outside strings. The symbol's value is again inserted as a string. This is specifying a print type like so: <b class="Sy">{d:symbol}</b> Valid print
just a short way of doing &#x201C;{symbol}&#x201D;.</p> types are:</p>
<p class="Pp">Whenever the macro-language expects a string you can actually use <table class="Bl-column Bd-indent">
a string expression. This consists of one or more of these function (yes, <tr>
you can nest them). Note that some of these functions actually return an <td><b class="Sy">Print type</b></td>
integer and can be used as part of an integer expression!</p> <td><b class="Sy">Format</b></td>
<table class="Bl-column"> <td><b class="Sy">Example</b></td>
</tr>
<tr>
<td><a class="permalink" href="#d"><code class="Li" id="d">d</code></a></td>
<td>Decimal</td>
<td>42</td>
</tr>
<tr>
<td><a class="permalink" href="#x"><code class="Li" id="x">x</code></a></td>
<td>Lowercase hexadecimal</td>
<td>2a</td>
</tr>
<tr>
<td><a class="permalink" href="#X"><code class="Li" id="X">X</code></a></td>
<td>Uppercase hexadecimal</td>
<td>2A</td>
</tr>
<tr>
<td><a class="permalink" href="#b"><code class="Li" id="b">b</code></a></td>
<td>Binary</td>
<td>101010
<p class="Pp">Note that print types should only be used with numeric values,
not strings.</p>
<p class="Pp">HINT: The <b class="Sy">{symbol}</b> construct can also be
used outside strings. The symbol's value is again inserted as a string.
This is just a short way of doing &#x201C;{symbol}&#x201D;.</p>
<p class="Pp">Whenever the macro-language expects a string you can actually
use a string expression. This consists of one or more of these function
(yes, you can nest them). Note that some of these functions actually
return an integer and can be used as part of an integer expression!</p>
<table class="Bl-column">
<tr> <tr>
<td><b class="Sy">Name</b></td> <td><b class="Sy">Name</b></td>
<td><b class="Sy">Operation</b></td> <td><b class="Sy">Operation</b></td>
@@ -1214,14 +1244,14 @@ The most basic string expression is any number of characters contained in double
<tr> <tr>
<td><code class="Fn">STRCMP</code>(<var class="Fa">str1</var>, <td><code class="Fn">STRCMP</code>(<var class="Fa">str1</var>,
<var class="Fa">str2</var>)</td> <var class="Fa">str2</var>)</td>
<td>Returns negative if str1 is alphabetically lower than str2, zero if they <td>Returns negative if str1 is alphabetically lower than str2, zero if
match, positive if str1 is greater than str2.</td> they match, positive if str1 is greater than str2.</td>
</tr> </tr>
<tr> <tr>
<td><code class="Fn">STRIN</code>(<var class="Fa">str1</var>, <td><code class="Fn">STRIN</code>(<var class="Fa">str1</var>,
<var class="Fa">str2</var>)</td> <var class="Fa">str2</var>)</td>
<td>Returns the position of str2 in str1 or zero if it's not present (first <td>Returns the position of str2 in str1 or zero if it's not present
character is position 1).</td> (first character is position 1).</td>
</tr> </tr>
<tr> <tr>
<td><code class="Fn">STRSUB</code>(<var class="Fa">str</var>, <td><code class="Fn">STRSUB</code>(<var class="Fa">str</var>,
@@ -1239,6 +1269,9 @@ The most basic string expression is any number of characters contained in double
<td>Converts all characters in str to lower case and returns the new <td>Converts all characters in str to lower case and returns the new
string.</td> string.</td>
</tr> </tr>
</table>
</td>
</tr>
</table> </table>
</section> </section>
<section class="Ss"> <section class="Ss">
@@ -1258,10 +1291,48 @@ CHARMAP &quot;&amp;iacute&quot;, 20
CHARMAP &quot;A&quot;, 128 CHARMAP &quot;A&quot;, 128
</pre> </pre>
</div> </div>
<p class="Pp">It is possible to create multiple character maps and then switch
between them as desired. This can be used to encode debug information in
ASCII and use a different encoding for other purposes, for example.
Initially, there is one character map called <b class="Sy">main</b> and it
is automatically selected as the current character map from the beginning.
There is also a character map stack that can be used to save and restore
which character map is currently active.</p>
<table class="Bl-column">
<tr>
<td><b class="Sy">Command</b></td>
<td><b class="Sy">Meaning</b></td>
</tr>
<tr>
<td><a class="permalink" href="#NEWCHARMAP"><code class="Ic" id="NEWCHARMAP">NEWCHARMAP</code></a>
<var class="Ar">name</var></td>
<td>Creates a new, empty character map called
<code class="Ic">name</code>.</td>
</tr>
<tr>
<td><a class="permalink" href="#NEWCHARMAP_2"><code class="Ic" id="NEWCHARMAP_2">NEWCHARMAP</code></a>
<var class="Ar">name</var>, <var class="Ar">basename</var></td>
<td>Creates a new character map called <code class="Ic">name</code>, copied
from character map <code class="Ic">basename</code>.</td>
</tr>
<tr>
<td><a class="permalink" href="#SETCHARMAP"><code class="Ic" id="SETCHARMAP">SETCHARMAP</code></a>
<var class="Ar">name</var></td>
<td>Switch to character map <code class="Ic">name</code>.</td>
</tr>
<tr>
<td><a class="permalink" href="#PUSHC"><code class="Ic" id="PUSHC">PUSHC</code></a></td>
<td>Push the current character map onto the stack.</td>
</tr>
<tr>
<td><a class="permalink" href="#POPC"><code class="Ic" id="POPC">POPC</code></a></td>
<td>Pop a character map off the stack and switch to it.</td>
</tr>
</table>
<p class="Pp"><b class="Sy">Note:</b> Character maps affect all strings in the <p class="Pp"><b class="Sy">Note:</b> Character maps affect all strings in the
file from the point in which they are defined. This means that any string file from the point in which they are defined, until switching to a
that the code may want to print as debug information will also be affected different character map. This means that any string that the code may want
by it.</p> to print as debug information will also be affected by it.</p>
<p class="Pp"><b class="Sy">Note:</b> The output value of a mapping can be 0. If <p class="Pp"><b class="Sy">Note:</b> The output value of a mapping can be 0. If
this happens, the assembler will treat this as the end of the string and the this happens, the assembler will treat this as the end of the string and the
rest of it will be trimmed.</p> rest of it will be trimmed.</p>

View File

@@ -77,6 +77,8 @@ The <code class="Nm">rgbgfx</code> program converts PNG images into the Nintendo
<dd>Same as <code class="Fl">-a</code>, but the attrmap file output name is <dd>Same as <code class="Fl">-a</code>, but the attrmap file output name is
made by taking the input filename, removing the file extension, and made by taking the input filename, removing the file extension, and
appending <span class="Pa">.attrmap</span>.</dd> appending <span class="Pa">.attrmap</span>.</dd>
<dt><a class="permalink" href="#C"><code class="Fl" id="C">-C</code></a></dt>
<dd>Use the color curve of the Game Boy Color when generating palettes.</dd>
<dt><a class="permalink" href="#D"><code class="Fl" id="D">-D</code></a></dt> <dt><a class="permalink" href="#D"><code class="Fl" id="D">-D</code></a></dt>
<dd>Debug features are enabled.</dd> <dd>Debug features are enabled.</dd>
<dt><a class="permalink" href="#f"><code class="Fl" id="f">-f</code></a></dt> <dt><a class="permalink" href="#f"><code class="Fl" id="f">-f</code></a></dt>