Update RGBDS master documentation

gbdev · Dec 22, 2023 · c4dfeb3 · c4dfeb3
1 parent 40c7ae5
commit c4dfeb3
Show file tree

Hide file tree

Showing 18 changed files with 99 additions and 57 deletions.
diff --git a/docs/gbz80.7.html b/docs/gbz80.7.html
@@ -1748,12 +1748,17 @@ <h3 class="Ss" id="XOR_A,n8"><a class="permalink" href="#XOR_A,n8">XOR
 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
   ALSO</a></h2>
 <p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
+    <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
+    <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
     <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgbds</code> was originally written by Carsten
-    S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-    RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
+<p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a> was originally
+    written by <span class="An">Carsten S&#x00F8;rensen</span> as part of the
+    ASMotor package, and was later repackaged in RGBDS by
+    <span class="An">Justin Lloyd</span>. It is now maintained by a number of
+    contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/gbz80.7.pdf b/docs/gbz80.7.pdf
diff --git a/docs/rgbasm.1.html b/docs/rgbasm.1.html
@@ -319,17 +319,19 @@ <h2 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h2>
 <section class="Sh">
 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
   ALSO</a></h2>
-<p class="Pp"><a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+<p class="Pp"><a class="Xr" href="./rgbasm.5">rgbasm(5)</a>,
     <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
-    <a class="Xr" href="./rgbasm.5">rgbasm(5)</a>,
+    <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
     <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
     <a class="Xr" href="./rgbds.5">rgbds(5)</a>,
     <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgbasm</code> was originally written by Carsten
-    S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-    RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
+<p class="Pp"><code class="Nm">rgbasm</code> was originally written by
+    <span class="An">Carsten S&#x00F8;rensen</span> as part of the ASMotor
+    package, and was later repackaged in RGBDS by <span class="An">Justin
+    Lloyd</span>. It is now maintained by a number of contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/rgbasm.1.pdf b/docs/rgbasm.1.pdf
diff --git a/docs/rgbasm.5.html b/docs/rgbasm.5.html
@@ -2335,17 +2335,21 @@ <h3 class="Ss" id="Requesting_alignment"><a class="permalink" href="#Requesting_
 <section class="Sh">
 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
   ALSO</a></h2>
-<p class="Pp"><a class="Xr" href="./gbz80.7">gbz80(7)</a>,
-    <a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
+<p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
     <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
     <a class="Xr" href="./rgblink.5">rgblink(5)</a>,
+    <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
+    <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
     <a class="Xr" href="./rgbds.5">rgbds(5)</a>,
     <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgbasm</code> was originally written by Carsten
-    S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-    RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
+<p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a> was originally
+    written by <span class="An">Carsten S&#x00F8;rensen</span> as part of the
+    ASMotor package, and was later repackaged in RGBDS by
+    <span class="An">Justin Lloyd</span>. It is now maintained by a number of
+    contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/rgbasm.5.pdf b/docs/rgbasm.5.pdf
diff --git a/docs/rgbds.5.html b/docs/rgbds.5.html
@@ -653,14 +653,20 @@ <h3 class="Ss" id="RPN_EXPRESSIONS"><a class="permalink" href="#RPN_EXPRESSIONS"
 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
   ALSO</a></h2>
 <p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
+    <a class="Xr" href="./rgbasm.5">rgbasm(5)</a>,
     <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
-    <a class="Xr" href="./rgbds.7">rgbds(7)</a>,
-    <a class="Xr" href="./gbz80.7">gbz80(7)</a></p>
+    <a class="Xr" href="./rgblink.5">rgblink(5)</a>,
+    <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
+    <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
+    <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgbds</code> was originally written by Carsten
-    S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-    RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
+<p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a> and
+    <a class="Xr" href="./rgblink.1">rgblink(1)</a> were originally written by
+    <span class="An">Carsten S&#x00F8;rensen</span> as part of the ASMotor
+    package, and was later repackaged in RGBDS by <span class="An">Justin
+    Lloyd</span>. It is now maintained by a number of contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/rgbds.5.pdf b/docs/rgbds.5.pdf
diff --git a/docs/rgbds.7.html b/docs/rgbds.7.html
@@ -2,42 +2,57 @@
 <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
 <p class="Pp">To get a working ROM image from a single assembly source file:</p>
 <div class="Bd Pp Bd-indent Li">
