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 and the linker (ld65).
14 <!-- Table of contents -->
17 <!-- Begin the document -->
21 cl65 is a frontend for cc65, ca65 and ld65. While you may not use the full
22 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 compile, assemble and
29 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
31 assembler) and other things.
34 ---------------------------------------------------------------------------
35 Usage: cl65 [options] file
37 -c Compiler 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-name seg Set the name of the BSS segment
68 --check-stack Generate stack overflow checks
69 --code-name seg Set the name of the CODE segment
70 --codesize x Accept larger code by factor x
71 --cpu type Set cpu type
72 --create-dep Create a make dependency file
73 --data-name seg Set the name of the DATA segment
75 --debug-info Add debug info
76 --feature name Set an emulation feature
77 --help Help (this text)
78 --include-dir dir Set a compiler include directory path
79 --listing Create an assembler listing
80 --mapfile name Create a map file
81 --register-space b Set space available for register variables
82 --register-vars Enable register variables
83 --rodata-name seg Set the name of the RODATA segment
84 --signed-chars Default characters are signed
85 --start-addr addr Set the default start address
86 --static-locals Make local variables static
87 --target sys Set the target system
88 --version Print the version number
89 --verbose Verbose mode
90 ---------------------------------------------------------------------------
93 Most of the options have the same meaning than the corresponding compiler,
94 assembler or linker option. See the documentation for these tools for an
95 explanation. If an option is available for more than one of the tools, it
96 is set for all tools, where it is available. One example for this is <tt/-v/:
97 The compiler, the assembler and the linker are all called with the <tt/-v/
100 There are a few remaining options that control the behaviour of cl65:
104 <tag><tt>-S</tt></tag>
106 This option forces cl65 to stop after the assembly step. This means that
107 C files are translated into assembler files, but nothing more is done.
108 Assembler files, object files and libraries given on the command line
112 <tag><tt>-c</tt></tag>
114 This options forces cl65 to stop after the assembly step. This means
115 that C and assembler files given on the command line are translated into
116 object files, but there is no link step, and object files and libraries
117 given on the command line are ignored.
120 <tag><tt>-o name</tt></tag>
122 The -o option is used for the target name in the final step. This causes
123 problems, if the linker will not be called, and there are several input
124 files on the command line. In this case, the name given with -o will be
125 used for all of them, which makes the option pretty useless. You
126 shouldn't use -o when more than one output file is created.
129 <tag><tt>-t sys, --target sys</tt></tag>
131 The default for this option is different from the compiler and linker in the
132 case that the option is missing: While the other tools (compiler, assembler
133 and linker) will use the "none" system settings by default, cl65 will use
134 the C64 as a target system by default. This was choosen since most people
135 seem to use cc65 to develop for the C64.
143 Since cl65 was created to simplify the use of the cc65 development
144 package, it tries to be smart about several things.
148 <item> If you don't give a target system on the command line, cl65
151 <item> When linking, cl65 will supply the names of the startup file and
152 library for the target system to the linker, so you don't have to do
155 <item> If the final step is the linker, and the name of the output file was
156 not explicitly given, cl65 will use the name of the first input file
157 without the extension, provided that the name of this file has an
158 extension. So you don't need to name the executable name in most
159 cases, just give the name of your "main" file as first input file.
165 The morse trainer software, which consists of one C file (morse.c) and one
166 assembler file (irq.s) will need the following separate steps to compile
167 into an executable named morse:
170 cc65 -g -Oi -t c64 morse.c
173 ld65 -t c64 -o morse c64.o morse.o irq.o c64.lib
176 When using cl65, this is simplified to
179 cl65 -g -Oi morse.c irq.s
182 As a general rule, you may use cl65 instead of cc65 at most times,
183 especially in makefiles to build object files directly from C files. Use
194 <sect>Bugs/Feedback<p>
196 If you have problems using the utility, if you find any bugs, or if you're
197 doing something interesting with it, I would be glad to hear from you. Feel
198 free to contact me by email (<htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">).
204 cl65 (and all cc65 binutils) are (C) Copyright 1998-2000 Ullrich von
205 Bassewitz. For usage of the binaries and/or sources the following
208 This software is provided 'as-is', without any expressed or implied
209 warranty. In no event will the authors be held liable for any damages
210 arising from the use of this software.
212 Permission is granted to anyone to use this software for any purpose,
213 including commercial applications, and to alter it and redistribute it
214 freely, subject to the following restrictions:
217 <item> The origin of this software must not be misrepresented; you must not
218 claim that you wrote the original software. If you use this software
219 in a product, an acknowledgment in the product documentation would be
220 appreciated but is not required.
221 <item> Altered source versions must be plainly marked as such, and must not
222 be misrepresented as being the original software.
223 <item> This notice may not be removed or altered from any source