1 <!doctype linuxdoc system>
4 <title>cl65 Users Guide
5 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
6 <date>01.08.2000, 27.11.2000, 02.10.2001
9 cl65 is the compile & link utility for cc65, the 6502 C compiler. It was
10 designed as a smart frontend for the C compiler (cc65), the assembler (ca65),
11 the object file converter (co65), and the linker (ld65).
14 <!-- Table of contents -->
17 <!-- Begin the document -->
21 cl65 is a frontend for cc65, ca65, co65 and ld65. While you may not use the
22 full power of the tools when calling them through cl65, most features are
23 available, and the use of cl65 is much simpler.
28 The cl65 compile and link utility may be used to convert, compile, assemble
29 and link files. While the separate tools do just one step, cl65 knows how to
30 build object files from C files (by calling the compiler, then the assembler)
34 ---------------------------------------------------------------------------
35 Usage: cl65 [options] file [...]
37 -c Compile and assemble but don't link
41 -l Create an assembler listing
42 -m name Create a map file
43 -o name Name the output file
44 -r Enable register variables
45 -t sys Set the target system
49 -C name Use linker config file
50 -Cl Make local variables static
51 -D sym[=defn] Define a preprocessor symbol
52 -I dir Set a compiler include directory path
53 -Ln name Create a VICE label file
55 -Oi Optimize code, inline functions
56 -Or Optimize code, honour the register keyword
57 -Os Optimize code, inline known C funtions
58 -S Compile but don't assemble and link
59 -T Include source as comment
60 -V Print the version number
64 --add-source Include source as comment
65 --ansi Strict ANSI mode
66 --asm-include-dir dir Set an assembler include directory
67 --bss-label name Define and export a BSS segment label
68 --bss-name seg Set the name of the BSS segment
69 --check-stack Generate stack overflow checks
70 --code-label name Define and export a CODE segment label
71 --code-name seg Set the name of the CODE segment
72 --codesize x Accept larger code by factor x
73 --cpu type Set cpu type
74 --create-dep Create a make dependency file
75 --data-label name Define and export a DATA segment label
76 --data-name seg Set the name of the DATA segment
78 --debug-info Add debug info
79 --feature name Set an emulation feature
80 --help Help (this text)
81 --include-dir dir Set a compiler include directory path
82 --listing Create an assembler listing
83 --mapfile name Create a map file
84 --module Link as a module
85 --module-id id Specify a module id for the linker
86 --o65-model model Override the o65 model
87 --register-space b Set space available for register variables
88 --register-vars Enable register variables
89 --rodata-name seg Set the name of the RODATA segment
90 --signed-chars Default characters are signed
91 --start-addr addr Set the default start address
92 --static-locals Make local variables static
93 --target sys Set the target system
94 --version Print the version number
95 --verbose Verbose mode
96 --zeropage-label name Define and export a ZEROPAGE segment label
97 --zeropage-name seg Set the name of the ZEROPAGE segment
98 ---------------------------------------------------------------------------
101 Most of the options have the same meaning than the corresponding compiler,
102 assembler or linker option. See the documentation for these tools for an
103 explanation. If an option is available for more than one of the tools, it
104 is set for all tools, where it is available. One example for this is <tt/-v/:
105 The compiler, the assembler and the linker are all called with the <tt/-v/
108 There are a few remaining options that control the behaviour of cl65:
112 <tag><tt>-S</tt></tag>
114 This option forces cl65 to stop after the assembly step. This means that
115 C files are translated into assembler files, but nothing more is done.
116 Assembler files, object files and libraries given on the command line
120 <tag><tt>-c</tt></tag>
122 This options forces cl65 to stop after the assembly step. This means
123 that C and assembler files given on the command line are translated into
124 object files, but there is no link step, and object files and libraries
125 given on the command line are ignored.
128 <tag><tt>-o name</tt></tag>
130 The -o option is used for the target name in the final step. This causes
131 problems, if the linker will not be called, and there are several input
132 files on the command line. In this case, the name given with -o will be
133 used for all of them, which makes the option pretty useless. You
134 shouldn't use -o when more than one output file is created.
137 <tag><tt>-t sys, --target sys</tt></tag>
139 The default for this option is different from the compiler and linker in the
140 case that the option is missing: While the other tools (compiler, assembler
141 and linker) will use the "none" system settings by default, cl65 will use
142 the C64 as a target system by default. This was choosen since most people
143 seem to use cc65 to develop for the C64.
151 Since cl65 was created to simplify the use of the cc65 development
152 package, it tries to be smart about several things.
156 <item> If you don't give a target system on the command line, cl65
159 <item> When linking, cl65 will supply the names of the startup file and
160 library for the target system to the linker, so you don't have to do
163 <item> If the final step is the linker, and the name of the output file was
164 not explicitly given, cl65 will use the name of the first input file
165 without the extension, provided that the name of this file has an
166 extension. So you don't need to name the executable name in most
167 cases, just give the name of your "main" file as first input file.
170 The type of an input file is derived from its extension:
173 <item>C files: <tt/.c/
174 <item>Assembler files: <tt/.s/, <tt/.asm/, <tt/.a65/
175 <item>Object files: <tt/.o/ <tt/.obj/
176 <item>Libraries: <tt/.a/, <tt/.lib/
177 <item>GEOS resource files: <tt/.grc/
178 <item>o65 files: <tt/.o65/, <tt/.emd/, <tt/.joy/, <tt/.tgi/
181 Please note that the program cannot handle input files with unknown file
187 The morse trainer software, which consists of one C file (morse.c) and one
188 assembler file (irq.s) will need the following separate steps to compile
189 into an executable named morse:
192 cc65 -g -Oi -t c64 morse.c
195 ld65 -t c64 -o morse c64.o morse.o irq.o c64.lib
198 When using cl65, this is simplified to
201 cl65 -g -Oi morse.c irq.s
204 As a general rule, you may use cl65 instead of cc65 at most times,
205 especially in makefiles to build object files directly from C files. Use
216 <sect>Bugs/Feedback<p>
218 If you have problems using the utility, if you find any bugs, or if you're
219 doing something interesting with it, I would be glad to hear from you. Feel
220 free to contact me by email (<htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">).
226 cl65 (and all cc65 binutils) are (C) Copyright 1998-2000 Ullrich von
227 Bassewitz. For usage of the binaries and/or sources the following
230 This software is provided 'as-is', without any expressed or implied
231 warranty. In no event will the authors be held liable for any damages
232 arising from the use of this software.
234 Permission is granted to anyone to use this software for any purpose,
235 including commercial applications, and to alter it and redistribute it
236 freely, subject to the following restrictions:
239 <item> The origin of this software must not be misrepresented; you must not
240 claim that you wrote the original software. If you use this software
241 in a product, an acknowledgment in the product documentation would be
242 appreciated but is not required.
243 <item> Altered source versions must be plainly marked as such, and must not
244 be misrepresented as being the original software.
245 <item> This notice may not be removed or altered from any source