]> git.sur5r.net Git - cc65/blob - doc/index.sgml
aecfb7de992f9f12e30270f264f606983818a5bc
[cc65] / doc / index.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4 <title>cc65 Documentation Overview
5 <author><url url="https://cc65.github.io/doc">
6
7 <sect>Program documentation<p>
8
9 <descrip>
10
11   <tag><htmlurl url="ar65.html" name="ar65.html"></tag>
12   Describes the ar65 archiver.
13
14   <tag><htmlurl url="ca65.html" name="ca65.html"></tag>
15   Describes the ca65 macro assembler.
16
17   <tag><htmlurl url="cc65.html" name="cc65.html"></tag>
18   Describes the cc65 C compiler.
19
20   <tag><htmlurl url="chrcvt65.html" name="chrcvt65.html"></tag>
21   Describes the vector font converter.
22
23   <tag><htmlurl url="cl65.html" name="cl65.html"></tag>
24   Describes the cl65 compile &amp; link utility.
25
26   <tag><htmlurl url="co65.html" name="co65.html"></tag>
27   Describes the co65 object-file converter.
28
29   <tag><htmlurl url="da65.html" name="da65.html"></tag>
30   Describes the da65 6502/65C02 disassembler.
31
32   <tag><htmlurl url="grc65.html" name="grc65.html"></tag>
33   Describes the GEOS resource compiler.
34
35   <tag><htmlurl url="ld65.html" name="ld65.html"></tag>
36   Describes the ld65 linker.
37
38   <tag><htmlurl url="od65.html" name="od65.html"></tag>
39   Describes the od65 object-file analyzer.
40
41   <tag><htmlurl url="sim65.html" name="sim65.html"></tag>
42   Describes the 6502 and 65C02 simulator.
43
44   <tag><htmlurl url="sp65.html" name="sp65.html"></tag>
45   Describes the sprite and bitmap utility.
46
47 </descrip>
48
49
50 <sect>Usage<p>
51
52 <descrip>
53
54   <tag><htmlurl url="intro.html" name="intro.html"></tag>
55   Describes the use of the tools, by building a short &dquot;hello world&dquot;
56   example.
57
58   <tag><htmlurl url="coding.html" name="coding.html"></tag>
59   Contains hints on creating the most effective code with cc65.
60
61   <tag><htmlurl url="cc65-intern.html" name="cc65-intern.html"></tag>
62   Describes internal details of cc65, such as calling conventions.
63
64   <tag><htmlurl url="using-make.html" name="using-make.html"></tag>
65   Build programs, using the GNU Make utility.
66
67   <tag><htmlurl url="customizing.html" name="customizing.html"></tag>
68   How to use the cc65 toolset for a custom hardware platform (a target system
69   not currently supported by the cc65 library set).
70
71   <tag><htmlurl url="debugging.html" name="debugging.html"></tag>
72   Debug programs, using the VICE emulator.
73
74 </descrip>
75
76
77 <sect>Library information and other references<p>
78
79 <descrip>
80
81   <tag><htmlurl url="funcref.html" name="funcref.html"></tag>
82   A (currently incomplete) function reference.
83
84   <tag><htmlurl url="dio.html" name="dio.html"></tag>
85   Low-level disk I/O API.
86
87   <tag><htmlurl url="tgi.html" name="tgi.html"></tag>
88   Tiny Graphics Interface.
89
90   <tag><htmlurl url="geos.html" name="geos.html"></tag>
91   The GEOSLib manual.
92
93   <tag><htmlurl url="library.html" name="library.html"></tag>
94   An overview over the cc65 runtime and C libraries.
95
96   <tag><htmlurl url="smc.html" name="smc.html"></tag>
97   Describes Christian Kr&uuml;ger's macro package for writing self modifying
98   assembler code.
99
100   <tag><url name="6502 Binary Relocation Format document"
101         url="http://www.6502.org/users/andre/o65/fileformat.html"></tag>
102   Describes the o65 file format that is used for dynamically loadable modules
103   and LUnix programs.
104
105 </descrip>
106
107
108 <sect>Platform-specific information<p>
109
110 <descrip>
111
112   <tag><htmlurl url="apple2.html" name="apple2.html"></tag>
113   Topics specific to the Apple&nbsp;&rsqb;&lsqb;.
114
115   <tag><htmlurl url="apple2enh.html" name="apple2enh.html"></tag>
116   Topics specific to the enhanced&nbsp;Apple&nbsp;//e.
117
118   <tag><htmlurl url="atari.html" name="atari.html"></tag>
119   Topics specific to the Atari 8-bit machines.
120
121   <tag><htmlurl url="atari2600.html" name="atari2600.html"></tag>
122   Topics specific to the Atari 2600 Game Console.
123
124   <tag><htmlurl url="atari5200.html" name="atari5200.html"></tag>
125   Topics specific to the Atari 5200 Game Console.
126
127   <tag><htmlurl url="atmos.html" name="atmos.html"></tag>
128   Topics specific to the Oric Atmos.
129
130   <tag><htmlurl url="c128.html" name="c128.html"></tag>
131   Topics specific to the Commodore 128.
132
133   <tag><htmlurl url="c16.html" name="c16.html"></tag>
134   Topics specific to the Commodore 16/116.
135
136   <tag><htmlurl url="c64.html" name="c64.html"></tag>
137   Topics specific to the Commodore 64.
138
139   <tag><htmlurl url="cbm510.html" name="cbm510.html"></tag>
140   Topics specific to the Commodore 510.
141
142   <tag><htmlurl url="cbm610.html" name="cbm610.html"></tag>
143   Topics specific to the Commodore 610.
144
145   <tag><htmlurl url="creativision.html" name="creativision.html"></tag>
146   Topics specific to the Creativision Console.
147
148   <tag><htmlurl url="gamate.html" name="gamate.html"></tag>
149   Topics specific to the Bit Corporation Gamate Console.
150
151   <tag><htmlurl url="lynx.html" name="lynx.html"></tag>
152   Topics specific to the Atari Lynx Game Console.
153
154   <tag><htmlurl url="nes.html" name="nes.html"></tag>
155   Topics specific to the Nintendo Entertainment System.
156
157   <tag><htmlurl url="osi.html" name="osi.html"></tag>
158   Topics specific to the Ohio Scientific machines.
159
160   <tag><htmlurl url="pce.html" name="pce.html"></tag>
161   Topics specific to the NEC PC-Engine (TurboGrafx-16) Console.
162
163   <tag><htmlurl url="pet.html" name="pet.html"></tag>
164   Topics specific to the Commodore PET machines.
165
166   <tag><htmlurl url="plus4.html" name="plus4.html"></tag>
167   Topics specific to the Commodore Plus/4.
168
169   <tag><htmlurl url="supervision.html" name="supervision.html"></tag>
170   Topics specific to the Watara Supervision Console.
171
172   <tag><htmlurl url="telestrat.html" name="telestrat.html"></tag>
173   Topics specific to the Oric Telestrat.
174
175   <tag><htmlurl url="vic20.html" name="vic20.html"></tag>
176   Topics specific to the Commodore VIC20.
177
178 </descrip>
179
180
181 </article>