-<pre>$ rgbasm -o bar.o foo.asm
-$ rgblink -o baz.gb bar.o
-$ rgbfix -v -p 0 baz.gb</pre>
+<pre>$ rgbasm -o game.o game.asm
+$ rgblink -o game.gb game.o
+$ rgbfix -v -p 0 game.gb</pre>
 </div>
-Or in a single command line:
+<p class="Pp">Or in a single command line, without creating an intermediate
+    object file:</p>
 <div class="Bd Pp Bd-indent Li">
-<pre>$ rgbasm -o - foo.asm | rgblink -o - - | rgbfix -v -p 0 - &gt; baz.gb</pre>
+<pre>$ (rgbasm -o - - | rgblink -o - - | rgbfix -v -p 0) &lt; game.asm &gt; game.gb</pre>
 </div>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
   ALSO</a></h2>
 <p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
-    <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbasm.5">rgbasm(5)</a>,
     <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
-    <a class="Xr" href="./rgbds.5">rgbds(5)</a>,
-    <a class="Xr" href="./gbz80.7">gbz80(7)</a></p>
+    <a class="Xr" href="./rgblink.5">rgblink(5)</a>,
+    <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
+    <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
+    <a class="Xr" href="./rgbds.5">rgbds(5)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
 <ul class="Bl-item">
-  <li>1997, Carsten S&#x00F8;rensen (AKA SurfSmurf) writes ASMotor as a
-      general-purpose assembler/linker system for DOS/Win32.</li>
-  <li>1999, Justin Lloyd (AKA Otaku no Zoku) adapts ASMotor to read and produce
-      GBZ80 assembly/machine code, and releases this version as RGBDS.</li>
-  <li>2009, Vegard Nossum adapts the code to be more UNIX-like and releases this
-      version as rgbds-linux on GitHub.</li>
-  <li>2010, Anthony J. Bentley forks that repository. The fork becomes the
-      reference implementation of rgbds.</li>
-  <li>2017, Bentley's repository is moved to a neutral name. It is now
-      maintained by a number of contributors at
-      <a class="Lk" href="https://github.com/rednex/rgbds">https://github.com/rednex/rgbds</a>.</li>
-  <li>2018, codebase relicensed under the MIT license.</li>
-  <li>2020, repository is moved to the gbdev organisation, at
-      <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.
-      The <a class="Lk" href="https://rgbds.gbdev.io">https://rgbds.gbdev.io</a>
-      website serving documentation and downloads is created.</li>
+  <li>1996-10-01: <span class="An">Carsten S&#x00F8;rensen</span> (a.k.a.
+      SurfSmurf) releases xAsm, xLink, and RGBFix, a Game Boy SM83 (GBZ80)
+      assembler/linker system for DOS/Win32.</li>
+  <li>1997-07-03: S&#x00F8;rensen releases ASMotor, packaging the three programs
+      together and moving towards making them a general-purpose
+      target-independent system.</li>
+  <li>1999-08-01: <span class="An">Justin Lloyd</span> (a.k.a. Otaku no Zoku)
+      adapts ASMotor to re-focus on SM83 assembly/machine code, and releases
+      this version as RGBDS.</li>
+  <li>2009-06-11: <span class="An">Vegard Nossum</span> adapts the code to be
+      more UNIX-like and releases this version as rgbds-linux.</li>
+  <li>2010-01-12: <span class="An">Anthony J. Bentley</span> forks Nossum's
+      repository. The fork becomes the reference implementation of RGBDS.</li>
+  <li>2015-01-18: <span class="An">stag019</span> begins implementing rgbgfx, a
+      PNG&#x2010;to&#x2010;Game Boy graphics converter, for eventual integration
+      into RGBDS.</li>
+  <li>2016-09-05: rgbgfx is integrated into Bentley's repository.</li>
+  <li>2017-02-23: Bentley's repository is moved to the
+      <a class="Lk" href="https://github.com/rednex/rgbds">rednex</a>
+      organization.</li>
+  <li>2018-01-26: The codebase is relicensed under the MIT license.</li>
+  <li>2020-09-15: The repository is moved to the
+      <a class="Lk" href="https://github.com/gbdev/rgbds">gbdev</a>
+      organization.</li>
+  <li>2022-05-17: The
+      <a class="Lk" href="https://rgbds.gbdev.io">https://rgbds.gbdev.io</a>
+      website for RGBDS documentation and downloads is published.</li>
 </ul>
 </section>
