X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Ffuncref.sgml;h=d2325416ce7f62323ca41c83ddc28f13f3ff2298;hb=84be7444189a9a274d5cc3927cf7a2b08165ede2;hp=0497a94450c93d1238c35c76bae24742b690cdd5;hpb=8c2d2336033da290c0cacc581705e531cc6a8338;p=cc65

diff --git a/doc/funcref.sgml b/doc/funcref.sgml
index 0497a9445..d2325416c 100644
--- a/doc/funcref.sgml
+++ b/doc/funcref.sgml
@@ -64,11 +64,12 @@ function.
 
 <sect1><tt/apple2.h/<label id="apple2.h"><p>
 
+(incomplete)
 
-<sect1><tt/atari.h/<label id="atari.h"><p>
 
+<sect1><tt/apple2enh.h/<label id="apple2enh.h"><p>
 
-<sect1><tt/atmos.h/<label id="atmos.h"><p>
+(incomplete)
 
 
 <sect1><tt/assert.h/<label id="assert.h"><p>
@@ -78,6 +79,16 @@ function.
 </itemize>
 
 
+<sect1><tt/atari.h/<label id="atari.h"><p>
+
+(incomplete)
+
+
+<sect1><tt/atmos.h/<label id="atmos.h"><p>
+
+(incomplete)
+
+
 <sect1><tt/c128.h/<label id="c128.h"><p>
 
 <itemize>
@@ -90,9 +101,23 @@ function.
 
 <sect1><tt/c16.h/<label id="c16.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/c64.h/<label id="c64.h"><p>
 
+(incomplete)
+
+
+<sect1><tt/cbm510.h/<label id="cbm510.h"><p>
+
+(incomplete)
+
+
+<sect1><tt/cbm610.h/<label id="cbm610.h"><p>
+
+(incomplete)
+
 
 <sect1><tt/conio.h/<label id="conio.h"><p>
 
@@ -149,9 +174,13 @@ function.
 
 <sect1><tt/dbg.h/<label id="dbg.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/dio.h/<label id="dio.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/em.h/<label id="em.h"><p>
 
@@ -169,6 +198,8 @@ function.
 
 <sect1><tt/errno.h/<label id="errno.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/fcntl.h/<label id="fcntl.h"><p>
 
@@ -181,9 +212,13 @@ function.
 
 <sect1><tt/geos.h/<label id="geos.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/joystick.h/<label id="joystick.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/locale.h/<label id="locale.h"><p>
 
@@ -195,12 +230,44 @@ function.
 
 <sect1><tt/modload.h/<label id="modload.h"><p>
 
+<itemize>
+<item><ref id="mod_load" name="mod_load">
+<item><ref id="mod_free" name="mod_free">
+</itemize>
+
+
+<sect1><tt/mouse.h/<label id="mouse.h"><p>
+
+<!-- <itemize> -->
+<!-- <item><ref id="mouse_load_driver" name="mouse_load_driver"> -->
+<!-- <item><ref id="mouse_unload" name="mouse_unload"> -->
+<!-- <item><ref id="mouse_install" name="mouse_install"> -->
+<!-- <item><ref id="mouse_uninstall" name="mouse_uninstall"> -->
+<!-- <item><ref id="mouse_hide" name="mouse_hide"> -->
+<!-- <item><ref id="mouse_show" name="mouse_show"> -->
+<!-- <item><ref id="mouse_box" name="mouse_box"> -->
+<!-- <item><ref id="mouse_move" name="mouse_move"> -->
+<!-- <item><ref id="mouse_buttons" name="mouse_buttons"> -->
+<!-- <item><ref id="mouse_pos" name="mouse_pos"> -->
+<!-- <item><ref id="mouse_info" name="mouse_info"> -->
+<!-- <item><ref id="mouse_ioctl" name="mouse_ioctl"> -->
+<!-- </itemize> -->
+
+(incomplete)
+
 
 <sect1><tt/nes.h/<label id="nes.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/o65.h/<label id="o65.h"><p>
 
+The <tt/o65.h/ header file contains structure and constant definitions that
+may be used when dealing with files in <htmlurl
+url="http://www.6502.org/users/andre/o65/fileformat.html" name="o65 format">.
+It does not declare any functions.
+
 
 <sect1><tt/peekpoke.h/<label id="peekpoke.h"><p>
 
@@ -214,15 +281,41 @@ function.
 
 <sect1><tt/pet.h/<label id="pet.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/plus4.h/<label id="plus4.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/serial.h/<label id="serial.h"><p>
 
