Skip to content

Commit ac98ccd

Browse files
author
GitHub Action
committed
Update RGBDS master documentation
1 parent 4cf3c7e commit ac98ccd

10 files changed

+52
-2
lines changed

docs/gbz80.7.pdf

0 Bytes
Binary file not shown.

docs/rgbasm.1.html

+52-2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a><
1717
[<code class="Fl"><a href="#p">-p</a></code> <var class="Ar">pad_value</var>]
1818
[<code class="Fl"><a href="#Q">-Q</a></code> <var class="Ar">fix_precision</var>]
1919
[<code class="Fl"><a href="#r">-r</a></code> <var class="Ar">recursion_depth</var>]
20+
[<code class="Fl"><a href="#s">-s</a></code>
21+
<var class="Ar">features</var>:<var class="Ar">state_file</var>]
2022
[<code class="Fl"><a href="#W">-W</a></code> <var class="Ar">warning</var>]
2123
[<code class="Fl"><a href="#X">-X</a></code> <var class="Ar">max_errors</var>]
2224
<var class="Ar">asmfile</var></td>
@@ -138,8 +140,50 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
138140
<var class="Ar">recursion_depth</var>,
139141
<code class="Fl">--recursion-depth</code>
140142
<var class="Ar">recursion_depth</var></dt>
141-
<dd>Specifies the recursion depth past which RGBASM will assume being in an
142-
infinite loop. The default is 64.</dd>
143+
<dd>Specifies the recursion depth past which <code class="Nm">rgbasm</code>
144+
will assume being in an infinite loop. The default is 64.</dd>
145+
<dt id="s"><a class="permalink" href="#s"><code class="Fl">-s</code></a>
146+
<var class="Ar">features</var>:<var class="Ar">state_file</var>,
147+
<code class="Fl">--state</code>
148+
<var class="Ar">features</var>:<var class="Ar">state_file</var></dt>
149+
<dd>Write the specified <var class="Ar">features</var> to
150+
<var class="Ar">state_file</var>, based on the final state of
151+
<code class="Nm">rgbasm</code> at the end of its input. The expected
152+
<var class="Ar">features</var> are a comma-separated subset of the
153+
following:
154+
<dl class="Bl-tag">
155+
<dt id="equ"><a class="permalink" href="#equ"><code class="Cm">equ</code></a></dt>
156+
<dd>Write all numeric constants as
157+
&#x2018;<code class="Li"><code class="Ic">def</code>
158+
<var class="Ar">name</var> <code class="Ic">equ</code>
159+
<var class="Ar">value</var></code>&#x2019;.</dd>
160+
<dt id="var"><a class="permalink" href="#var"><code class="Cm">var</code></a></dt>
161+
<dd>Write all variables as
162+
&#x2018;<code class="Li"><code class="Ic">def</code>
163+
<var class="Ar">name</var> <code class="Ic">=</code>
164+
<var class="Ar">value</var></code>&#x2019;.</dd>
165+
<dt id="equs"><a class="permalink" href="#equs"><code class="Cm">equs</code></a></dt>
166+
<dd>Write all string constants as
167+
&#x2018;<code class="Li"><code class="Ic">def</code>
168+
<var class="Ar">name</var> <code class="Ic">equs</code>
169+
&quot;<var class="Ar">value</var>&quot;</code>&#x2019;.</dd>
170+
<dt id="char"><a class="permalink" href="#char"><code class="Cm">char</code></a></dt>
171+
<dd>Write all characters as
172+
&#x2018;<code class="Li"><code class="Ic">charmap</code>
173+
<var class="Ar">name</var>,
174+
<var class="Ar">value</var></code>&#x2019;.</dd>
175+
<dt id="macro"><a class="permalink" href="#macro"><code class="Cm">macro</code></a></dt>
176+
<dd>Write all macros as
177+
&#x2018;<code class="Li"><code class="Ic">macro</code>
178+
<var class="Ar">name</var> <span class="No">...</span>
179+
<code class="Ic">endm</code></code>&#x2019;.</dd>
180+
<dt id="all"><a class="permalink" href="#all"><code class="Cm">all</code></a></dt>
181+
<dd>Acts like <code class="Cm">equ,var,equs,char,macro</code>.</dd>
182+
</dl>
183+
<p class="Pp">This flag may be specified multiple times with different
184+
feature subsets to write them to different files (see
185+
<a class="Sx" href="#EXAMPLES">EXAMPLES</a> below).</p>
186+
</dd>
143187
<dt id="V"><a class="permalink" href="#V"><code class="Fl">-V</code></a>,
144188
<code class="Fl">--version</code></dt>
145189
<dd>Print the version of the program and exit.</dd>
@@ -291,6 +335,12 @@ <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a><
291335
<p class="Pp">The resulting object file is not yet a usable ROM image&#x2014;it
292336
must first be run through <a class="Xr" href="./rgblink.1">rgblink(1)</a>
293337
and then <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>.</p>
338+
<p class="Pp">Writing the final assembler state to a file:</p>
339+
<div class="Bd Bd-indent"><code class="Li">$ rgbasm -s all:state.dump.asm
340+
foo.asm</code></div>
341+
<p class="Pp">Or to multiple files:</p>
342+
<div class="Bd Bd-indent"><code class="Li">$ rgbasm -s equ,var:numbers.dump.asm
343+
-s equs:strings.dump.asm foo.asm</code></div>
294344
</section>
295345
<section class="Sh">
296346
<h2 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h2>

docs/rgbasm.1.pdf

1.2 KB
Binary file not shown.

docs/rgbasm.5.pdf

0 Bytes
Binary file not shown.

docs/rgbds.5.pdf

0 Bytes
Binary file not shown.

docs/rgbds.7.pdf

0 Bytes
Binary file not shown.

docs/rgbfix.1.pdf

0 Bytes
Binary file not shown.

docs/rgbgfx.1.pdf

0 Bytes
Binary file not shown.

docs/rgblink.1.pdf

0 Bytes
Binary file not shown.

docs/rgblink.5.pdf

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)