X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fintro.sgml;h=09b304d16f74c181afaaf9fde624bf56d4026681;hb=b02cc40bc066d3db3caa3f96823ebac4589ecb8e;hp=90905af0a6b4893ae900c4781db1c8c91f2f7182;hpb=dcf2bf4976692afa32318b603f12873cdba4e3d1;p=cc65

diff --git a/doc/intro.sgml b/doc/intro.sgml
index 90905af0a..09b304d16 100644
--- a/doc/intro.sgml
+++ b/doc/intro.sgml
@@ -25,13 +25,19 @@ one assembly modules. This file does <em/not/ contain a complete reference for
 the tools used in the process. There are separate files describing those tools,
 in detail (see <url url="index.html">).
 
-You are assumed to have downloaded and extracted the executables and the
-target-specific files. For example: for Windows users targeting C64, you need
-<bf/cc65-win32-2.10.1.zip/ and <bf/cc65-c64-2.10.1.zip/ (or, whatever the
-current cc65 version is) extracted to the same directory. If you received the
-files as a bzip2 archive (extension <bf/.bz2/), you will need to get <url
-url="http://sources.redhat.com/bzip2/#bzip2-latest" name="the bzip2 package">
-to decompress it.
+I do assume that you have downloaded and installed the compiler and
+target-specific files. Windows users should use the friendly .exe installer
+(named cc65-2.13.0-1.exe for version 2.13.0 of the package - adjust the
+version number if necessary). It does not only install the target files, but
+will also set up necessary environment variables for you.
+
+If you're going for the .ZIP archives, please note that there is one file for
+the host platform (Windows, DOS or OS/2), one file for each target platform
+(C64 or whatever) and a separate file containing the docs (which include the
+file you're currently reading). So for most uses, you will need at least 3
+files and unpack all three into one directory. In case of the .ZIP archives,
+you will also need to set the environment variables <tt/CC65_INC/,
+<tt/LD65_LIB/ and <tt/LD65_CFG/ as described below.
 
 <bf/Note/: There is a much simpler way to compile this example, by using the
 <bf/cl65/ compile-and-link utility. However, it makes sense to understand how
@@ -42,9 +48,11 @@ described <ref id="using-cl65" name="later">.
 <sect1>Before we start<p>
 
 You will find a copy of the sample modules, used in the next section, in the
-"<tt>cc65/samples/tutorial</tt>" directory. Please make sure that the compiler
-and linker can find the include and library files, by setting the environment
-variables <tt/CC65_INC/ and <tt/CC65_LIB/, respectively.
+"<tt>cc65/samples/tutorial</tt>" directory. If you encounter problems with
+missing include files and/or libraries, please check the environment variables
+<tt/CC65_INC/, <tt/LD65_LIB/ and <tt/LD65_CFG/. They should point to the
+<tt/include/, <tt/lib/ and <tt/cfg/ subdirectories of the directory, where you
+installed cc65.
 
 
 <sect1>The sample modules<p>
@@ -102,7 +110,8 @@ is the C64.
 </verb></tscreen>
 
 <tt/c64.o/ (the startup code) and <tt/c64.lib/ (the C64 version of the runtime
-and C library) are provided in binary form in the cc65 package.
+and C library) are provided in binary form in the cc65 package. Actually, the
+startup code is contained in the library, so you won't need to care about it.
 
 
 
@@ -116,7 +125,7 @@ In the example above, we would use the following command line, to translate
 <tt/hello.c/ into <tt/hello.s/:
 
 <tscreen><verb>
-        cc65 -O -I ../../include -t c64 hello.c
+        cc65 -O -t c64 hello.c
 </verb></tscreen>
 
 The <tt/-O/ switch tells the compiler to do an additional optimizer run, which
@@ -124,9 +133,6 @@ is usually a good idea, since it makes the code smaller. If you don't care
 about the size, but want to have slightly faster code, use <tt/-Oi/ to inline
 some runtime functions.
 
-The <tt/-I/ switch gives a search path for the include files. You may also set
-the environment variable <tt/CC65_INC/ to the search path.
-
 The <tt/-t/ switch is followed by the target system name.
 
 If the compiler does not complain about errors in our "hello world" program, we
