Express assumption about struct timespec.

[cc65] / doc / nes.sgml

diff --git a/doc/nes.sgml b/doc/nes.sgml
index ea03ea34c9907df6dbf617879a2273ab2e42d38a..8f4374e055b998cb1c4bdaa38d232c830f43cb48 100644 (file)
--- a/doc/nes.sgml
+++ b/doc/nes.sgml
@@ -3,9 +3,10 @@
 <article>
 
 <title>Nintendo Entertainment System specific information for cc65
 <article>
 
 <title>Nintendo Entertainment System specific information for cc65

-<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
-Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org">
-<date>2005-07-17
+<author>
+<url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
+<url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">
+<date>2014-04-12

 
 <abstract>
 An overview over the NES runtime system as it is implemented for the
 
 <abstract>
 An overview over the NES runtime system as it is implemented for the


@@ -24,7 +25,7 @@ with the cc65 C compiler. It describes the memory layout, NES specific header
 files, available drivers, and any pitfalls specific to that platform.
 
 Please note that NES specific functions are just mentioned here, they are
 files, available drivers, and any pitfalls specific to that platform.
 
 Please note that NES specific functions are just mentioned here, they are

-described in detail in the separate <htmlurl url="funcref.html" name="function
+described in detail in the separate <url url="funcref.html" name="function

 reference">. Even functions marked as "platform dependent" may be available on
 more than one platform. Please see the function reference for more
 information.
 reference">. Even functions marked as "platform dependent" may be available on
 more than one platform. Please see the function reference for more
 information.


@@ -68,8 +69,8 @@ Programs containing NES specific code may use the <tt/nes.h/ header file.
 <sect1>NES specific functions<p>
 
 <itemize>
 <sect1>NES specific functions<p>
 
 <itemize>

-<item>waitvblank
-<item>get_tv
+<item>waitvsync - wait until the start of the next frame</item>
+<item>get_tv</item>

 </itemize>
 
 
 </itemize>
 
 


@@ -94,19 +95,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.
 <sect>Loadable drivers<p>
 
 All drivers must be statically linked because no file I/O is available.

-See the documentation for the <htmlurl url="co65.html" name="co65 utility">
-for information on how to do that.
+The names in the parentheses denote the symbols to be used for static linking of the drivers.
+

 
 <sect1>Graphics drivers<p>
 
 <descrip>
 
 
 <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>
 
   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.
 <sect1>Extended memory drivers<p>
 
 No extended memory drivers are currently available for the NES.


@@ -114,7 +116,21 @@ No extended memory drivers are currently available for the NES.
 
 <sect1>Joystick drivers<p>
 
 
 <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>
+
+The generic interface doesn't export the start and select buttons. To
+test for those, use the defines in nes.h instead of the generic masks.
+
+Example:
+<tscreen><verb>
+if (joy_read(0) & KEY_A)
+</verb></tscreen>
+

 
 <sect1>Mouse drivers<p>
 
 
 <sect1>Mouse drivers<p>
 


@@ -154,15 +170,6 @@ following functions (and a few others):
 
 
 
 
 
 

-<sect>Bugs/Feedback<p>
-
-If you have problems using the library, if you find any bugs, or if you're
-doing something interesting with it, I would be glad to hear from you. Feel
-free to contact me by email (<htmlurl url="mailto:uz@cc65.org"
-name="uz@cc65.org">).
-
-
-

 <sect>License<p>
 
 This software is provided 'as-is', without any expressed or implied
 <sect>License<p>
 
 This software is provided 'as-is', without any expressed or implied