+<!--
+<itemize>
+<item><ref id="ser_load_driver" name="ser_load_driver">
+<item><ref id="ser_unload" name="ser_unload">
+<item><ref id="ser_install" name="ser_install">
+<item><ref id="ser_uninstall" name="ser_uninstall">
+<item><ref id="ser_open" name="ser_open">
+<item><ref id="ser_close" name="ser_close">
+<item><ref id="ser_get" name="ser_get">
+<item><ref id="ser_put" name="ser_put">
+<item><ref id="ser_status" name="ser_status">
+<item><ref id="ser_ioctl" name="ser_ioctl">
+</itemize>
+-->
+
+(incomplete)
+
 
 <sect1><tt/setjmp.h/<label id="setjmp.h"><p>
 
+<itemize>
+<item><ref id="setjmp" name="setjmp">
+<item><ref id="longjmp" name="longjmp">
+</itemize>
+
 
 <sect1><tt/signal.h/<label id="signal.h"><p>
 
@@ -234,9 +327,13 @@ function.
 
 <sect1><tt/stdarg.h/<label id="stdarg.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/stdbool.h/<label id="stdbool.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/stddef.h/<label id="stddef.h"><p>
 
@@ -290,6 +387,8 @@ function.
 <!-- <item><ref id="vsscanf" name="vsscanf"> -->
 </itemize>
 
+(incomplete)
+
 
 <sect1><tt/stdlib.h/<label id="stdlib.h"><p>
 
@@ -361,9 +460,13 @@ function.
 <item><ref id="strupr" name="strupr">
 </itemize>
 
+(incomplete)
+
 
 <sect1><tt/tgi.h/<label id="tgi.h"><p>
 
+(incomplete)
+
 
 <sect1><tt/time.h/<label id="time.h"><p>
 
@@ -379,6 +482,8 @@ function.
 <item><ref id="time" name="time">
 </itemize>
 
+(incomplete)
+
 
 <sect1><tt/unistd.h/<label id="unistd.h"><p>
 
@@ -394,13 +499,17 @@ function.
 <!-- <item><ref id="write" name="write"> -->
 </itemize>
 
+(incomplete)
+
 
 <sect1><tt/vic20.h/<label id="vic20.h"><p>
 
+(incomplete)
 
-<sect1><tt/zlib.h/<label id="zlib.h"><p>
 
+<sect1><tt/zlib.h/<label id="zlib.h"><p>
 
+(incomplete)
 
 
 <sect>Alphabetical function reference<p>
@@ -416,7 +525,7 @@ function.
 <tag/Limits/
 <itemize>
 <item>The minimum blocksize that can be added is 6 bytes; the function will
-ignore blocks with smaller sizes.
+ignore smaller blocks.
 </itemize>
 <tag/Availability/cc65
 <tag/See also/
@@ -2670,6 +2779,33 @@ always be the same.
 </quote>
 
 
+<sect1>longjmp<label id="longjmp"><p>
+
+<quote>
+<descrip>
+<tag/Function/Non local goto.
+<tag/Header/<tt/<ref id="setjmp.h" name="setjmp.h">/
+<tag/Declaration/<tt/void __fastcall__ longjmp (jmp_buf buf, int retval);/
+<tag/Description/The <tt/longjmp/ function restores a program context from the
+data in <tt/buf/, which must have been set by a preceeding call to
+<tt/<ref id="setjmp" name="setjmp">/. Program execution continues as if the
+call to <tt/<ref id="setjmp" name="setjmp">/ has just returned the value
+<tt/retval/.
+<tag/Limits/
+<itemize>
+<item>If the parameter <tt/retval/ is zero, the function will behave as if it
+was called with a value of one.
+<item>The function is only available as fastcall function, so it may only
+be used in presence of a prototype.
+</itemize>
+<tag/Availability/ISO 9899
+<tag/See also/
+<ref id="setjmp" name="setjmp">
+<tag/Example/None.
+</descrip>
+</quote>
+
+
 <sect1>malloc<label id="malloc"><p>
 
 <quote>
@@ -2802,6 +2938,58 @@ be used in presence of a prototype.
 </quote>
 
 
