From cb838a43fa536af5d962a3fe230ca36737c3a32b Mon Sep 17 00:00:00 2001 From: Greg King Date: Thu, 27 Mar 2014 12:47:00 -0400 Subject: [PATCH] Added document lines that name the default device drivers. Also: - Changed some tags to . Now, those links will show their URL addresses (in addition to their names) in info and text pages. - Added some Atmos-specific function names to its document. - Fixed some punctuation syntax. --- doc/atari.sgml | 8 ++--- doc/atmos.sgml | 55 ++++++++++++++++++++--------------- doc/c128.sgml | 77 +++++++++++++++++++++++++++---------------------- doc/c64.sgml | 52 ++++++++++++++++++--------------- doc/cbm510.sgml | 43 +++++++++++++++------------ doc/pet.sgml | 34 ++++++++++++---------- doc/vic20.sgml | 36 +++++++++++++---------- 7 files changed, 170 insertions(+), 135 deletions(-) diff --git a/doc/atari.sgml b/doc/atari.sgml index 0bdeac364..007a95039 100644 --- a/doc/atari.sgml +++ b/doc/atari.sgml @@ -7,7 +7,7 @@ url="mailto:shawnjefferson@24fightingchickens.com" name="shawnjefferson@24fightingchickens.com"> and Christian Groessler, -03-Jan-2006 +2014-03-27 An overview over the Atari runtime system as it is implemented for the cc65 C @@ -412,7 +412,7 @@ The values of "1" are needed because the graphics command crashes if it doesn't have at least one byte available. This seems to be a bug of the Atari ROM code. -Default drivers: Extended memory drivers

@@ -657,7 +657,7 @@ Command line arguments can be passed to Leading and trailing spaces around an argument are ignored. The first argument passed to A maximum number of 16 arguments (including the program name) are - supported. + supported. @@ -700,7 +700,7 @@ segments should go above $7FFF.