@@ -167,8 +173,8 @@ For more information about the assembler, see <url url="ca65.html">.
 <sect>The linker<p>
 
 The linker combines several object and library files into one output file.
-<bf/ld65/ is very configurable, but fortunately has a built-in configuration
-for the C64, so we don't need to mess with configuration files, here.
+<bf/ld65/ is very configurable, but fortunately has built-in configurations,
+so we don't need to mess with configuration files, here.
 
 The compiler uses small functions to do things that cannot be done inline
 without a big impact on code size. Those runtime functions, together with the
@@ -176,22 +182,16 @@ C library, are in an object-file archive named after the system, in this case,
 "<tt/c64.lib/". We have to specify that file on the command line, so that the
 linker can resolve those functions.
 
-A second file (this time, an object file) needed is the startup code that
-prepares the grounds for the C program to run. The startup file must be
-executed first, so it must be the first file on the linker command line.
-
 Let's link our files to get the final executable:
 
 <tscreen><verb>
-        ld65 -t c64 -o hello c64.o hello.o text.o c64.lib
+        ld65 -t c64 -o hello hello.o text.o c64.lib
 </verb></tscreen>
 
 The argument after <tt/-o/ specifies the name of the output file, the argument
-after <tt/-t/ gives the target system. As discussed, the startup file must be
-the first input file on the command line (you may have to add a path here, if
-<tt/c64.o/ is not in your current directory). Since the library resolves
-imports in <tt/hello.o/ and <tt/text.o/, it must be specified <em/after/ those
-files.
+after <tt/-t/ gives the target system. The following arguments are object
+files or libraries. Since the target library resolves imports in <tt/hello.o/
+and <tt/text.o/, it must be specified <em/after/ those files.
 
 After a successful linker run, we have a file named "<tt/hello/", ready for
 our C64!
@@ -209,18 +209,11 @@ well-suited for our example.
 To compile both files into one executable, enter:
 
 <tscreen><verb>
-        cl65 -O -I ../../include -L ../../lib hello.c text.s
+        cl65 -O hello.c text.s
 </verb></tscreen>
 
-(The <tt/-I/ option is not needed if you are working under a Unix-like system
-with the include files in their default path, or if the <tt/CC65_INC/
-environment variable is set correctly. The <tt/-L/ option is not needed if the
-libraries are in their default path, or if the <tt/CC65_LIB/ environment
-variable is set correctly. &lsqb;Those two environment variables should be set to
-absolute paths.&rsqb;)
-
 The <bf/cl65/ utility knows how to translate C files into object files (it will
-call the compiler, and then, the assembler). It does know also how to create
+call the compiler, and then the assembler). It does know also how to create
 object files from assembly files (it will call only the assembler, for that).
 It knows how to build an executable (it will pass all object files to the
 linker). And finally, it has the C64 as a default target, and will supply the
@@ -239,49 +232,50 @@ url="cl65.html">.
 
 <em/Note: this section is incomplete!/
 
-Depending on the target, cc65 chooses several methods of making a
-program available for execution.  Here, we list sample emulators and
-instructions for running the program.  Unless noted, similar instructions
-would also apply to a real machine.  One word of advice: we suggest you clear
-the screen at the start, and wait for a keypress at the end of your program,
-as each target varies in it's start and exit conditions.
+Depending on the target, cc65 chooses several methods of making a program
+available for execution. Here, we list sample emulators and instructions for
+running the program. Unless noted, similar instructions would also apply to a
+real machine. One word of advice: we suggest you clear the screen at the
+start, and wait for a keypress at the end of your program, as each target
+varies in it's start and exit conditions.
 
 
 <sect1>Apple
 
-<sect2>AppleWin 1.10.4<p>
-Available at <url url="http://www.jantzer-schmidt.de/applewin/">:
+<sect2>AppleWin<p>
+Available at <url
+url="http://applewin.berlios.de/">:
 
