Added basic docs on the clock_... functions.

[cc65] / doc / nes.sgml

diff --git a/doc/nes.sgml b/doc/nes.sgml
index c66b1f2baad78681750a5bc78094cc0016ca7dfa..14fcac559bcf995a9fdad020c7311b993a5d9d1d 100644 (file)
--- a/doc/nes.sgml
+++ b/doc/nes.sgml
@@ -1,11 +1,10 @@
 <!doctype linuxdoc system>
 
 <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">
 
 <abstract>
 An overview over the NES runtime system as it is implemented for the
@@ -24,7 +23,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
-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.
@@ -68,8 +67,8 @@ Programs containing NES specific code may use the <tt/nes.h/ header file.
 <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>
 
 
@@ -122,6 +121,14 @@ No extended memory drivers are currently available for the NES.
 
 </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>
 
@@ -161,15 +168,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