cc65/doc/index.sgml

<!doctype linuxdoc system>

<article>
<title>cc65 Documentation Overview
<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
<date>2005-8-6

<abstract>
Main documentation page, contains links to other available stuff.
</abstract>

<sect>Program documentation<p>

<descrip>

  <tag><htmlurl url="ar65.html" name="ar65.html"></tag>
  Describes the ar65 archiver.

  <tag><htmlurl url="ca65.html" name="ca65.html"></tag>
  Describes the ca65 macro assembler.

  <tag><htmlurl url="ca65html.html" name="ca65html.html"></tag>
  Describes the ca65html assembler-source-to-HTML converter.

  <tag><htmlurl url="cc65.html" name="cc65.html"></tag>
  Describes the cc65 C compiler.

  <tag><htmlurl url="cl65.html" name="cl65.html"></tag>
  Describes the cl65 compile &amp; link utility.

  <tag><htmlurl url="co65.html" name="co65.html"></tag>
  Describes the co65 object-file converter.

  <tag><htmlurl url="da65.html" name="da65.html"></tag>
  Describes the da65 6502/65C02 disassembler.

  <tag><htmlurl url="grc.html" name="grc.html"></tag>
  Describes the GEOS resource compiler (grc).

  <tag><htmlurl url="ld65.html" name="ld65.html"></tag>
  Describes the ld65 linker.

<!--
  <tag><htmlurl url="od65.html" name="od65.html"></tag>
  Describes the od65 object-file analyzer.
-->

</descrip>


<sect>Usage<p>

<descrip>

  <tag><htmlurl url="intro.html" name="intro.html"></tag>
  Describes the use of the tools, by building a short &dquot;hello world&dquot;
  example.

  <tag><htmlurl url="coding.html" name="coding.html"></tag>
  Contains hints on creating the most effective code with cc65.

  <tag><htmlurl url="compile.txt" name="compile.txt"></tag>
  How to compile cc65 and the support tools.

  <tag><htmlurl url="make.html" name="make.html"></tag>
  Build programs, using the GNU Make utility.

  <tag><htmlurl url="customizing.html" name="customizing.html"></tag>
  How to use the cc65 toolset for a custom hardware platform (a target system
  not currently supported by the cc65 library set).

  <tag><htmlurl url="debugging.html" name="debugging.html"></tag>
  Debug programs, using the VICE emulator.

</descrip>


<sect>Library information and other references<p>

<descrip>

  <tag><htmlurl url="funcref.html" name="funcref.html"></tag>
  A (currently incomplete) function reference.

  <tag><htmlurl url="dio.html" name="dio.html"></tag>
  Low-level disk I/O API.

  <tag><htmlurl url="geos.html" name="geos.html"></tag>
  The GEOSLib manual.

  <tag><htmlurl url="internal.txt" name="internal.txt"></tag>
  A somewhat older text describing several cc65 internals.

  <tag><htmlurl url="library.html" name="library.html"></tag>
  An overview over the cc65 runtime and C libraries.

  <tag><url name="6502 Binary Relocation Format document"
        url="http://www.6502.org/users/andre/o65/fileformat.html"></tag>
  Describes the o65 file format that is used for dynamically loadable modules
  and LUnix programs.

</descrip>


<sect>Platform-specific information<p>

<descrip>

  <tag><htmlurl url="apple2.html" name="apple2.html"></tag>
  Topics specific to the Apple&nbsp;&rsqb;&lsqb;.

  <tag><htmlurl url="apple2enh.html" name="apple2enh.html"></tag>
  Topics specific to the enhanced&nbsp;Apple&nbsp;//e.

  <tag><htmlurl url="atari.html" name="atari.html"></tag>
  Topics specific to the Atari 8-bit machines.

  <tag><htmlurl url="atmos.html" name="atmos.html"></tag>
  Topics specific to the Oric Atmos.

  <tag><htmlurl url="c128.html" name="c128.html"></tag>
  Topics specific to the Commodore 128.

  <tag><htmlurl url="c16.html" name="c16.html"></tag>
  Topics specific to the Commodore 16/116.

  <tag><htmlurl url="c64.html" name="c64.html"></tag>
  Topics specific to the Commodore 64.

  <tag><htmlurl url="cbm510.html" name="cbm510.html"></tag>
  Topics specific to the Commodore 510.

  <tag><htmlurl url="cbm610.html" name="cbm610.html"></tag>
  Topics specific to the Commodore 610.

  <tag><htmlurl url="lynx.html" name="lynx.html"></tag>
  Topics specific to the Atari Lynx Game Console.

  <tag><htmlurl url="nes.html" name="nes.html"></tag>
  Topics specific to the Nintendo Entertainment System.

  <tag><htmlurl url="pet.html" name="pet.html"></tag>
  Topics specific to the Commodore PET machines.

  <tag><htmlurl url="plus4.html" name="plus4.html"></tag>
  Topics specific to the Commodore Plus/4.

  <tag><htmlurl url="supervision.html" name="supervision.html"></tag>
  Topics specific to the Supervision Console.

  <tag><htmlurl url="vic20.html" name="vic20.html"></tag>
  Topics specific to the Commodore VIC20.

</descrip>


<sect>Miscellaneous<p>

<descrip>

  <tag><htmlurl url="newvers.txt" name="newvers.txt"></tag>
  Somewhat outdated.  Lists the differences between my cc65 releases
  and the original Atari version that was created by J. R. Dunning.

  <tag><htmlurl url="BUGS" name="BUGS"></tag>
  Known cc65 bugs.

  <tag><htmlurl url="CREDITS" name="CREDITS"></tag>
  Here is who helped with the compiler and other tools.

</descrip>

</article>