+<sect1>mod_free<label id="mod_free"><p>
+
+<quote>
+<descrip>
+<tag/Function/Free a relocatable module.
+<tag/Header/<tt/<ref id="modload.h" name="modload.h">/
+<tag/Declaration/<tt/void __fastcall__ mod_free (void* module);/
+<tag/Description/The function will free a module loaded into memory by use of
+the <tt/<ref id="mod_load" name="mod_load">/ function.
+<tag/Limits/<itemize>
+<item>The pointer passed as parameter is the pointer to the module memory,
+not the pointer to the control structure.
+</itemize>
+<tag/Availability/cc65
+<tag/See also/
+<ref id="mod_load" name="mod_load">
+<tag/Example/None.
+</descrip>
+</quote>
+
+
+<sect1>mod_load<label id="mod_load"><p>
+
+<quote>
+<descrip>
+<tag/Function/Load a relocatable module.
+<tag/Header/<tt/<ref id="modload.h" name="modload.h">/
+<tag/Declaration/<tt/unsigned char mod_load (struct mod_ctrl* ctrl);/
+<tag/Description/The function will load a code module into memory and relocate
+it. The function will return an error code. If <tt/MLOAD_OK/ is returned, the
+outgoing fields in the passed <tt/mod_ctrl/ struct contain information about
+the module just loaded. Possible error codes are:
+<itemize>
+<item><tt/MLOAD_OK/ - Module load successful
+<item><tt/MLOAD_ERR_READ/ - Read error
+<item><tt/MLOAD_ERR_HDR/ - Header error
+<item><tt/MLOAD_ERR_OS/ - Wrong operating system
+<item><tt/MLOAD_ERR_FMT/ - Data format error
+<item><tt/MLOAD_ERR_MEM/ - Not enough memory
+</itemize>
+<tag/Limits/<itemize>
+<item>The <htmlurl url="ld65.html" name="ld65"> linker is needed to create
+relocatable o65 modules for use with this function.
+</itemize>
+<tag/Availability/cc65
+<tag/See also/
+<ref id="mod_free" name="mod_free">
+<tag/Example/None.
+</descrip>
+</quote>
+
+
 <sect1>offsetof<label id="offsetof"><p>
 
 <quote>
@@ -3125,6 +3313,31 @@ the program terminates.
 </quote>
 
 
+<sect1>setjmp<label id="setjmp"><p>
+
+<quote>
+<descrip>
+<tag/Function/Save the context for use with <tt/longjmp/.
+<tag/Header/<tt/<ref id="setjmp.h" name="setjmp.h">/
+<tag/Declaration/<tt/int __fastcall__ setjmp (jmp_buf buf);/
+<tag/Description/The <tt/setjmp/ function saves the current context in <tt/buf/
+for subsequent use by the <tt/<ref id="longjmp" name="longjmp">/ function and
+returns zero.
+<tag/Limits/
+<itemize>
+<item>The function is only available as fastcall function, so it may only
+be used in presence of a prototype.
+<item><tt/setjmp/ is actually a macro as required by the ISO standard.
+<item><tt/setjmp/ will not save the signal context.
+</itemize>
+<tag/Availability/ISO 9899
+<tag/See also/
+<ref id="longjmp" name="longjmp">
+<tag/Example/None.
+</descrip>
+</quote>
+
+
 <sect1>setlocale<label id="setlocale"><p>
 
 <quote>
@@ -3278,7 +3491,7 @@ the end of s1.
 <tag/Limits/<itemize>
 <item>The function is only available as fastcall function, so it may only
 be used in presence of a prototype.
-<item>If copying takes place between objects that overlap, the behavior
+<item>If copying takes place between objects that overlap, the behaviour
 is undefined.
 </itemize>
 <tag/Availability/ISO 9899
@@ -3382,7 +3595,7 @@ be used in presence of a prototype.
 <tag/Limits/<itemize>
 <item>The function is only available as fastcall function, so it may only
 be used in presence of a prototype.
-<item>If copying takes place between objects that overlap, the behavior
+<item>If copying takes place between objects that overlap, the behaviour
 is undefined.
 </itemize>
 <tag/Availability/ISO 9899
@@ -3570,7 +3783,7 @@ character is appended to the result, even if not all of s2 is appended to s1.
 <tag/Limits/<itemize>
 <item>The function is only available as fastcall function, so it may only
 be used in presence of a prototype.
-<item>If copying takes place between objects that overlap, the behavior
+<item>If copying takes place between objects that overlap, the behaviour
 is undefined.
 </itemize>
 <tag/Availability/ISO 9899
@@ -3626,7 +3839,7 @@ written. The function will always return <tt/s1/.
 <item>The function is only available as fastcall function, so it may only
 be used in presence of a prototype. If there is no null byte in the first <tt/n/
 bytes of the array pointed to by <tt/s2/, the result is not null-terminated.
-<item>If copying takes place between objects that overlap, the behavior is
+<item>If copying takes place between objects that overlap, the behaviour is
 undefined.
 </itemize>
 <tag/Availability/ISO 9899