]> git.sur5r.net Git - cc65/blobdiff - doc/apple2.sgml
Switched Apple II output format to AppleSingle.
[cc65] / doc / apple2.sgml
index 43651c7fae6e20aadc3af84f2e4b81193cd07bb5..eef0eed3d58262010d67c5d81656513312393052 100644 (file)
@@ -34,20 +34,14 @@ more information.
 <sect>Binary format<p>
 
 The standard binary file format generated by the linker for the
-Apple&nbsp;&rsqb;&lsqb; target is a binary program with a 4 byte DOS 3.3 header
-containing the load address and load length. The default load address is
-&dollar;803.
+Apple&nbsp;&rsqb;&lsqb; target is an <url name="AppleSingle" 
+url="http://kaiser-edv.de/documents/AppleSingle_AppleDouble.pdf"> file.
+The default load address is &dollar;803.
 
-<bf/AppleCommander 1.3.5/ or later (available at <url
-url="https://applecommander.github.io/">) includes the option <tt/-cc65/
-that allows to put binary files with a DOS 3.3 header onto disk images
-containing DOS 3.3 as well as ProDOS 8.
-
-For ProDOS 8 system programs the load address is fixed to &dollar;2000 so there
-is no need for a header. Thus the linker configuration
-<ref id="apple-sys-cfg" name="apple2-system.cfg"> for those programs
-omits the DOS 3.3 header. The right AppleCommander option to put system files
-without a header on a ProDOS 8 disk image is <tt/-p/.
+<bf/AppleCommander 1.4.0/ or later (available at <url
+url="https://applecommander.github.io/">) includes the option <tt/-as/ that
+allows to put AppleSingle files onto disk images containing DOS 3.3 as well
+as ProDOS 8.
 
 
 <sect>Memory layout<p>
@@ -121,9 +115,8 @@ Parameters:
   <tag><tt/STARTADDRESS:/ Program start address</tag>
   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
 
-  <tag><tt/__EXEHDR__:/ Executable file header</tag>
-  Default: DOS 3.3 header (address and length). Use <tt/-D __EXEHDR__=0/ to omit
-  the header.
+  <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
+  Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
 
   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
@@ -153,6 +146,9 @@ Parameters:
 
 <descrip>
 
+  <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
+  Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
+
   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
   stack size.
@@ -180,9 +176,8 @@ Parameters:
   <tag><tt/STARTADDRESS:/ Program start address</tag>
   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
 
-  <tag><tt/__EXEHDR__:/ Executable file header</tag>
-  Default: DOS 3.3 header (address and length). Use <tt/-D __EXEHDR__=0/ to omit
-  the header.
+  <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
+  Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
 
   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
@@ -206,7 +201,7 @@ Parameters:
 <sect1><tt/apple2-overlay.cfg/<p>
 
 Configuration for an overlay program with up to nine overlays. The overlay files
-don't include the DOS 3.3 header. See <tt>samples/overlaydemo.c</tt> for more
+don't include the AppleSingle header. See <tt>samples/overlaydemo.c</tt> for more
 information on overlays.
 
 Parameters:
@@ -216,9 +211,8 @@ Parameters:
   <tag><tt/STARTADDRESS:/ Program start address</tag>
   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
 
-  <tag><tt/__EXEHDR__:/ Executable file header</tag>
-  Default: DOS 3.3 header (address and length). Use <tt/-D __EXEHDR__=0/ to omit
-  the header.
+  <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
+  Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
 
   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
@@ -254,9 +248,8 @@ Parameters:
   <tag><tt/STARTADDRESS:/ Program start address</tag>
   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
 
-  <tag><tt/__EXEHDR__:/ Executable file header</tag>
-  Default: No header. Use <tt/-u __EXEHDR__ apple2.lib/ to add a DOS 3.3 header
-  (address and length).
+  <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
+  Default: No. Use <tt/-u __EXEHDR__ apple2.lib/ to add the AppleSingle header.
 
 </descrip><p>
 
@@ -281,7 +274,8 @@ program (i.e. quits to the ProDOS dispatcher).
 
 Using LOADER.SYSTEM is as simple as copying it to the ProDOS 8 directory of the
 program to load under name &lt;program&gt;.SYSTEM as a system program. For
-example the program <tt/MYPROG/ is loaded by <tt/MYPROG.SYSTEM/.
+example the program <tt/MYPROG/ is loaded by <tt/MYPROG.SYSTEM/. The right
+AppleCommander option to put LOADER.SYSTEM on a ProDOS 8 disk image is <tt/-p/.
 
 
 <sect1>Heap<p>