From: ol.sc <ol.sc@b7a2c559-68d2-44c3-8de9-860c34a00d81>
Date: Fri, 9 Nov 2012 21:05:40 +0000 (+0000)
Subject: Added documentation of static drivers.
X-Git-Tag: V2.14~146
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=1c92251a0e5741de0cc7fcf511c1cc06af203ea1;p=cc65

Added documentation of static drivers.

git-svn-id: svn://svn.cc65.org/cc65/trunk@5928 b7a2c559-68d2-44c3-8de9-860c34a00d81
---

diff --git a/doc/atari.sgml b/doc/atari.sgml
index 5450b2990..9fe75ec2a 100644
--- a/doc/atari.sgml
+++ b/doc/atari.sgml
@@ -152,6 +152,9 @@ chip registers.
 
 <sect>Loadable drivers<p>
 
+The names in the parentheses denote the symbols to be used for static linking of the drivers.
+
+
 <sect1>Graphics drivers<p>
 
 <descrip>
diff --git a/doc/lynx.sgml b/doc/lynx.sgml
index 750eca000..48c3d7d4a 100644
--- a/doc/lynx.sgml
+++ b/doc/lynx.sgml
@@ -187,44 +187,52 @@ structures, accessing the struct fields will access the chip registers.
 
 <sect>Loadable drivers<p>
 
+The names in the parentheses denote the symbols to be used for static linking of the drivers.
+
+
 <sect1>Graphics drivers<p>
 
-A TGI driver for the standard graphics mode (160&times;102 in 16 colors) is
-available, but must be statically linked, because no file I/O is available.
+<descrip>
+
+  <tag><tt/lynx-160-102-16.tgi (lynx_160_102_16)/</tag>
+  A TGI driver for the standard graphics mode (160&times;102 in 16 colors).
 
-The TGI driver is implemented as an interrupt driven dual buffering device.
-To use it as a single-buffer device set draw page and view page to the same
-value 0 or 1;
+  The TGI driver is implemented as an interrupt driven dual buffering device.
+  To use it as a single-buffer device set draw page and view page to the same
+  value 0 or 1;
 
-The TGI driver has a few Lynx-specific extensions.
+  The TGI driver has a few Lynx-specific extensions.
 
-Calling tgi_sprite(spr) or tgi_ioctl(0, spr) will display a standard Lynx
-sprite on screen.
+  Calling tgi_sprite(spr) or tgi_ioctl(0, spr) will display a standard Lynx
+  sprite on screen.
 
-Calling tgi_flip() or tgi_ioctl(1, 0) will do a flip screen.
+  Calling tgi_flip() or tgi_ioctl(1, 0) will do a flip screen.
 
-Calling tgi_setbgcolor(bgcolor) or tgi_ioctl(2, bgindex) will set the text
-background color to the index defined by bgindex. If bgindex is 0 then the
-background color is transparent.
+  Calling tgi_setbgcolor(bgcolor) or tgi_ioctl(2, bgindex) will set the text
+  background color to the index defined by bgindex. If bgindex is 0 then the
+  background color is transparent.
 
-To set the framerate of the display hardware call tgi_setframerate(rate) or
-tgi_ioctl(3, rate). The supported framerates are 50, 60 and 75 frames per
-second. Actually there is no real reason to use anything else than 75 frames
-per second.
+  To set the framerate of the display hardware call tgi_setframerate(rate) or
+  tgi_ioctl(3, rate). The supported framerates are 50, 60 and 75 frames per
+  second. Actually there is no real reason to use anything else than 75 frames
+  per second.
 
-To check if the drawing engine is busy with the previous swap you can
-call tgi_busy or tgi_ioctl(4, 0). It returns 0 if idle and 1 if busy
+  To check if the drawing engine is busy with the previous swap you can
+  call tgi_busy or tgi_ioctl(4, 0). It returns 0 if idle and 1 if busy
 
-To update displays you can call tgi_updatedisplay() or tgi_ioctl(4, 1) it
-will wait for the next VBL interrupt and set the draw buffer to the
-view buffer. The draw buffer is also changed to (drawbuffer xor 1).
+  To update displays you can call tgi_updatedisplay() or tgi_ioctl(4, 1) it
+  will wait for the next VBL interrupt and set the draw buffer to the
+  view buffer. The draw buffer is also changed to (drawbuffer xor 1).
 
