Skip to content

Commit 6f2ebe1

Browse files
author
GitHub Action
committed
Update RGBDS master documentation
1 parent ae00e74 commit 6f2ebe1

11 files changed

Lines changed: 19 additions & 7 deletions

docs/gbz80.7.pdf

0 Bytes
Binary file not shown.

docs/rgbasm-old.5.pdf

0 Bytes
Binary file not shown.

docs/rgbasm.1.pdf

0 Bytes
Binary file not shown.

docs/rgbasm.5.html

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -836,6 +836,18 @@ <h3 class="Ss" id="String_expressions"><a class="permalink" href="#String_expres
836836
<span class="No">with the current charmap. If there is no unique charmap
837837
entry for</span> <var class="Ar">vals</var>, an error occurs.</td>
838838
</tr>
839+
<tr id="READFILE">
840+
<td><a class="permalink" href="#READFILE"><code class="Fn">READFILE</code></a>(<var class="Fa">name</var>,
841+
<var class="Fa">max</var>)</td>
842+
<td>Returns the contents of the file <var class="Ar">name</var>
843+
<span class="No">as a string. Reads up to</span> <var class="Ar">max</var>
844+
<span class="No">bytes, or the entire contents if</span>
845+
<var class="Ar">max</var> <span class="No">is not specified. If the file
846+
isn't found in the current directory, the include-path list passed
847+
to</span> <a class="Xr" href="./rgbasm.1">rgbasm(1)</a>'s
848+
<code class="Fl">-I</code> <span class="No">option on the command line
849+
will be searched.</span></td>
850+
</tr>
839851
</table>
840852
<p class="Pp">The following functions operate on string expressions, but return
841853
integers.</p>
@@ -2119,8 +2131,8 @@ <h3 class="Ss" id="Including_binary_data_files"><a class="permalink" href="#Incl
21192131
<p class="Pp">You probably have some graphics, level data, etc. you'd like to
21202132
include. Use <code class="Ic">INCBIN</code> to include a raw binary file as
21212133
it is. If the file isn't found in the current directory, the include-path
2122-
list passed to <a class="Xr" href="./rgbasm.1">rgbasm(1)</a> (see the
2123-
<code class="Fl">-I</code> option) on the command line will be searched.</p>
2134+
list passed to <a class="Xr" href="./rgbasm.1">rgbasm(1)</a>'s
2135+
<code class="Fl">-I</code> option on the command line will be searched.</p>
21242136
<div class="Bd Pp Bd-indent Li">
21252137
<pre>INCBIN &quot;titlepic.bin&quot;
21262138
INCBIN &quot;sprites/hero.bin&quot;</pre>
@@ -2600,11 +2612,11 @@ <h3 class="Ss" id="Including_other_source_files"><a class="permalink" href="#Inc
26002612
other source files</a></h3>
26012613
<p class="Pp">Use <code class="Ic">INCLUDE</code> to process another assembler
26022614
file and then return to the current file when done. If the file isn't found
2603-
in the current directory, the include path list (see the
2604-
<code class="Fl">-I</code> option in
2605-
<a class="Xr" href="./rgbasm.1">rgbasm(1)</a>) will be searched. You may
2606-
nest <code class="Ic">INCLUDE</code> calls infinitely (or until you run out
2607-
of memory, whichever comes first).</p>
2615+
in the current directory, the include-path list passed to
2616+
<a class="Xr" href="./rgbasm.1">rgbasm(1)</a>'s <code class="Fl">-I</code>
2617+
option on the command line will be searched. You may nest
2618+
<code class="Ic">INCLUDE</code> calls infinitely (or until you run out of
2619+
memory, whichever comes first).</p>
26082620
<div class="Bd Pp Bd-indent Li">
26092621
<pre> INCLUDE &quot;irq.inc&quot;</pre>
26102622
</div>

docs/rgbasm.5.pdf

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

0 commit comments

Comments
 (0)