The main problem is that the EXE header generated by the cc65 runtime lib is wrong. It defines a single load chunk with the sizes/addresses -of the STARTUP, LOWCODE, INIT, CODE, RODATA, and DATA segments, in +of the STARTUP, LOWCODE, INIT, CODE, RODATA, and DATA segments, in fact, the whole user program (we're disregarding the "system check" load chunk here).

diff --git a/doc/atmos.sgml b/doc/atmos.sgml index 82aef6c31..921b11645 100644 --- a/doc/atmos.sgml +++ b/doc/atmos.sgml @@ -2,11 +2,11 @@

-Oric Atmos specific information for cc65 +<title>Oric Atmos-specific information for CC65 <author>Ullrich von Bassewitz <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"><newline> Stefan A. Haubenthal <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org"><newline> <url url="mailto:greg.king5@verizon.net" name="Greg King"> -<date>2013-01-08 +<date>2014-03-27 <abstract> An overview over the Atmos runtime system as it is implemented for the cc65 C @@ -21,11 +21,11 @@ compiler. <sect>Overview<p> This file contains an overview of the Atmos runtime system as it comes with the -cc65 C compiler. It describes the memory layout, Atmos specific header files, +cc65 C compiler. It describes the memory layout, Atmos-specific header files, available drivers, and any pitfalls specific to that platform. -Please note that Atmos specific functions are just mentioned here, they are -described in detail in the separate <htmlurl url="funcref.html" name="function +Please note that Atmos-specific functions are just mentioned here, they are +described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. @@ -58,19 +58,25 @@ Special locations: -<sect>Platform specific header files<p> +<sect>Platform-specific header files<p> -Programs containing Atmos specific code may use the <tt/atmos.h/ header file. +Programs containing Atmos-specific code may use the <tt/atmos.h/ header file. -<sect1>Atmos specific functions<p> +<sect1>Atmos-specific functions<p> -The functions listed below are special for the Atmos. See the <htmlurl +The functions listed below are special for the Atmos. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> <item>atmos_load <item>atmos_save +<item>atmos_explode +<item>atmos_ping +<item>atmos_shoot +<item>atmos_tick +<item>atmos_tock +<item>atmos_zap </itemize> @@ -78,7 +84,7 @@ url="funcref.html" name="function reference"> for declaration and usage. The following pseudo variables declared in the <tt/atmos.h/ header file do allow access to hardware located in the address space. Some variables are -structures, accessing the struct fields will access the chip registers. +structures; accessing the struct fields will access the chip registers. <descrip> @@ -110,6 +116,8 @@ The names in the parentheses denote the symbols to be used for static linking of <sect1>Graphics drivers<p> +The default drivers, <tt/tgi_stddrv (tgi_static_stddrv)/, point to <tt/atmos-240-200-2.tgi (atmos_240_200_2_tgi)/. + <descrip> <tag><tt/atmos-228-200-3.tgi (atmos_228_200_3_tgi)/</tag> @@ -154,8 +162,8 @@ No mouse drivers are currently available for the Atmos. <tag><tt/atmos-acia.ser (atmos_acia_ser)/</tag> Driver for the Telestrat integrated serial controller and the Atmos with a serial add-on. - Note that because of the peculiarities of the 6551 chip together with the - use of the NMI, transmits are not interrupt driven, and the transceiver + Note that, because of the peculiarities of the 6551 chip, together with the + use of the NMI, transmits are not interrupt driven; and, the transceiver blocks if the receiver asserts flow control because of a full buffer. </descrip><p> @@ -167,12 +175,12 @@ No mouse drivers are currently available for the Atmos. <sect1>Disk I/O<p> The existing library for the Atmos doesn't implement C file -I/O. There is one hack for the <tt/write()/ routine in -place, which will make functions work that write to <tt/stdout/ -(like <tt/printf()/). However, this function has some shortcomings which -won't be fixed, because it's going to be replaced anyway. +I/O. There are hacks for the <tt/read()/ and <tt/write()/ routines in +place, which will make functions work that read from and write to <tt/stdout/ +(like <tt/printf()/). However, those functions have some shortcomings which +won't be fixed, because they're going to be replaced anyway. -To be more concrete, this limitation means that you cannot use any of the +To be more concrete, the limitation means that you cannot use any of the following functions (and a few others): <itemize> @@ -190,14 +198,16 @@ following functions (and a few others): <sect>Other hints<p> + <sect1>Function keys<p> These are defined to be FUNCT + number key. + <sect1>Passing arguments to the program<p> -Command line arguments can be passed to <tt/main()/. Since this is not -supported by BASIC, the following syntax was chosen: +Command-line arguments can be passed to <tt/main()/. Since that is not +supported directly by BASIC, the following syntax was chosen: <tscreen><verb> CALL#500:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5 @@ -208,7 +218,7 @@ supported by BASIC, the following syntax was chosen: <item>Arguments may be quoted. <item>Leading and trailing spaces around an argument are ignored. Spaces within a quoted argument are allowed. -<item>The first argument passed to <tt/main/ is the program name. +<item>The first argument passed to <tt/main()/ is the program name. <item>A maximum number of 10 arguments (including the program name) are supported. </enum> @@ -220,7 +230,7 @@ The runtime for the Atmos uses routines marked as <tt/.INTERRUPTOR/ for interrupt handlers. Such routines must be written as simple machine language subroutines and will be called automatically by the interrupt handler code when they are linked into a program. See the discussion of the <tt/.CONDES/ -feature in the <htmlurl url="ca65.html" name="assembler manual">. +feature in the <url url="ca65.html" name="assembler manual">. @@ -246,6 +256,3 @@ freely, subject to the following restrictions: </enum> </article> - - - diff --git a/doc/c128.sgml b/doc/c128.sgml index 5ea44b970..ae48ea514 100644 --- a/doc/c128.sgml +++ b/doc/c128.sgml @@ -2,9 +2,9 @@ <article> -<title>Commodore 128 specific information for cc65 +<title>Commodore 128-specific information for CC65 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"> -<date>2003-12-14 +<date>2014-03-24 <abstract> An overview over the C128 runtime system as it is implemented for the cc65 C @@ -19,11 +19,11 @@ compiler. <sect>Overview<p> This file contains an overview of the C128 runtime system as it comes with the -cc65 C compiler. It describes the memory layout, C128 specific header files, +cc65 C compiler. It describes the memory layout, C128-specific header files, available drivers, and any pitfalls specific to that platform. -Please note that C128 specific functions are just mentioned here, they are -described in detail in the separate <htmlurl url="funcref.html" name="function +Please note that C128-specific functions are just mentioned here, they are +described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. @@ -59,27 +59,27 @@ Special locations: The text screen is located at $400 (as in the standard setup). <tag/Stack/ - The C runtime stack is located at $BFFF and growing downwards. + The C runtime stack is located at $BFFF, and growing downwards. <tag/Heap/ - The C heap is located at the end of the program and grows towards the C + The C heap is located at the end of the program, and grows towards the C runtime stack. </descrip><p> -<sect>Platform specific header files<p> +<sect>Platform-specific header files<p> -Programs containing C128 specific code may use the <tt/c128.h/ or <tt/cbm.h/ +Programs containing C128-specific code may use the <tt/c128.h/ or <tt/cbm.h/ header files. Using the later may be an option when writing code for more than one CBM platform, since it includes <tt/c128.h/ and declares several functions common to all CBM platforms. -<sect1>C128 specific functions<p> +<sect1>C128-specific functions<p> -The functions listed below are special for the C128. See the <htmlurl +The functions listed below are special for the C128. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> @@ -90,10 +90,10 @@ url="funcref.html" name="function reference"> for declaration and usage. </itemize> -<sect1>CBM specific functions<p> +<sect1>CBM-specific functions<p> Some functions are available for all (or at least most) of the Commodore -machines. See the <htmlurl url="funcref.html" name="function reference"> for +machines. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> @@ -164,26 +164,28 @@ The names in the parentheses denote the symbols to be used for static linking of <sect1>Graphics drivers<p> +The default drivers, <tt/tgi_stddrv (tgi_static_stddrv)/, point to <tt/c128-vdc.tgi (c128_vdc_tgi)/. + Note: The graphics drivers for the VDC are incompatible with the extended memory drivers using the VDC memory! <descrip> <tag><tt/c128-vdc.tgi (c128_vdc_tgi)/</tag> - This driver was written by Maciej Witkowiak. It uses the 80 column display + This driver was written by Maciej Witkowiak. It uses the 80-column display, and features a resolution of 640*200 with two colors and an adjustable palette (that means that the two colors can be chosen out of the 16 VDC colors). <tag><tt/c128-vdc2.tgi (c128_vdc2_tgi)/</tag> - This driver was written by Maciej Witkowiak. This driver uses the 80 column - display and features a resolution of 640*480 with two colors and an + This driver was written by Maciej Witkowiak. This driver uses the 80-column + display, and features a resolution of 640*480 with two colors and an adjustable palette (that means that the two colors can be chosen out of the - 16 VDC colors). The driver requires 64KB VDC RAM. + 16 VDC colors). The driver requires 64KiB VDC RAM. </descrip><p> -Note: The colors are translated from definitions in headers to correct VDC values -so please use definitions or VIC color numbers only. Colors <tt/GRAY3/ and <tt/BROWN/ are -missing on VDC and are translated to the two colors missing from VIC palette. +Note: The colors are translated from definitions in headers to correct VDC values; +so, please use definitions or VIC color numbers only. Colors <tt/GRAY3/ and <tt/BROWN/ are +missing on VDC, and are translated to the two colors missing from the VIC palette. <sect1>Extended memory drivers<p> @@ -212,13 +214,13 @@ missing on VDC and are translated to the two colors missing from VIC palette. <tag><tt/c128-reu.emd (c128_reu_emd)/</tag> A driver for the CBM REUs. The driver will determine from the connected REU - if it supports 128KB of RAM or more. In the latter case, 256KB are assumed, + if it supports 128KiB of RAM or more. In the latter case, 256KiB are assumed, but since there are no range checks, the application can use more memory if it has better knowledge about the hardware than the driver. <tag><tt/c128-vdc.emd (c128_vdc_emd)/</tag> - A driver for the VDC memory of the C128 written and contributed by Maciej - Witkowiak. Autodetects the amount of memory available (16 or 64K) and offers + A driver for the VDC memory of the C128, written and contributed by Maciej + Witkowiak. Autodetects the amount of memory available (16 or 64Ki), and offers 64 or 256 pages of 256 bytes each. Note: This driver is incompatible with any of the graphics drivers using the VDC! @@ -227,17 +229,19 @@ missing on VDC and are translated to the two colors missing from VIC palette. <sect1>Joystick drivers<p> +The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/c128-stdjoy.joy (c128_stdjoy_joy)/. + <descrip> <tag><tt/c128-ptvjoy.joy (c128_ptvjoy_joy)/</tag> Driver for the Protovision 4-player adapter originally written by Groepaz - for the C64 and converted for the C128 by me. See <htmlurl + for the C64, and converted for the C128 by me. See <htmlurl url="http://www.protovision-online.de/hardw/hardwstart.htm" name="http://www.protovision-online.de/hardw/hardwstart.htm"> for prices and building instructions. Up to four joysticks are supported. <tag><tt/c128-stdjoy.joy (c128_stdjoy_joy)/</tag> - Supports up to two joysticks connected to the standard joysticks port of + Supports up to two joysticks connected to the standard joysticks ports of the C128. </descrip><p> @@ -246,6 +250,8 @@ missing on VDC and are translated to the two colors missing from VIC palette. <sect1>Mouse drivers<p> +The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/c128-1351.mou (c128_1351_mou)/. + <descrip> <tag><tt/c128-1351.mou (c128_1351_mou)/</tag> @@ -259,11 +265,11 @@ missing on VDC and are translated to the two colors missing from VIC palette. only the 40-column screen. <tag><tt/c128-joy.mou (c128_joy_mou)/</tag> - Supports a mouse emulated by a standard joystick e.g. 1350 mouse in port + Supports a mouse emulated by a standard joystick, e.g. 1350 mouse, in port #1 of the C128. <tag><tt/c128-pot.mou (c128_pot_mou)/</tag> - Supports a potentiometer device e.g. Koala Pad connected to port #1 of + Supports a potentiometer device, e.g. Koala Pad, connected to port #1 of the C128. </descrip><p> @@ -274,10 +280,10 @@ missing on VDC and are translated to the two colors missing from VIC palette. <descrip> <tag><tt/c128-swlink.ser (c128_swlink_ser)/</tag> - Driver for the SwiftLink cartridge. Supports up to 38400 baud, hardware flow - control (RTS/CTS) and interrupt driven receives. Note that because of the - peculiarities of the 6551 chip together with the use of the NMI, transmits - are not interrupt driven, and the transceiver blocks if the receiver asserts + Driver for the SwiftLink cartridge. Supports up to 38400 BPS, hardware flow + control (RTS/CTS), and interrupt-driven receives. Note that, because of the + peculiarities of the 6551 chip, together with the use of the NMI, transmits + are not interrupt driven; and, the transceiver blocks if the receiver asserts flow control because of a full buffer. The driver uses the RS232 variables and buffers of the kernal (buffers at @@ -293,10 +299,11 @@ missing on VDC and are translated to the two colors missing from VIC palette. <sect>Other hints<p> + <sect1>Passing arguments to the program<p> -Command line arguments can be passed to <tt/main()/. Since this is not -supported by BASIC, the following syntax was chosen: +Command-line arguments can be passed to <tt/main()/. Since this is not +supported directly by BASIC, the following syntax was chosen: <tscreen><verb> RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5 @@ -307,7 +314,7 @@ supported by BASIC, the following syntax was chosen: <item>Arguments may be quoted. <item>Leading and trailing spaces around an argument are ignored. Spaces within a quoted argument are allowed. -<item>The first argument passed to <tt/main/ is the program name. +<item>The first argument passed to <tt/main()/ is the program name. <item>A maximum number of 10 arguments (including the program name) are supported. </enum> @@ -325,7 +332,7 @@ The runtime for the C128 uses routines marked as <tt/.INTERRUPTOR/ for interrupt handlers. Such routines must be written as simple machine language subroutines and will be called automatically by the interrupt handler code when they are linked into a program. See the discussion of the <tt/.CONDES/ -feature in the <htmlurl url="ca65.html" name="assembler manual">. +feature in the <url url="ca65.html" name="assembler manual">. diff --git a/doc/c64.sgml b/doc/c64.sgml index a5014414c..c324fbea0 100644 --- a/doc/c64.sgml +++ b/doc/c64.sgml @@ -2,9 +2,9 @@ <article> -<title>Commodore 64 specific information for cc65 +<title>Commodore 64-specific information for CC65 <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"> -<date>2003-09-23 +<date>2014-03-24 <abstract> An overview over the C64 runtime system as it is implemented for the cc65 C @@ -19,11 +19,11 @@ compiler. <sect>Overview<p> This file contains an overview of the C64 runtime system as it comes with the -cc65 C compiler. It describes the memory layout, C64 specific header files, +cc65 C compiler. It describes the memory layout, C64-specific header files, available drivers, and any pitfalls specific to that platform. -Please note that C64 specific functions are just mentioned here, they are -described in detail in the separate <htmlurl url="funcref.html" name="function +Please note that C64-specific functions are just mentioned here, they are +described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. @@ -117,17 +117,17 @@ Please note that in this case a changed start address doesn't make sense, since the program must be loaded to the BASIC start address. -<sect>Platform specific header files<p> +<sect>Platform-specific header files<p> -Programs containing C64 specific code may use the <tt/c64.h/ or <tt/cbm.h/ +Programs containing C64-specific code may use the <tt/c64.h/ or <tt/cbm.h/ header files. Using the later may be an option when writing code for more than one CBM platform, since it includes <tt/c64.h/ and declares several functions common to all CBM platforms. -<sect1>C64 specific functions<p> +<sect1>C64-specific functions<p> -The functions listed below are special for the C64. See the <htmlurl +The functions listed below are special for the C64. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> @@ -135,10 +135,10 @@ url="funcref.html" name="function reference"> for declaration and usage. </itemize> -<sect1>CBM specific functions<p> +<sect1>CBM-specific functions<p> Some functions are available for all (or at least most) of the Commodore -machines. See the <htmlurl url="funcref.html" name="function reference"> for +machines. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> @@ -268,10 +268,12 @@ configuration. <sect1>Joystick drivers<p> +The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/c64-stdjoy.joy (c64_stdjoy_joy)/. + <descrip> <tag><tt/c64-hitjoy.joy (c64_hitjoy_joy)/</tag> - Driver for the Digital Excess & Hitmen adapter contributed by Groepaz. See + Driver for the Digital Excess & Hitmen adapter contributed by Groepaz. See <htmlurl url="http://www.digitalexcess.de/downloads/productions.php" name="http://www.digitalexcess.de/downloads/productions.php"> on instructions how to build one. Up to four joysticks are supported. @@ -295,6 +297,8 @@ configuration. <sect1>Mouse drivers<p> +The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/c64-1351.mou (c64_1351_mou)/. + <descrip> <tag><tt/c64-1351.mou (c64_1351_mou)/</tag> @@ -307,11 +311,11 @@ configuration. joystick left-button pin or the paddle Y [up/down] pin.) <tag><tt/c64-joy.mou (c64_joy_mou)/</tag> - Supports a mouse emulated by a standard joystick e.g. 1350 mouse in port + Supports a mouse emulated by a standard joystick, e.g. 1350 mouse, in port #1 of the C64. <tag><tt/c64-pot.mou (c64_pot_mou)/</tag> - Supports a potentiometer device e.g. Koala Pad connected to port #1 of + Supports a potentiometer device, e.g. Koala Pad, connected to port #1 of the C64. </descrip><p> @@ -322,10 +326,10 @@ configuration. <descrip> <tag><tt/c64-swlink.ser (c64_swlink_ser)/</tag> - Driver for the SwiftLink cartridge. Supports up to 38400 baud, hardware flow - control (RTS/CTS) and interrupt driven receives. Note that because of the - peculiarities of the 6551 chip together with the use of the NMI, transmits - are not interrupt driven, and the transceiver blocks if the receiver asserts + Driver for the SwiftLink cartridge. Supports up to 38400 BPS, hardware flow + control (RTS/CTS), and interrupt-driven receives. Note that, because of the + peculiarities of the 6551 chip, together with the use of the NMI, transmits + are not interrupt driven; and, the transceiver blocks if the receiver asserts flow control because of a full buffer. </descrip><p> @@ -338,14 +342,16 @@ configuration. <sect>Other hints<p> + <sect1>Escape code<p> -For an Esc press CTRL and [ key. +For an Esc, press CTRL and the <tt/[/ key. + <sect1>Passing arguments to the program<p> -Command line arguments can be passed to <tt/main()/. Since this is not -supported by BASIC, the following syntax was chosen: +Command-line arguments can be passed to <tt/main()/. Since this is not +supported directly by BASIC, the following syntax was chosen: <tscreen><verb> RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5 @@ -356,7 +362,7 @@ supported by BASIC, the following syntax was chosen: <item>Arguments may be quoted. <item>Leading and trailing spaces around an argument are ignored. Spaces within a quoted argument are allowed. -<item>The first argument passed to <tt/main/ is the program name. +<item>The first argument passed to <tt/main()/ is the program name. <item>A maximum number of 10 arguments (including the program name) are supported. </enum> @@ -374,7 +380,7 @@ The runtime for the C64 uses routines marked as <tt/.INTERRUPTOR/ for interrupt handlers. Such routines must be written as simple machine language subroutines and will be called automatically by the interrupt handler code when they are linked into a program. See the discussion of the <tt/.CONDES/ -feature in the <htmlurl url="ca65.html" name="assembler manual">. +feature in the <url url="ca65.html" name="assembler manual">. diff --git a/doc/cbm510.sgml b/doc/cbm510.sgml index 75497d977..e70571135 100644 --- a/doc/cbm510.sgml +++ b/doc/cbm510.sgml @@ -2,11 +2,11 @@ <article> -<title>Commodore 510 (aka P500) specific information for cc65 -<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org">&nl; -Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org">&nl; -<htmlurl url="mailto:greg.king5@verizon.net" name="Greg King"> -<date>2013-08-23 +<title>Commodore 510 (aka P500) specific information for CC65 +<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"><newline> +Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org"><newline> +<url url="mailto:greg.king5@verizon.net" name="Greg King"> +<date>2014-03-26 <abstract> An overview over the Commodore 510 runtime system as it is implemented for the @@ -21,11 +21,11 @@ cc65 C compiler. <sect>Overview<p> This file contains an overview of the CBM 510 runtime system as it comes with -the cc65 C compiler. It describes the memory layout, CBM 510 specific header +the cc65 C compiler. It describes the memory layout, CBM 510-specific header files, available drivers, and any pitfalls specific to that platform. -Please note that CBM 510 specific functions are just mentioned here, they are -described in detail in the separate <htmlurl url="funcref.html" name="function +Please note that CBM 510-specific functions are just mentioned here, they are +described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. @@ -75,16 +75,16 @@ Special locations: -<sect>Platform specific header files<p> +<sect>Platform-specific header files<p> -Programs containing CBM 510 specific code may use the <tt/cbm510.h/ or +Programs containing CBM 510-specific code may use the <tt/cbm510.h/ or <tt/cbm.h/ header files. Using the later may be an option when writing code for more than one CBM platform, since it includes <tt/cbm510.h/ and declares several functions common to all CBM platforms. -<sect1>CBM 510 specific functions<p> +<sect1>CBM 510-specific functions<p> -The functions listed below are special for the CBM 510. See the <htmlurl +The functions listed below are special for the CBM 510. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> @@ -95,10 +95,10 @@ url="funcref.html" name="function reference"> for declaration and usage. </itemize> -<sect1>CBM specific functions<p> +<sect1>CBM-specific functions<p> Some functions are available for all (or at least most) of the Commodore -machines. See the <htmlurl url="funcref.html" name="function reference"> for +machines. See the <url url="funcref.html" name="function reference"> for declaration and usage. @@ -204,6 +204,8 @@ No graphics drivers are currently available for the Commodore 510. <sect1>Mouse drivers<p> +The default drivers, <tt/mouse_stddrv (mouse_static_stddrv)/, point to <tt/cbm510-joy.mou (cbm510_joy_mou)/. + <descrip> <tag><tt/cbm510-joy.mou (cbm510_joy_mou)/</tag> @@ -220,20 +222,22 @@ No graphics drivers are currently available for the Commodore 510. </descrip><p> + <sect1>RS232 device drivers<p> <descrip> <tag><tt/cbm510-std.ser (cbm510_std_ser)/</tag> Driver for the 6551 ACIA chip built into the Commodore 510. Supports up to - 19200 baud, hardware flow control (RTS/CTS) and interrupt driven receives. - Note that because of the peculiarities of the 6551 chip transmits are not - interrupt driven, and the transceiver blocks if the receiver asserts flow + 19200 BPS, hardware flow control (RTS/CTS), and interrupt-driven receives. + Note that, because of the peculiarities of the 6551 chip, transmits are not + interrupt driven; and, the transceiver blocks if the receiver asserts flow control because of a full buffer. </descrip><p> + <sect>Limitations<label id="limitations"><p> @@ -246,6 +250,7 @@ While this simplifies things, it should be noted that the wrappers do have quite an impact on performance: A cross bank call has an extra 300µs penalty added by the wrapper. + <sect1>Interrupts<p> Compiled programs contain an interrupt handler that runs in the program bank. @@ -258,8 +263,10 @@ Since the cc65 runtime does only call the kernal for disk I/O, this means that a program should not do file I/O while it depends on interrupts. + <sect>Other hints<p> + <sect1>Passing arguments to the program<p> Command line argument passing is currently not supported for the Commodore @@ -278,7 +285,7 @@ The runtime for the Commodore 510 uses routines marked as <tt/.INTERRUPTOR/ for interrupt handlers. Such routines must be written as simple machine language subroutines and will be called automatically by the interrupt handler code when they are linked into a program. See the discussion of the -<tt/.CONDES/ feature in the <htmlurl url="ca65.html" name="assembler manual">. +<tt/.CONDES/ feature in the <url url="ca65.html" name="assembler manual">. diff --git a/doc/pet.sgml b/doc/pet.sgml index 6d816ad77..3c282a413 100644 --- a/doc/pet.sgml +++ b/doc/pet.sgml @@ -2,10 +2,10 @@ <article> -<title>Commodore PET specific information for cc65 -<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"> +<title>Commodore PET-specific information for CC65 +<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"><newline> Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org"> -<date>2005-05-24 +<date>2014-03-26 <abstract> An overview over the PET runtime system as it is implemented for the cc65 C @@ -20,11 +20,11 @@ compiler. <sect>Overview<p> This file contains an overview of the PET runtime system as it comes with the -cc65 C compiler. It describes the memory layout, PET specific header files, +cc65 C compiler. It describes the memory layout, PET-specific header files, available drivers, and any pitfalls specific to that platform. -Please note that PET specific functions are just mentioned here, they are -described in detail in the separate <htmlurl url="funcref.html" name="function +Please note that PET-specific functions are just mentioned here, they are +described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. @@ -63,24 +63,24 @@ Special locations: -<sect>Platform specific header files<p> +<sect>Platform-specific header files<p> -Programs containing PET specific code may use the <tt/pet.h/ or <tt/cbm.h/ +Programs containing PET-specific code may use the <tt/pet.h/ or <tt/cbm.h/ header files. Using the later may be an option when writing code for more than one CBM platform, since it includes <tt/pet.h/ and declares several functions common to all CBM platforms. -<sect1>PET specific functions<p> +<sect1>PET-specific functions<p> There are currently no special PET functions. -<sect1>CBM specific functions<p> +<sect1>CBM-specific functions<p> Some functions are available for all (or at least most) of the Commodore -machines. See the <htmlurl url="funcref.html" name="function reference"> for +machines. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> @@ -148,6 +148,8 @@ No extended memory drivers are currently available for the PET. <sect1>Joystick drivers<p> +The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/pet-stdjoy.joy (pet_stdjoy_joy)/. + <descrip> <tag><tt/pet-ptvjoy.joy (pet_ptvjoy_joy)/</tag> @@ -179,10 +181,11 @@ No serial drivers are currently available for the PET. <sect>Other hints<p> + <sect1>Passing arguments to the program<p> -Command line arguments can be passed to <tt/main()/. Since this is not -supported by BASIC, the following syntax was chosen: +Command-line arguments can be passed to <tt/main()/. Since that is not +supported directly by BASIC, the following syntax was chosen: <tscreen><verb> RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5 @@ -193,7 +196,7 @@ supported by BASIC, the following syntax was chosen: <item>Arguments may be quoted. <item>Leading and trailing spaces around an argument are ignored. Spaces within a quoted argument are allowed. -<item>The first argument passed to <tt/main/ is the program name. +<item>The first argument passed to <tt/main()/ is the program name. <item>A maximum number of 10 arguments (including the program name) are supported. </enum> @@ -211,7 +214,7 @@ The runtime for the PET uses routines marked as <tt/.INTERRUPTOR/ for interrupt handlers. Such routines must be written as simple machine language subroutines and will be called automatically by the interrupt handler code when they are linked into a program. See the discussion of the <tt/.CONDES/ -feature in the <htmlurl url="ca65.html" name="assembler manual">. +feature in the <url url="ca65.html" name="assembler manual">. <sect1>Using extended memory<p> @@ -228,6 +231,7 @@ the following code: </verb></tscreen> + <sect>License<p> This software is provided 'as-is', without any expressed or implied diff --git a/doc/vic20.sgml b/doc/vic20.sgml index 562ea002a..1044b7b23 100644 --- a/doc/vic20.sgml +++ b/doc/vic20.sgml @@ -2,10 +2,10 @@ <article> -<title>Commodore VIC20 (aka VC20) specific information for cc65 -<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"> +<title>Commodore VIC20 (aka VC20) specific information for CC65 +<author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"><newline> Stefan A. Haubenthal, <htmlurl url="mailto:polluks@sdf.lonestar.org" name="polluks@sdf.lonestar.org"> -<date>2004-09-13 +<date>2014-03-26 <abstract> An overview over the VIC20 runtime system as it is implemented for the cc65 C @@ -20,11 +20,11 @@ compiler. <sect>Overview<p> This file contains an overview of the VIC20 runtime system as it comes with the -cc65 C compiler. It describes the memory layout, VIC20 specific header files, +cc65 C compiler. It describes the memory layout, VIC20-specific header files, available drivers, and any pitfalls specific to that platform. -Please note that VIC20 specific functions are just mentioned here, they are -described in detail in the separate <htmlurl url="funcref.html" name="function +Please note that VIC20-specific functions are just mentioned here, they are +described in detail in the separate <url url="funcref.html" name="function reference">. Even functions marked as "platform dependent" may be available on more than one platform. Please see the function reference for more information. @@ -63,24 +63,24 @@ Special locations: -<sect>Platform specific header files<p> +<sect>Platform-specific header files<p> -Programs containing VIC20 specific code may use the <tt/vic20.h/ or <tt/cbm.h/ +Programs containing VIC20-specific code may use the <tt/vic20.h/ or <tt/cbm.h/ header files. Using the later may be an option when writing code for more than one CBM platform, since it includes <tt/vic20.h/ and declares several functions common to all CBM platforms. -<sect1>VIC20 specific functions<p> +<sect1>VIC20-specific functions<p> There are currently no special VIC20 functions. -<sect1>CBM specific functions<p> +<sect1>CBM-specific functions<p> Some functions are available for all (or at least most) of the Commodore -machines. See the <htmlurl url="funcref.html" name="function reference"> for +machines. See the <url url="funcref.html" name="function reference"> for declaration and usage. <itemize> @@ -151,6 +151,8 @@ No extended memory drivers are currently available for the VIC20. <sect1>Joystick drivers<p> +The default drivers, <tt/joy_stddrv (joy_static_stddrv)/, point to <tt/vic20-stdjoy.joy (vic20_stdjoy_joy)/. + <descrip> <tag><tt/vic20-stdjoy.joy (vic20_stdjoy_joy)/</tag> @@ -182,14 +184,16 @@ No VIC1011 drivers are currently available for the VIC20. <sect>Other hints<p> + <sect1>Escape code<p> -For an Esc press CTRL and [ key. +For an Esc, press CTRL and the <tt/[/ key. + <sect1>Passing arguments to the program<p> -Command line arguments can be passed to <tt/main()/. Since this is not -supported by BASIC, the following syntax was chosen: +Command-line arguments can be passed to <tt/main()/. Since that is not +supported directly by BASIC, the following syntax was chosen: <tscreen><verb> RUN:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5 @@ -200,7 +204,7 @@ supported by BASIC, the following syntax was chosen: <item>Arguments may be quoted. <item>Leading and trailing spaces around an argument are ignored. Spaces within a quoted argument are allowed. -<item>The first argument passed to <tt/main/ is the program name. +<item>The first argument passed to <tt/main()/ is the program name. <item>A maximum number of 10 arguments (including the program name) are supported. </enum> @@ -232,7 +236,7 @@ The runtime for the VIC20 uses routines marked as <tt/.INTERRUPTOR/ for interrupt handlers. Such routines must be written as simple machine language subroutines and will be called automatically by the interrupt handler code when they are linked into a program. See the discussion of the <tt/.CONDES/ -feature in the <htmlurl url="ca65.html" name="assembler manual">. +feature in the <url url="ca65.html" name="assembler manual">. -- 2.39.5