home *** CD-ROM | disk | FTP | other *** search
/ 8bitfiles.net/archives / archives.tar / archives / genie-commodore-file-library / C64-128Toolkit / CDT128.SFX / README < prev    next >
Encoding:
Text File  |  1990-02-12  |  9.7 KB  |  265 lines
  1.  
  2.  
  3.                                                                         
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                       ├─╘, ┴ ═EMORY ─EBUGGING ╘OOL
  11.  
  12.  
  13.  
  14. ╔╬╘╥╧─╒├╘╔╧╬
  15.  
  16.          ├─╘  IS  A  MEMORY DEBUGGING TOOL THAT IS DESIGNED TO RUN UNDER
  17.      THE ├-╨╧╫┼╥ (COPYRIGHT ╨RO-╠INE ╙OFTWARE) SHELL ENVIRONMENT. ╔T WAS
  18.      WRITTEN UTILIZING  THE  ├-╨╧╫┼╥  COMPILER  FOR  THE  ├OMMODORE  128
  19.      COMPUTER, IN AN ATTEMPT TO UTILIZE AND TEST AS MANY FEATURES OF THE
  20.      COMPILER  AS  POSSIBLE,  WHILE  MAINTAINING  THE FUNCTIONALITY OF A
  21.      FLEXIBLE DEBUGGER.  ╔NCLUDED  IN  THIS  PROGRAM  IS  THE  USAGE  OF
  22.      CONDITIONAL   COMPILATION,   UNIONS,   TYPEDEFS,  AND  POINTERS  TO
  23.      FUNCTIONS.
  24.      
  25.          ┴LTHOUGH ├─╘ WAS WRITTEN FOR THE ├OMMODORE 128 UTILIZING  A  40
  26.      COLUMN  DISPLAY,  CONDITIONAL  COMPILATION SWITCHES ARE PROVIDED IN
  27.      THE FILE DBUG.H, TO COMPILE VERSIONS FOR THE ├64 AND THE ├128 IN 80
  28.      COLUMN MODE. ╘HESE  VERSIONS  WERE  NOT  TESTED  AND  THEREFORE  NO
  29.      GUARANTEE IS MADE AS TO THEIR FUNCTIONALITY.
  30.      
  31.          ├─╘  PROVIDES  THE  USER  A  METHOD TO READ A BYTE FROM MEMORY,
  32.      WRITE  A  BYTE  TO  MEMORY,  DUMP   MEMORY   IN   HEX   AND   ASCII
  33.      REPRESENTATION,  HUNT FOR A BYTE OR CHARACTER STRING WITHIN MEMORY,
  34.      OR DISASSEMBLE MEMORY FOR THE 6502/8502. ┴LL OF THESE FUNCTIONS ARE
  35.      BANK SELECTABLE TO GIVE THE USER MAXIMUM FLEXIBILITY.
  36.      
  37.          ┼ACH OF THESE FUNCTIONS WILL BE DISCUSSED IN MORE DETAIL IN THE
  38.      DESIGN AND OPERATION SECTIONS BELOW.
  39.  
  40.  
  41. ─┼╙╔╟╬
  42.      
  43.          ├─╘ CONSISTS OF 15 FILES, ALL OF WHICH ARE NECESSARY TO COMPILE
  44.      AND LINK ├─╘.
  45.      
  46.           0. STDIO.H
  47.                ╘HIS IS THE STANDARD HEADER FILE PROVIDED WITH ├-╨╧╫┼╥.
  48.           1. DBUG.H
  49.                ╘HIS FILE CONTAINS GLOBAL DEFINES, A TEMPLATE FOR A UNION
  50.                UTILIZED  IN  PASSING  PARAMETERS  BETWEEN  THE   VARIOUS
  51.                FUNCTIONS OF ├─╘, MACRO DEFINITIONS USED WITH THIS UNION,
  52.                AND SOME TYPEDEFS.
  53.           2. CDT.C
  54.                ╘HIS  FILE  CONTAINS  THE  MAIN  FUNCTION.  ╔TS JOB IS TO
  55.                ACCEPT THE COMMAND LINE ARGUMENTS AND TO CALL THE  PROPER
  56.                FUNCTIONS TO PERFORM THE USER'S REQUEST.
  57.           3. GETARGS.C
  58.                ╘HIS  FILE  CONTAINS  THE FUNCTION THAT READS THE COMMAND
  59.                LINE ARGUMENTS INTO ┴╥╟╙, THE ARGUMENT UNION. ╔T  RETURNS
  60.                EITHER  A  ╬╒╠╠  IF  NO  ERROR IS ENCOUNTERED OR AN ERROR
  61.  
  62.  
  63.  
  64.                CDT, VERSION 1.0            1        (C)1986 ┴LAN ┘ORINKS
  65.  
  66.  
  67.  
  68.  
  69.                                ├─╘, A ├ ─EBUGGING ╘OOL                  
  70.  
  71.  
  72.  
  73.                VALUE.
  74.           4. PRñUSAGE.C
  75.                ╘HIS FILE CONTAINS THE FUNCTION WHICH PRINTS OUT AN ERROR
  76.                MESSAGE WHEN IT IS CALLED WITH AN INDEX  INTO  THE  ERROR
  77.                STRUCTURE.  ╔T  WILL  ALSO PRINT OUT A USAGE MESSAGE AS A
  78.                REMINDER TO THE USER. ╔T RETURNS NO VALUE.
  79.           5. CONV.C
  80.                ╘HIS FILE CONTAINS TWO FUNCTIONS WHICH ACT  AS  UTILITIES
  81.                TO  CONVERT  AN ASCII REPRESENTATION OF A HEX NUMBER TO A
  82.                TRUE INTEGER. ╔T IS PASSED A  POINTER  TO  CHARACTER  AND
  83.                RETURNS AN UNSIGNED INTEGER.
  84.           6. BYTEñSTRNG.C
  85.                ╘HIS  IS ANOTHER UTILITY WHICH CONVERTS A STRING OF ASCII
  86.                HEX BYTES TO TRUE UNSIGNED CHAR VALUES  TO  FACILITATE  A
  87.                BYTE STRING SEARCH.
  88.           7. PAGER.C
  89.                ╘HIS FUNCTION TESTS FOR PAGINATION IF NEEDED. ╨AGE LENGTH
  90.                IS  DEFINED  AS  20 LINES TO FACILITATE PAGINATION ON THE
  91.                SCREEN. ─UMP, FIND, AND DISASSEMBLE USE THIS OPTION.
  92.           8. OPCDñTBL.C
  93.                ╘HIS IS AN ARRAY OF CHARACTER STRINGS WHICH  CONTAIN  THE
  94.                OPCODE   NAME  AND  ADDRESSING  MODE  FOR  EACH  POSSIBLE
  95.                6502/8502 OPCODE. ╔T IS USED BY THE DISASSEMBLER.
  96.           9. DUMP.C
  97.                ╘HIS FUNCTION WILL DUMP A GIVEN RANGE OF MEMORY, WITHIN A
  98.                GIVEN BANK. ╔T PRINTS THE BYTES IN HEX REPRESENTATION AND
  99.                THEIR ASCII EQUIVALENT. ╔F  THE  BYTE  IS  UNPRINTABLE  A
  100.                PERIOD IS PRINTED.
  101.           10. READ.C
  102.                ╘HIS  FUNCTION READS A BYTE AT A SPECIFIED ADDRESS WITHIN
  103.                A GIVEN BANK. ╔T PRINTS THE ADDRESS AND BYTE IN  HEX  AND
  104.                AN ASCII CHARACTER IF IT IS PRINTABLE.
  105.           11. WRITE.C
  106.                ╘HIS  FUNCTION  WILL  WRITE  A BYTE TO A SPECIFIED MEMORY
  107.                LOCATION IN A GIVEN BANK. ╔T WILL  VERIFY  THE  WRITE  BY
  108.                READING  THE  LOCATION WRITTEN TO. ╔F VERIFICATION FAILS,
  109.                THE ERROR MESSAGE, "POSSIBLE WRITE ERROR, BYTE = ",  WILL
  110.                BE  PRINTED. ╘HIS IS TO WARN THE USER AN ATTEMPT MAY HAVE
  111.                BEEN MADE TO WRITE TO MEMORY THAT IS OVERLAYED WITH  ROM.
  112.                ╫HEN  READING  FROM SUCH A LOCATION THE ROM VALUE AND NOT
  113.                THE RAM VALUE IS RETURNED. ╘HIS  IS  A  FUNCTION  OF  THE
  114.                ├OMMODORE MACHINE AND NOT THE PROGRAM.
  115.           12. FIND.C
  116.                ╘HIS  FUNCTION  HUNTS  FOR THE SPECIFIED STRING, WITHIN A
  117.                GIVEN RANGE OF MEMORY WITHIN A GIVEN BANK. ╔T PRINTS  THE
  118.                STARTING  ADDRESS  IN HEX OF EACH OCCURENCE OF THE STRING
  119.                FOUND.
  120.           13. DASMBL.C
  121.                ╘HIS FUNCTION PERFORMS DISASSEMBLY OF A RANGE  OF  MEMORY
  122.                IN  A  GIVEN  BANK.  ╔T  PRINTS  THE HEX ADDRESS, THE HEX
  123.                OPCODE, THE MNEMONIC OF THE OPCODE AND  THE  OPERAND.  ╔F
  124.                THE OPCODE IS ILLEGAL, THE MNEMONIC, "???", IS PRINTED.
  125.           14. CDT.L
  126.                ╘HIS FILE CONTAINS THE LIBRARY NEEDED TO LINK ├─╘.
  127.  
  128.  
  129.  
  130.                CDT, VERSION 1.0            2        (C)1986 ┴LAN ┘ORINKS
  131.  
  132.  
  133.  
  134.  
  135.                         ├─╘, A ├ ─EBUGGING ╘OOL                         
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142. ├╧═╨╔╠╔╬╟ ┴╬─ ╠╔╬╦╔╬╟
  143.  
  144.          ├OMPILE ALL THE ".C" FILES. ╘HEN INVOKE THE LINKER. ╠INK CDT.O,
  145.      THEN  CDT.L,  AND  THEN  THE  NORMAL  SYSTEM  FUNCTIONS.  ╬AME  THE
  146.      EXECUTABLE FILE CDT.SH.
  147.  
  148.  
  149. ╒╙╔╬╟ ├─╘
  150.  
  151.          ├─╘ IS INVOKED WITH CDT -COMMAND PARAMETERS  -PAGINATION  FLAG.
  152.      ╘HE  PAGINATION FLAG, -P, IS OPTIONAL, AND WILL TURN OFF PAGINATION
  153.      FOR THE DUMP, FIND, AND DISASSEMBLE  COMMANDS.  ╔T  MAY  BE  PLACED
  154.      EITHER BEFORE OR AFTER THE EXECUTABLE COMMAND.
  155.      
  156.          ╬╧╘┼:  ┴LL  NUMERIC  PARAMETERS  MUST  BE  INPUT IN HEXADECIMAL
  157.      NOTATION.
  158.      
  159.          ├─╘ TRIES TO GIVE A MEANINGFUL ERROR MESSAGE IF  THE  INPUT  IS
  160.      INCORRECT.  ╞OR THE FIND BYTE STRING COMMAND, -B, AN EVEN NUMBER OF
  161.      NYBBLES IS EXPECTED, THEREFORE ALWAYS USE LEADING ZEROES.
  162.      
  163.          ┴LL COMMANDS MUST BE PRECEEDED  WITH  A  DASH  AND  ENTERED  AS
  164.      COMMAND LINE PARAMETERS.
  165.      
  166.          ╧NLY  ONE  EXECUTABLE  COMMAND MUST BE USED. ├─╘ DOES NOT CHAIN
  167.      COMMANDS.
  168.      
  169.          ╙OME TYPICAL COMMAND LINES MIGHT LOOK AS FOLLOWS:
  170.      
  171.      
  172.      CDT -M A000 A100 0
  173.           DUMP MEMORY FROM A000 TO A100 IN BANK 0.
  174.           
  175.      CDT -C HELP C000 FFFF E -P
  176.           FIND THE CHARACTER STRING "HELP" WITHIN C000 TO FFFF  IN  BANK
  177.           14. ╨AGINATION IS TURNED OFF.
  178.           
  179.           ╬OTE  THAT  IF  YOU  WISH  TO HUNT FOR A CHARACTER STRING THAT
  180.           CONTAINS SPACES, PUT THE  STRING  WITHIN  QUOTES.  ┴LSO,  THIS
  181.           VERSION  OF  ├─╘  ALLOWS  A  HUNT  STRING,  FOR EITHER BYTE OR
  182.           CHARACTER TO BE A MAXIMUM OF 16.
  183.           
  184.      ╚ERE  IS  A  SUMMARY  OF  THE  COMMAND  LINE  ARGUMENTS  AND  THEIR
  185.      PARAMETERS:
  186.       USAGE:
  187.              -P                        PAGE CONTROL OFF.                        
  188.              -R XXXX YY                READ BYTE AT ADDRESS XXXX IN BANK YY.    
  189.              -W XXXX YY ZZ             WRITE BYTE YY AT ADDRESS XXXX IN BANK ZZ.
  190.              -B VVVV... XXXX YYYY ZZ   FIND NUMERICAL BYTE STRING,VVVV          
  191.                                        IN ADDRESS XXXX THROUGH YYYY IN          
  192.                                        BANK ZZ.                                 
  193.  
  194.  
  195.  
  196.      CDT, VERSION 1.0                 3             (C)1986 ┴LAN ┘ORINKS
  197.  
  198.  
  199.  
  200.  
  201.                               ├─╘, A ├ ─EBUGGING ╘OOL                   
  202.  
  203.  
  204.  
  205.              -C "ABC..." XXXX YYYY ZZ  FIND ALPHA STRING, ABC..., IN ADDRESS    
  206.                                        XXXX THROUGH YYYY IN BANK ZZ.            
  207.              -M XXXX YYYY ZZ           DUMP MEMORY FROM ADDRESS XXXX THROUGH    
  208.                                        YYYY IN BANK ZZ.                          
  209.              -D XXXX YYYY ZZ           DISASSEMBLE MEMORY FROM ADDRESS XXXX     
  210.                                        THROUGH YYYY IN BANK ZZ.                  
  211.      
  212.      ╞OR A QUICK SUMMARY OF ├─╘'S COMMANDS, JUST TYPE IN CDT WITHOUT ANY
  213.      PARAMETERS, AND CDT WILL PRINT ONE FOR YOU.
  214.      
  215.      
  216. ├╧╨┘╥╔╟╚╘ ╬╧╘╔├┼ ┴╬─ ─╔╙╘╥╔┬╒╘╔╧╬
  217.  
  218.      ┼ACH FILE CONTAINS THE FOLLOWING COPYRIGHT NOTICE:
  219.      
  220.      
  221.      /***********************************************************************/
  222.      /***********************************************************************/
  223.      /*                                                                     */
  224.      /* ╘HIS PROGRAM IS COPYRIGHT 1986 BY ┴LAN ┘ORINKS.  ╔T MAY BE FREELY   */
  225.      /* DISTRIBUTED FOR NON COMMERCIAL USAGE IF THIS COPYRIGHT NOTICE IS    */
  226.      /* LEFT INTACT. ├OMMERCIAL USAGE OF THIS PROGRAM IS EXPLICITLY         */
  227.      /* FORBIDDEN WITHOUT THE WRITTEN PERMISSION OF THE AUTHOR.             */
  228.      /*                                                                     */
  229.      /***********************************************************************/
  230.      /***********************************************************************/
  231.      
  232.          ╘HE  AUTHOR MAINTAINS ALL RIGHTS TO THIS PROGRAM, HOWEVER FULLY
  233.      ENCOURAGES ITS FREE DISTRIBUTION FOR NON COMMERCIAL USAGE.
  234.      
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.      CDT, VERSION 1.0                 4             (C)1986 ┴LAN ┘ORINKS
  263.  
  264.  
  265.