1 <!doctype linuxdoc system>
4 <title>cl65 Users Guide
5 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">
9 cl65 is the compile & link utility for cc65, the 6502 C compiler.
12 <!-- Table of contents -->
15 <!-- Begin the document -->
19 cl65 is a frontend for cc65, ca65 and ld65. While you may not use the full
20 power of the tools when calling them through cl65, most features are
21 available, and the use of cl65 is much simpler.
26 The cl65 compile and link utility may be used to compile, assemble and
27 link files. While the separate tools do just one step, cl65 knows how to
28 build object files from C files (by calling the compiler, then the
29 assembler) and other things.
32 ---------------------------------------------------------------------------
33 Usage: cl65 [options] file
36 -C name Use linker config file
37 -Cl Make local variables static
38 -D sym[=defn] Define a preprocessor symbol
39 -I dir Set a compiler include directory path
40 -Ln name Create a VICE label file
42 -Oi Optimize code, inline functions
43 -Or Optimize code, honour the register keyword
44 -Os Optimize code, inline known C funtions
45 -S Compile but don't assemble and link
46 -V Print the version number
48 -c Compiler and assemble but don't link
52 -m name Create a map file
53 -o name Name the output file
54 -t sys Set the target system
59 --ansi Strict ANSI mode
60 --asm-include-dir dir Set an assembler include directory
62 --debug-info Add debug info
63 --feature name Set an emulation feature
64 --help Help (this text)
65 --include-dir dir Set a compiler include directory path
66 --mapfile name Create a map file
67 --target sys Set the target system
68 --version Print the version number
69 --verbose Verbose mode
70 ---------------------------------------------------------------------------
73 Most of the options have the same meaning than the corresponding compiler,
74 assembler or linker option. See the documentation for these tools for an
75 explanation. If an option is available for more than one of the tools, it
76 is set for all tools, where it is available. One example for this is <tt/-v/:
77 The compiler, the assembler and the linker are all called with the <tt/-v/
80 There are a few remaining options that control the behaviour of cl65:
84 <tag><tt>-S</tt></tag>
86 This option forces cl65 to stop after the assembly step. This means that
87 C files are translated into assembler files, but nothing more is done.
88 Assembler files, object files and libraries given on the command line
92 <tag><tt>-c</tt></tag>
94 This options forces cl65 to stop after the assembly step. This means
95 that C and assembler files given on the command line are translated into
96 object files, but there is no link step, and object files and libraries
97 given on the command line are ignored.
100 <tag><tt>-o name</tt></tag>
102 The -o option is used for the target name in the final step. This causes
103 problems, if the linker will not be called, and there are several input
104 files on the command line. In this case, the name given with -o will be
105 used for all of them, which makes the option pretty useless. You
106 shouldn't use -o when more than one output file is created.
109 <tag><tt>-t sys, --target sys</tt></tag>
111 The default for this option is different from the compiler and linker in the
112 case that the option is missing: While the other tools (compiler, assembler
113 and linker) will use the "none" system settings by default, cl65 will use
114 the C64 as a target system by default. This was choosen since most people
115 seem to use cc65 to develop for the C64.
123 Since cl65 was created to simplify the use of the cc65 development
124 package, it tries to be smart about several things.
128 <item> If you don't give a target system on the command line, cl65
131 <item> When linking, cl65 will supply the names of the startup file and
132 library for the target system to the linker, so you don't have to do
135 <item> If the final step is the linker, and the name of the output file was
136 not explicitly given, cl65 will use the name of the first input file
137 without the extension, provided that the name of this file has an
138 extension. So you don't need to name the executable name in most
139 cases, just give the name of your "main" file as first input file.
145 The morse trainer software, which consists of one C file (morse.c) and one
146 assembler file (irq.s) will need the following separate steps to compile
147 into an executable named morse:
150 cc65 -g -Oi -t c64 morse.c
153 ld65 -t c64 -o morse c64.o morse.o irq.o c64.lib
156 When using cl65, this is simplified to
159 cl65 -g -Oi morse.c irq.s
162 As a general rule, you may use cl65 instead of cc65 at most times,
163 especially in makefiles to build object files directly from C files. Use
174 <sect>Bugs/Feedback<p>
176 If you have problems using the utility, if you find any bugs, or if you're
177 doing something interesting with it, I would be glad to hear from you. Feel
178 free to contact me by email (<htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">).
184 cl65 (and all cc65 binutils) are (C) Copyright 1998-2000 Ullrich von
185 Bassewitz. For usage of the binaries and/or sources the following
188 This software is provided 'as-is', without any expressed or implied
189 warranty. In no event will the authors be held liable for any damages
190 arising from the use of this software.
192 Permission is granted to anyone to use this software for any purpose,
193 including commercial applications, and to alter it and redistribute it
194 freely, subject to the following restrictions:
197 <item> The origin of this software must not be misrepresented; you must not
198 claim that you wrote the original software. If you use this software
199 in a product, an acknowledgment in the product documentation would be
200 appreciated but is not required.
201 <item> Altered source versions must be plainly marked as such, and must not
202 be misrepresented as being the original software.
203 <item> This notice may not be removed or altered from any source
projects / cc65 / blob