Support for preprocessing info file via cpp or m4.

[cc65] / doc / atmos.sgml

diff --git a/doc/atmos.sgml b/doc/atmos.sgml
index ab63c667b94a4531e424a07bec16806e8b6fbf3a..9e61fbd1c0e04fa1804fb1397fe46068882f82aa 100644 (file)
--- a/doc/atmos.sgml
+++ b/doc/atmos.sgml
@@ -7,7 +7,7 @@
 <url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
 <url url="mailto:polluks@sdf.lonestar.org" name="Stefan A. Haubenthal">,<newline>
 <url url="mailto:greg.king5@verizon.net" name="Greg King">
-<date>2014-09-23
+<date>2015-01-09
 
 <abstract>
 An overview over the Atmos runtime system as it is implemented for the cc65 C
@@ -37,9 +37,11 @@ information.
 
 The standard binary output format generated by the linker for the Atmos target
 is a machine language program with a one-line BASIC stub that jumps to the
-machine-language part through <tt/CALL/.  It has a 24-byte tape header.
-It means that a file can be loaded as a BASIC program, and started with RUN.
-The standard load address is &dollar;501.
+machine-language part through <tt/CALL/.  It has one sacrificial byte attached
+to the end (a bug in the Oric ROM means that BASIC can put a variable on top
+of the last byte that was loaded).  It has a 24-byte tape header.  A file can
+be CLOADed as a BASIC program, and started by typing <tt/RUN/.  The standard
+load address is &dollar;501.
 
 
 
@@ -50,9 +52,9 @@ In the standard setup, cc65-generated programs use the memory from
 available. ROM calls are possible without further precautions.
 
 If your program needs more memory, and it won't use TGI graphics, then you can
-use the ld65 command-line option, <tt/-D __RAMEND__=$B400/, when building the
-program, to "grab" the graphics screen RAM.  Then, nearly 44K of memory is
-available.
+use the ld65 command-line option, <tt/-D __GRAB__=1/, when building the
+program, to include the graphics screen RAM.  Then, nearly 44K of memory
+(&dollar;0501 to &dollar;B400) is available.
 
 Special locations:
 
@@ -100,7 +102,7 @@ structures; accessing the struct fields will access the chip registers.
 <descrip>
 
   <tag><tt/VIA/</tag>
-  Access to the VIA (versatile interface adapter) chip is available via the
+  Access to the VIA (Versatile Interface Adapter) chip is available via the
   <tt/VIA/ variable. The structure behind this variable is explained in <tt/_6522.h/.
 
 </descrip><p>
@@ -157,7 +159,10 @@ No extended memory drivers are currently available for the Atmos.
 <descrip>
 
   <tag><tt/atmos-pase.joy (atmos_pase_joy)/</tag>
-  Supports two standard joysticks connected to the P.A.S.E. interface of the Atmos.
+  Supports two standard joysticks connected to a P.A.S.E. / Altai interface of the Atmos.
+
+  <tag><tt/atmos-ijk.joy (atmos_ijk_joy)/</tag>
+  Supports two standard joysticks connected to an IJK interface of the Atmos.
 
 </descrip><p>
 
@@ -217,10 +222,11 @@ following functions (and a few others):
 They are defined to be FUNCT + a number key.
 
 
-<sect1>Capitals Lock<p>
+<sect1>Capitals lock<p>
 
-The "CAPS Lock" mode is turned off while the program is running.  The previous
-mode (usually turned on) is restored when the program stops.
+The keyboard's "CAPS Lock" mode is turned off while the program is running.
+The previous mode (usually, CAPS Lock turned on [because Oric BASIC keywords
+must be UPPER-case]) is restored when the program stops.
 
 
 <sect1>Passing arguments to the program<p>
@@ -234,7 +240,7 @@ supported directly by BASIC, the following syntax was chosen:
 
 <enum>
 <item>You must turn <tt/CAPS/ lock off (tap CTRL-T) when you want to type
-      lower-case arguments.
+      lower-case arguments (but, <tt/RUN/ and <tt/REM/ must be UPPER-case).
 <item>Arguments are separated by spaces.
 <item>Arguments may be quoted.
 <item>Leading and trailing spaces around an argument are ignored. Spaces within
@@ -245,6 +251,15 @@ supported directly by BASIC, the following syntax was chosen:
 </enum>
 
 
+<sect1>Automatic starting<p>
+
+Usually, a cc65-built program just will sit quietly in memory, after it is
+CLOADed.  It waits for you to start it (by typing BASIC's <tt/RUN/ command).
+But, if you want to create a program that will start running immediately after
+it is loaded, then you can use the linker command-line option
+<tt/-D __AUTORUN__=$C7/.
+
+
 <sect1>Interrupts<p>
 
 The runtime for the Atmos uses routines marked as <tt/.INTERRUPTOR/ for