diff --git a/docs/rgbds.7.pdf b/docs/rgbds.7.pdf
diff --git a/docs/rgbfix.1.html b/docs/rgbfix.1.html
@@ -226,13 +226,16 @@ <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
   ALSO</a></h2>
 <p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
     <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
+    <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
     <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgbfix</code> was originally released by Carsten
-    S&#x00F8;rensen as a standalone program called gbfix, and was later packaged
-    in RGBDS by Justin Lloyd. It is now maintained by a number of contributors
-    at
+<p class="Pp"><code class="Nm">rgbfix</code> was originally written by
+    <span class="An">Carsten S&#x00F8;rensen</span> as a standalone program
+    called GBFix, which was then packaged in ASMotor, and was later repackaged
+    in RGBDS by <span class="An">Justin Lloyd</span>. It is now maintained by a
+    number of contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/rgbfix.1.pdf b/docs/rgbfix.1.pdf
diff --git a/docs/rgbgfx.1.html b/docs/rgbgfx.1.html
@@ -684,17 +684,16 @@ <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
 <p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
     <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
     <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
-    <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
     <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 <p class="Pp">The Game Boy hardware reference
     <a class="Lk" href="https://gbdev.io/pandocs/Graphics">Pan Docs</a>,
     particularly the section about graphics.</p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgbgfx</code> was originally created by
-    <span class="An">stag019</span> to be included in RGBDS. It was later
-    rewritten by <span class="An">ISSOtm</span>, and is now maintained by a
-    number of contributors at
+<p class="Pp"><code class="Nm">rgbgfx</code> was originally written by stag019
+    as a program to be packaged in RGBDS. It was later rewritten by
+    <span class="An">ISSOtm</span>, and is now maintained by a number of
+    contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/rgbgfx.1.pdf b/docs/rgbgfx.1.pdf
diff --git a/docs/rgblink.1.html b/docs/rgblink.1.html
@@ -210,13 +210,16 @@ <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
 <p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
     <a class="Xr" href="./rgblink.5">rgblink(5)</a>,
     <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
+    <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
     <a class="Xr" href="./rgbds.5">rgbds(5)</a>,
     <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgblink</code> was originally written by Carsten
-    S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-    RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
+<p class="Pp"><code class="Nm">rgblink</code> was originally written by
+    <span class="An">Carsten S&#x00F8;rensen</span> as part of the ASMotor
+    package, and was later repackaged in RGBDS by <span class="An">Justin
+    Lloyd</span>. It is now maintained by a number of contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/rgblink.1.pdf b/docs/rgblink.1.pdf
diff --git a/docs/rgblink.5.html b/docs/rgblink.5.html
@@ -78,15 +78,20 @@ <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIP
 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
   ALSO</a></h2>
 <p class="Pp"><a class="Xr" href="./rgbasm.1">rgbasm(1)</a>,
+    <a class="Xr" href="./rgbasm.5">rgbasm(5)</a>,
     <a class="Xr" href="./rgblink.1">rgblink(1)</a>,
     <a class="Xr" href="./rgbfix.1">rgbfix(1)</a>,
+    <a class="Xr" href="./rgbgfx.1">rgbgfx(1)</a>,
+    <a class="Xr" href="./gbz80.7">gbz80(7)</a>,
     <a class="Xr" href="./rgbds.5">rgbds(5)</a>,
     <a class="Xr" href="./rgbds.7">rgbds(7)</a></p>
 </section>
 <section class="Sh">
 <h2 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h2>
-<p class="Pp"><code class="Nm">rgblink</code> was originally written by Carsten
-    S&#x00F8;rensen as part of the ASMotor package, and was later packaged in
-    RGBDS by Justin Lloyd. It is now maintained by a number of contributors at
+<p class="Pp"><a class="Xr" href="./rgblink.1">rgblink(1)</a> was originally
+    written by <span class="An">Carsten S&#x00F8;rensen</span> as part of the
+    ASMotor package, and was later repackaged in RGBDS by
+    <span class="An">Justin Lloyd</span>. It is now maintained by a number of
+    contributors at
     <a class="Lk" href="https://github.com/gbdev/rgbds">https://github.com/gbdev/rgbds</a>.</p>
 </section>
diff --git a/docs/rgblink.5.pdf b/docs/rgblink.5.pdf