]> git.sur5r.net Git - cc65/blob - doc/index.sgml
Merge pull request #7 from cc65/master
[cc65] / doc / index.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4 <title>cc65 Documentation Overview
5 <author><url url="http://cc65.github.io/doc">
6 <date>2017-02-15
7
8 <sect>Program documentation<p>
9
10 <descrip>
11
12   <tag><htmlurl url="ar65.html" name="ar65.html"></tag>
13   Describes the ar65 archiver.
14
15   <tag><htmlurl url="ca65.html" name="ca65.html"></tag>
16   Describes the ca65 macro assembler.
17
18   <tag><htmlurl url="cc65.html" name="cc65.html"></tag>
19   Describes the cc65 C compiler.
20
21   <tag><htmlurl url="chrcvt65.html" name="chrcvt65.html"></tag>
22   Describes the vector font converter.
23
24   <tag><htmlurl url="cl65.html" name="cl65.html"></tag>
25   Describes the cl65 compile &amp; link utility.
26
27   <tag><htmlurl url="co65.html" name="co65.html"></tag>
28   Describes the co65 object-file converter.
29
30   <tag><htmlurl url="da65.html" name="da65.html"></tag>
31   Describes the da65 6502/65C02 disassembler.
32
33   <tag><htmlurl url="grc65.html" name="grc65.html"></tag>
34   Describes the GEOS resource compiler.
35
36   <tag><htmlurl url="ld65.html" name="ld65.html"></tag>
37   Describes the ld65 linker.
38
39   <tag><htmlurl url="od65.html" name="od65.html"></tag>
40   Describes the od65 object-file analyzer.
41
42   <tag><htmlurl url="sim65.html" name="sim65.html"></tag>
43   Describes the 6502 and 65C02 simulator.
44
45   <tag><htmlurl url="sp65.html" name="sp65.html"></tag>
46   Describes the sprite and bitmap utility.
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="cc65-intern.html" name="cc65-intern.html"></tag>
63   Describes internal details of cc65, such as calling conventions.
64
65   <tag><htmlurl url="using-make.html" name="using-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="tgi.html" name="tgi.html"></tag>
89   Tiny Graphics Interface.
90
91   <tag><htmlurl url="geos.html" name="geos.html"></tag>
92   The GEOSLib manual.
93
94   <tag><htmlurl url="library.html" name="library.html"></tag>
95   An overview over the cc65 runtime and C libraries.
96
97   <tag><htmlurl url="smc.html" name="smc.html"></tag>
98   Describes Christian Kr&uuml;ger's macro package for writing self modifying
99   assembler code.
100
101   <tag><url name="6502 Binary Relocation Format document"
102         url="http://www.6502.org/users/andre/o65/fileformat.html"></tag>
103   Describes the o65 file format that is used for dynamically loadable modules
104   and LUnix programs.
105
106 </descrip>
107
108
109 <sect>Platform-specific information<p>
110
111 <descrip>
112
113   <tag><htmlurl url="apple2.html" name="apple2.html"></tag>
114   Topics specific to the Apple&nbsp;&rsqb;&lsqb;.
115
116   <tag><htmlurl url="apple2enh.html" name="apple2enh.html"></tag>
117   Topics specific to the enhanced&nbsp;Apple&nbsp;//e.
118
119   <tag><htmlurl url="atari.html" name="atari.html"></tag>
120   Topics specific to the Atari 8-bit machines.
121
122   <tag><htmlurl url="atari2600.html" name="atari2600.html"></tag>
123   Topics specific to the Atari 2600 Game Console.
124
125   <tag><htmlurl url="atari5200.html" name="atari5200.html"></tag>
126   Topics specific to the Atari 5200 Game Console.
127
128   <tag><htmlurl url="atmos.html" name="atmos.html"></tag>
129   Topics specific to the Oric Atmos.
130
131   <tag><htmlurl url="c128.html" name="c128.html"></tag>
132   Topics specific to the Commodore 128.
133
134   <tag><htmlurl url="c16.html" name="c16.html"></tag>
135   Topics specific to the Commodore 16/116.
136
137   <tag><htmlurl url="c64.html" name="c64.html"></tag>
138   Topics specific to the Commodore 64.
139
140   <tag><htmlurl url="cbm510.html" name="cbm510.html"></tag>
141   Topics specific to the Commodore 510.
142
143   <tag><htmlurl url="cbm610.html" name="cbm610.html"></tag>
144   Topics specific to the Commodore 610.
145
146   <tag><htmlurl url="creativision.html" name="creativision.html"></tag>
147   Topics specific to the Creativision Console.
148
149   <tag><htmlurl url="gamate.html" name="gamate.html"></tag>
150   Topics specific to the Bit Corporation Gamate Console.
151
152   <tag><htmlurl url="lynx.html" name="lynx.html"></tag>
153   Topics specific to the Atari Lynx Game Console.
154
155   <tag><htmlurl url="nes.html" name="nes.html"></tag>
156   Topics specific to the Nintendo Entertainment System.
157
158   <tag><htmlurl url="osi.html" name="osi.html"></tag>
159   Topics specific to the Ohio Scientific machines.
160
161   <tag><htmlurl url="pce.html" name="pce.html"></tag>
162   Topics specific to NEC PC-Engine (TurboGrafx) Console.
163
164   <tag><htmlurl url="pet.html" name="pet.html"></tag>
165   Topics specific to the Commodore PET machines.
166
167   <tag><htmlurl url="plus4.html" name="plus4.html"></tag>
168   Topics specific to the Commodore Plus/4.
169
170   <tag><htmlurl url="supervision.html" name="supervision.html"></tag>
171   Topics specific to the Watara Supervision Console.
172
173   <tag><htmlurl url="telestrat.html" name="telestrat.html"></tag>
174   Topics specific to the Oric Telestrat.
175
176   <tag><htmlurl url="vic20.html" name="vic20.html"></tag>
177   Topics specific to the Commodore VIC20.
178
179 </descrip>
180
181
182 </article>