-You can also enable or disable collision detection by a call to
-tgi_setcollisiondetection(active) or tgi_ioctl(5, active). The collision
-result is located before the sprite structure by default in this driver.
+  You can also enable or disable collision detection by a call to
+  tgi_setcollisiondetection(active) or tgi_ioctl(5, active). The collision
+  result is located before the sprite structure by default in this driver.
+
+  In order to reserve memory for the collision detection buffer you need to
+  specify lynx-coll.cfg as the configuration file to the linker.
+
+</descrip><p>
 
-In order to reserve memory for the collision detection buffer you need to
-specify lynx-coll.cfg as the configuration file to the linker.
 
 <sect1>Extended memory drivers<p>
 
@@ -233,8 +241,13 @@ No extended memory drivers are currently available for the Lynx.
 
 <sect1>Joystick drivers<p>
 
-A joystick driver for the standard buttons is available, but must be
-statically linked, because no file I/O is available.
+<descrip>
+
+  <tag><tt/lynx-stdjoy.joy (lynx_stdjoy)/</tag>
+  A joystick driver for the standard buttons.
+
+</descrip><p>
+
 
 <sect1>Mouse drivers<p>
 
@@ -245,6 +258,9 @@ No mouse drivers are currently available for the Lynx.
 
 <descrip>
 
+  <tag><tt/lynx-comlynx.ser (lynx_comlynx)/</tag>
+  A serial driver for the ComLynx port.
+
   The ComLynx port has Tx and Rx wired together. Every byte is sent
   to all connected Lynxes. Only one Lynx can send at a time. There is no
   protocol created for communication. You are on your own.
diff --git a/doc/nes.sgml b/doc/nes.sgml
index aab7aa519..c66b1f2ba 100644
--- a/doc/nes.sgml
+++ b/doc/nes.sgml
@@ -94,17 +94,20 @@ allow access to hardware located in the address space.
 <sect>Loadable drivers<p>
 
 All drivers must be statically linked because no file I/O is available.
+The names in the parentheses denote the symbols to be used for static linking of the drivers.
+
 
 <sect1>Graphics drivers<p>
 
 <descrip>
 
-  <tag><tt/nes-64-56-2.tgi/</tag>
+  <tag><tt/nes-64-56-2.tgi (nes_64_56_2)/</tag>
   This driver features a resolution of 64&times;56 with 2 colors using the
   CHR bank.
 
 </descrip><p>
 
+
 <sect1>Extended memory drivers<p>
 
 No extended memory drivers are currently available for the NES.
@@ -112,7 +115,13 @@ No extended memory drivers are currently available for the NES.
 
 <sect1>Joystick drivers<p>
 
-A joystick driver for the standard four buttons joypad is available.
+<descrip>
+
+  <tag><tt/nes-stdjoy.joy (nes_stdjoy)/</tag>
+  A joystick driver for the standard four buttons joypad is available.
+
+</descrip><p>
+
 
 <sect1>Mouse drivers<p>
 
diff --git a/doc/pet.sgml b/doc/pet.sgml
index 33b268e87..35e794db5 100644
--- a/doc/pet.sgml
+++ b/doc/pet.sgml
@@ -133,6 +133,9 @@ structures, accessing the struct fields will access the chip registers.
 
 <sect>Loadable drivers<p>
 
+The names in the parentheses denote the symbols to be used for static linking of the drivers.
+
+
 <sect1>Graphics drivers<p>
 
 No graphics drivers are currently available for the PET.
@@ -147,12 +150,15 @@ No extended memory drivers are currently available for the PET.
 
 <descrip>
 
-  <tag><tt/pet-ptvjoy.joy/</tag>
+  <tag><tt/pet-ptvjoy.joy (pet_ptvjoy)/</tag>
   Driver for the Protovision 4-player adapter contributed by Groepaz. See
   <htmlurl url="http://www.protovision-online.de/hardw/hardwstart.htm"
   name="http://www.protovision-online.de/hardw/hardwstart.htm"> for prices and
   building instructions. Up to two joysticks are supported.
 
+  <tag><tt/pet-stdjoy.joy (pet_stdjoy)/</tag>
+  Driver for the standard PET userport joystick.
+
 </descrip><p>