]> git.sur5r.net Git - cc65/blob - doc/index.sgml
Document the symbols section and the new -D and --define options
[cc65] / 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>03.12.2000
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 & 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.txt" name="grc.txt"></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 </descrip>
44
45
46 <sect>Usage<p>
47
48 <descrip>
49
50   <tag><htmlurl url="intro.html" name="intro.html"></tag>
51   Describes the use of the tools by a short "hello world" example.
52
53   <tag><htmlurl url="coding.html" name="coding.html"></tag>
54   Containes hints on creating the most effective code with cc65.
55
56   <tag><htmlurl url="compile.txt" name="compile.txt"></tag>
57   How to compile cc65 and the support tools.
58
59   <tag><htmlurl url="debugging.html" name="debugging.html"></tag>
60   Debug programs using the VICE emulator.
61
62 </descrip>
63
64
65 <sect>Library information and other references<p>
66
67 <descrip>
68
69   <tag><htmlurl url="funcref.html" name="funcref.html"></tag>
70   A (currently incomplete) function reference.
71
72   <tag><htmlurl url="dio.html" name="dio.html"></tag>
73   Low level disk I/O API.
74
75   <tag><htmlurl url="geos.html" name="geos.html"></tag>
76   The GEOSLib manual.
77
78   <tag><htmlurl url="internal.txt" name="internal.txt"></tag>
79   A somewhat older text describing several cc65 internals.
80
81   <tag><htmlurl url="library.html" name="library.html"></tag>
82   An overview over the cc65 runtime and C libraries.
83
84 </descrip>
85
86
87 <sect>Platform specific information<p>
88
89 <descrip>
90
91   <tag><htmlurl url="apple2.html" name="apple2.html"></tag>
92   Topics specific to the Apple2&nbsp;][.
93
94   <tag><htmlurl url="atari.html" name="atari.html"></tag>
95   Topics specific to the Atari 8 bit machines.
96
97   <tag><htmlurl url="atmos.html" name="atmos.html"></tag>
98   Topics specific to the Oric Atmos.
99
100   <tag><htmlurl url="c128.html" name="c128.html"></tag>
101   Topics specific to the Commodore 128.
102
103   <tag><htmlurl url="c16.html" name="c16.html"></tag>
104   Topics specific to the Commodore 16/116.
105
106   <tag><htmlurl url="c64.html" name="c64.html"></tag>
107   Topics specific to the Commodore 64.
108
109   <tag><htmlurl url="cbm610.html" name="cbm610.html"></tag>
110   Topics specific to the Commodore 610.
111
112   <tag><htmlurl url="lynx.html" name="lynx.html"></tag>
113   Topics specific to the Atari Lynx Game Console.
114
115   <tag><htmlurl url="nes.html" name="nes.html"></tag>
116   Topics specific to the Nintendo Entertainment System.
117
118   <tag><htmlurl url="pet.html" name="pet.html"></tag>
119   Topics specific to the Commodore PET machines.
120
121   <tag><htmlurl url="plus4.html" name="plus4.html"></tag>
122   Topics specific to the Commodore Plus/4.
123
124   <tag><htmlurl url="vic20.html" name="vic20.html"></tag>
125   Topics specific to the Commodore VIC20.
126
127 </descrip>
128
129
130 <sect>Miscellaneous<p>
131
132 <descrip>
133
134   <tag><htmlurl url="newvers.txt" name="newvers.txt"></tag>
135   Somewhat outdated. Lists the differences between the current cc65 release
136   and the original atari version created by J.R Dunning.
137
138   <tag><htmlurl url="BUGS" name="BUGS"></tag>
139   Known compiler bugs.
140
141   <tag><htmlurl url="CREDITS" name="CREDITS"></tag>
142   Who helped with the compiler and tools?
143
144 </descrip>
145
146 </article>
147