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="grc65.html" name="grc65.html"></tag>
  38   Describes the GEOS resource compiler (grc65).
  39
  40   <tag><htmlurl url="ld65.html" name="ld65.html"></tag>
  41   Describes the ld65 linker.
  42
  43   <tag><htmlurl url="od65.html" name="od65.html"></tag>
  44   Describes the od65 object-file analyzer.
  45
  46   <tag><htmlurl url="sp65.html" name="sp65.html"></tag>
  47   Describes the sprite and bitmap utility.
  48
  49 </descrip>
  50
  51
  52 <sect>Usage<p>
  53
  54 <descrip>
  55
  56   <tag><htmlurl url="intro.html" name="intro.html"></tag>
  57   Describes the use of the tools, by building a short &dquot;hello world&dquot;
  58   example.
  59
  60   <tag><htmlurl url="coding.html" name="coding.html"></tag>
  61   Contains hints on creating the most effective code with cc65.
  62
  63   <tag><htmlurl url="compile.txt" name="compile.txt"></tag>
  64   How to compile cc65 and the support tools.
  65
  66   <tag><htmlurl url="using-make.html" name="using-make.html"></tag>
  67   Build programs, using the GNU Make utility.
  68
  69   <tag><htmlurl url="customizing.html" name="customizing.html"></tag>
  70   How to use the cc65 toolset for a custom hardware platform (a target system
  71   not currently supported by the cc65 library set).
  72
  73   <tag><htmlurl url="debugging.html" name="debugging.html"></tag>
  74   Debug programs, using the VICE emulator.
  75
  76 </descrip>
  77
  78
  79 <sect>Library information and other references<p>
  80
  81 <descrip>
  82
  83   <tag><htmlurl url="funcref.html" name="funcref.html"></tag>
  84   A (currently incomplete) function reference.
  85
  86   <tag><htmlurl url="dio.html" name="dio.html"></tag>
  87   Low-level disk I/O API.
  88
  89   <tag><htmlurl url="geos.html" name="geos.html"></tag>
  90   The GEOSLib manual.
  91
  92   <tag><htmlurl url="internal.txt" name="internal.txt"></tag>
  93   A somewhat older text describing several cc65 internals.
  94
  95   <tag><htmlurl url="library.html" name="library.html"></tag>
  96   An overview over the cc65 runtime and C libraries.
  97
  98   <tag><htmlurl url="smc.html" name="smc.html"></tag>
  99   Describes Christian Kr&uuml;gers macro package for writing self modifying
 100   assembler code.
 101
 102   <tag><url name="6502 Binary Relocation Format document"
 103         url="http://www.6502.org/users/andre/o65/fileformat.html"></tag>
 104   Describes the o65 file format that is used for dynamically loadable modules
 105   and LUnix programs.
 106
 107 </descrip>
 108
 109
 110 <sect>Platform-specific information<p>
 111
 112 <descrip>
 113
 114   <tag><htmlurl url="apple2.html" name="apple2.html"></tag>
 115   Topics specific to the Apple&nbsp;&rsqb;&lsqb;.
 116
 117   <tag><htmlurl url="apple2enh.html" name="apple2enh.html"></tag>
 118   Topics specific to the enhanced&nbsp;Apple&nbsp;//e.
 119
 120   <tag><htmlurl url="atari.html" name="atari.html"></tag>
 121   Topics specific to the Atari 8-bit machines.
 122
 123   <tag><htmlurl url="atmos.html" name="atmos.html"></tag>
 124   Topics specific to the Oric Atmos.
 125
 126   <tag><htmlurl url="c128.html" name="c128.html"></tag>
 127   Topics specific to the Commodore 128.
 128
 129   <tag><htmlurl url="c16.html" name="c16.html"></tag>
 130   Topics specific to the Commodore 16/116.
 131
 132   <tag><htmlurl url="c64.html" name="c64.html"></tag>
 133   Topics specific to the Commodore 64.
 134
 135   <tag><htmlurl url="cbm510.html" name="cbm510.html"></tag>
 136   Topics specific to the Commodore 510.
 137
 138   <tag><htmlurl url="cbm610.html" name="cbm610.html"></tag>
 139   Topics specific to the Commodore 610.
 140
 141   <tag><htmlurl url="lynx.html" name="lynx.html"></tag>
 142   Topics specific to the Atari Lynx Game Console.
 143
 144   <tag><htmlurl url="nes.html" name="nes.html"></tag>
 145   Topics specific to the Nintendo Entertainment System.
 146
 147   <tag><htmlurl url="pet.html" name="pet.html"></tag>
 148   Topics specific to the Commodore PET machines.
 149
 150   <tag><htmlurl url="plus4.html" name="plus4.html"></tag>
 151   Topics specific to the Commodore Plus/4.
 152
 153   <tag><htmlurl url="supervision.html" name="supervision.html"></tag>
 154   Topics specific to the Supervision Console.
 155
 156   <tag><htmlurl url="vic20.html" name="vic20.html"></tag>
 157   Topics specific to the Commodore VIC20.
 158
 159 </descrip>
 160
 161
 162 <sect>Miscellaneous<p>
 163
 164 <descrip>
 165
 166   <tag><htmlurl url="newvers.txt" name="newvers.txt"></tag>
 167   Somewhat outdated.  Lists the differences between my cc65 releases
 168   and the original Atari version that was created by J. R. Dunning.
 169
 170   <tag><htmlurl url="BUGS" name="BUGS"></tag>
 171   Known cc65 bugs.
 172
 173   <tag><htmlurl url="CREDITS" name="CREDITS"></tag>
 174   Here is who helped with the compiler and other tools.
 175
 176 </descrip>
 177
 178 </article>
 179