git.sur5r.net Git - cc65/blob - doc/index.sgml

   1 <!doctype linuxdoc system>
   2
   3 <article>
   4 <title>cc65 Documentation Overview
   5 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
   6 <date>2005-8-6
   7
   8 <abstract>
   9 Main documentation page, contains links to other available stuff.
  10 </abstract>
  11
  12 <sect>Program documentation<p>
  13
  14 <descrip>
  15
  16   <tag><htmlurl url="ar65.html" name="ar65.html"></tag>
  17   Describes the ar65 archiver.
  18
  19   <tag><htmlurl url="ca65.html" name="ca65.html"></tag>
  20   Describes the ca65 macro assembler.
  21
  22   <tag><htmlurl url="ca65html.html" name="ca65html.html"></tag>
  23   Describes the ca65html assembler-source-to-HTML converter.
  24
  25   <tag><htmlurl url="cc65.html" name="cc65.html"></tag>
  26   Describes the cc65 C compiler.
  27
  28   <tag><htmlurl url="cl65.html" name="cl65.html"></tag>
  29   Describes the cl65 compile &amp; link utility.
  30
  31   <tag><htmlurl url="co65.html" name="co65.html"></tag>
  32   Describes the co65 object-file converter.
  33
  34   <tag><htmlurl url="da65.html" name="da65.html"></tag>
  35   Describes the da65 6502/65C02 disassembler.
  36
  37   <tag><htmlurl url="grc.html" name="grc.html"></tag>
  38   Describes the GEOS resource compiler (grc).
  39
  40   <tag><htmlurl url="ld65.html" name="ld65.html"></tag>
  41   Describes the ld65 linker.
  42
  43 <!--
  44   <tag><htmlurl url="od65.html" name="od65.html"></tag>
  45   Describes the od65 object-file analyzer.
  46 -->
  47
  48 </descrip>
  49
  50
  51 <sect>Usage<p>
  52
  53 <descrip>
  54
  55   <tag><htmlurl url="intro.html" name="intro.html"></tag>
  56   Describes the use of the tools, by building a short &dquot;hello world&dquot;
  57   example.
  58
  59   <tag><htmlurl url="coding.html" name="coding.html"></tag>
  60   Contains hints on creating the most effective code with cc65.
  61
  62   <tag><htmlurl url="compile.txt" name="compile.txt"></tag>
  63   How to compile cc65 and the support tools.
  64
  65   <tag><htmlurl url="make.html" name="make.html"></tag>
  66   Build programs, using the GNU Make utility.
  67
  68   <tag><htmlurl url="customizing.html" name="customizing.html"></tag>
  69   How to use the cc65 toolset for a custom hardware platform (a target system
  70   not currently supported by the cc65 library set).
  71
  72   <tag><htmlurl url="debugging.html" name="debugging.html"></tag>
  73   Debug programs, using the VICE emulator.
  74
  75 </descrip>
  76
  77
  78 <sect>Library information and other references<p>
  79
  80 <descrip>
  81
  82   <tag><htmlurl url="funcref.html" name="funcref.html"></tag>
  83   A (currently incomplete) function reference.
  84
  85   <tag><htmlurl url="dio.html" name="dio.html"></tag>
  86   Low-level disk I/O API.
  87
  88   <tag><htmlurl url="geos.html" name="geos.html"></tag>
  89   The GEOSLib manual.
  90
  91   <tag><htmlurl url="internal.txt" name="internal.txt"></tag>
  92   A somewhat older text describing several cc65 internals.
  93
  94   <tag><htmlurl url="library.html" name="library.html"></tag>
  95   An overview over the cc65 runtime and C libraries.
  96
  97   <tag><url name="6502 Binary Relocation Format document"
  98         url="http://www.6502.org/users/andre/o65/fileformat.html"></tag>
  99   Describes the o65 file format that is used for dynamically loadable modules
 100   and LUnix programs.
 101
 102 </descrip>
 103
 104
 105 <sect>Platform-specific information<p>
 106
 107 <descrip>
 108
 109   <tag><htmlurl url="apple2.html" name="apple2.html"></tag>
 110   Topics specific to the Apple&nbsp;&rsqb;&lsqb;.
 111
 112   <tag><htmlurl url="apple2enh.html" name="apple2enh.html"></tag>
 113   Topics specific to the enhanced&nbsp;Apple&nbsp;//e.
 114
 115   <tag><htmlurl url="atari.html" name="atari.html"></tag>
 116   Topics specific to the Atari 8-bit machines.
 117
 118   <tag><htmlurl url="atmos.html" name="atmos.html"></tag>
 119   Topics specific to the Oric Atmos.
 120
 121   <tag><htmlurl url="c128.html" name="c128.html"></tag>
 122   Topics specific to the Commodore 128.
 123
 124   <tag><htmlurl url="c16.html" name="c16.html"></tag>
 125   Topics specific to the Commodore 16/116.
 126
 127   <tag><htmlurl url="c64.html" name="c64.html"></tag>
 128   Topics specific to the Commodore 64.
 129
 130   <tag><htmlurl url="cbm510.html" name="cbm510.html"></tag>
 131   Topics specific to the Commodore 510.
 132
 133   <tag><htmlurl url="cbm610.html" name="cbm610.html"></tag>
 134   Topics specific to the Commodore 610.
 135
 136   <tag><htmlurl url="lynx.html" name="lynx.html"></tag>
 137   Topics specific to the Atari Lynx Game Console.
 138
 139   <tag><htmlurl url="nes.html" name="nes.html"></tag>
 140   Topics specific to the Nintendo Entertainment System.
 141
 142   <tag><htmlurl url="pet.html" name="pet.html"></tag>
 143   Topics specific to the Commodore PET machines.
 144
 145   <tag><htmlurl url="plus4.html" name="plus4.html"></tag>
 146   Topics specific to the Commodore Plus/4.
 147
 148   <tag><htmlurl url="supervision.html" name="supervision.html"></tag>
 149   Topics specific to the Supervision Console.
 150
 151   <tag><htmlurl url="vic20.html" name="vic20.html"></tag>
 152   Topics specific to the Commodore VIC20.
 153
 154 </descrip>
 155
 156
 157 <sect>Miscellaneous<p>
 158
 159 <descrip>
 160
 161   <tag><htmlurl url="newvers.txt" name="newvers.txt"></tag>
 162   Somewhat outdated.  Lists the differences between my cc65 releases
 163   and the original Atari version that was created by J. R. Dunning.
 164
 165   <tag><htmlurl url="BUGS" name="BUGS"></tag>
 166   Known cc65 bugs.
 167
 168   <tag><htmlurl url="CREDITS" name="CREDITS"></tag>
 169   Here is who helped with the compiler and other tools.
 170
 171 </descrip>
 172
 173 </article>
 174