-Emulates Apple II+/IIe computers, with sound, video, joysticks, serial port,
-and disk images. Includes monitor. Only for Windows. The package comes with
-ROM and DOS 3.3 disk (called "master.dsk") images; however, you will need
-<bf/a2tools/ (available at <url
-url="http://hotel04.ausys.se/pausch/apple2/#a2tools">).
+Emulates Apple&nbsp;&rsqb;&lsqb;/enhanced&nbsp;Apple&nbsp;//e computers, with
+sound, video, joysticks, serial port, and disk images. Includes monitor. Only
+for Windows. The package comes with a DOS 3.3 disk (called "master.dsk") image;
+however, you will need <bf/AppleCommander 1.3.5/ or later (available at <url
+url="http://applecommander.sourceforge.net/">).
 
 Compile the tutorial with
 
 <tscreen><verb>
 cl65 -O -t apple2 hello.c text.s
 </verb></tscreen>
-for the Apple II, or:
+for the Apple&nbsp;&rsqb;&lsqb;, or:
 <tscreen><verb>
 cl65 -O -t apple2enh hello.c text.s
 </verb></tscreen>
-for the Apple IIe.
+for the enhanced&nbsp;Apple&nbsp;//e.
 
-Then, insert the file into an Apple disk image, for use with an emulator.  Copy
-the <tt/master.dsk/ which comes with <bf/Applewin/, and rename it to
-<tt/cc65.dsk/, then use <bf/a2tools/:
+Then, put the file onto an Apple disk image, for use with an emulator.  Copy
+the <tt/master.dsk/ which comes with <bf/AppleWin/, and rename it to
+<tt/cc65.dsk/, then use <bf/AppleCommander/:
 
 <tscreen><verb>
-a2tools in -r b cc65.dsk TEST hello
+java -jar ac.jar -cc65 cc65.dsk test B < hello
 </verb></tscreen>
 
 Note that a convention in the Apple world is that "hello" is the file which is
 run automatically upon booting a DOS disk, sort of like the "autoexec.bat" of
 the MSDOS/Windows world.  We've avoided that in the example, however.  Also,
-the <tt/TEST/ parameter must be in caps., and is the name of the program as it
-will appear on the Apple disk.
+the <tt/B/ parameter must be in caps., and "test" is the name of the program as
+it will appear on the Apple disk.
 
 Start the emulator, click on the <bf/Disk 1/ icon, and point to <bf/cc65.dsk/;
 then, click the big Apple logo, to boot the system.  Then, type this on the
@@ -292,14 +286,15 @@ BRUN TEST
 </verb></tscreen>
 
 You will see the "Hello, World!" appear on the same line.  Thanks to Oliver
-Schmidt, <htmlurl url="mailto:oliver@jantzer-schmidt.de"
-name="oliver@jantzer-schmidt.de"> for his help in completing this section.
+Schmidt, <htmlurl url="mailto:ol.sc@web.de" name="ol.sc@web.de"> for his help
+in completing this section.
 
 
 <sect1>Atari
 
-<sect2>Atari800Win Plus 3.0<p>
-Available at <url url="http://www.a800win.atari-area.prv.pl">:
+<sect2>Atari800Win Plus<p>
+Available at <url
+url="http://www.a800win.atari-area.prv.pl">:
 
 Emulates Atari 400/800/65XE/130XE/800XL/1200XL/5200, with stereo sound, disk
 images, scanline-exact NTSC/PAL video, joysticks, mouse, cartridges, and RAM
@@ -341,11 +336,9 @@ any output.
 
 <sect1>Commodore
 
-<sect2>VICE 1.16<p>
+<sect2>VICE<p>
 Available at <url
-url="http://www.zimmers.net/anonftp/pub/cbm/crossplatform/emulators/VICE/">,
-<newline>and at <url
-url="http://www.ibiblio.org/pub/micro/commodore/crossplatform/emulators/VICE/">:
+url="http://www.viceteam.org/">:
 
 Emulates Commodore 64/128/VIC-20/PET/CBM II/Plus 4 computers. Supports
 printers, serial port and adapters, stereo sound, disk drives and images, RAM
@@ -415,7 +408,7 @@ prompt.
 
 <sect1>GEOS<p>
 Available at <it/Click Here Software's/ <url
-url="http://cmdrkey.com/cbm/geos/geos1.html" name="GEOS download page">:
+url="http://cbmfiles.com/geos/index.html" name="GEOS download section">:
 
 <it><bf/G/raphics <bf/E/nvironment <bf/O/perating <bf/S/ystem.</it>
 It provides a WIMP GUI (Windows, Icons, and Mouse-Pointer Graphical User