annotate lib/alib/alib.intro @ 2765:0bd16cca86b7

Updated rules.mak for all the os9 format's to format the entire disk. People were having some issues with the disk images not being formatted to their full capacity and preventing some functions from working.
author drencor-xeen
date Thu, 17 Jan 2013 11:03:26 -0600
parents 7d70b7e1cb21
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2474
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
1 RMA Library
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
2
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
3 by
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
4
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
5 Bob van der Poel
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
6
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
7
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
8 WARNING: The entire contents of this file including the documentation and
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
9 the actual binary library code are protected by copyright and is the sole
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
10 property of Bob van der Poel. You are given permission to use this
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
11 software and to post it on other information systems, etc. However, you
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
12 may not sell it, or claim it as your own. Any commercial expoltation will
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
13 be prosectuted to the full extent of the law.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
14
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
15 Bob van der Poel Software
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
16
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
17 P.O. Box 57 P.O. Box 355
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
18 Wynndel, B.C. Porthill, ID
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
19 Canada V0B 2N0 USA 83853
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
20
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
21
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
22 To use the routines in this library, just include calls to them in your
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
23 programs with a "lbsr". For example, the following code segment calls a
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
24 library routine to print a number via standard out:
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
25
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
26 ldd number
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
27 lbsr PRINT_DEC
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
28
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
29 To use a routine make sure you have set up all the registers properly.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
30 None of the routines use any memory other than stated. Since the hardware
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
31 stack is used for all temporary variables all the routines are re-entrant
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
32 and shareable. It is up to the user to ensure an adequate stack area.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
33 Note that most of the routines have all uppercase names. It is hoped that
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
34 this will make your code more readable since you can tell at a glance
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
35 which routines are external.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
36
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
37 To compile an assembler program using the library first use RMA to
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
38 generate a ".r" file, then use RLINK to compile. A sample command line
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
39 would be:
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
40
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
41 rlink yourprog.a -o=yourprog -l=/d0/lib/alib.l
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
42
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
43 The file alib.doc is a formatted listing of all the commands available in
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
44 the library. Just list it to your printer.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
45
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
46 Included in the SRC directory is the file "makefile" which can be used
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
47 with MAKE to create a new library file. List "makefile" first to see
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
48 which directories, etc. you'll need.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
49
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
50 Also included on the disk is the file "LIB/alib.l". This is the complied
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
51 version of the library, ready for you to link with.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
52
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
53 If you have any comments or suggestions for future improvement--or even
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
54 if you want to send money (yes, I take contributions!)--please write me
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
55 at the above address or email bvdp@uniserve.com.
7d70b7e1cb21 Moved net and alib files into here
boisy
parents:
diff changeset
56