home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / icat.zip / icatos2.zip / icatos2 / readme.txt
Text File  |  2000-11-28  |  5KB  |  138 lines
  1.  
  2. README.TXT
  3. ----------
  4.  
  5.  
  6. See ICAT home page for more details - http://service.boulder.ibm.com/icat
  7.  
  8.  
  9. .SYM FILE PROCESSING
  10.                             
  11. ICAT now enables you to view limited symbol information in the Disassembly
  12. view of an executable file compiled with no debug information if a separate
  13. symbol file is supplied.  Using the link symbol information from a separate
  14. (*.sym) file, function names are annotated to the disassembly lines for
  15. function calls and function entry points making it easier for you to navigate
  16. through disassembly code.
  17.  
  18. To enable viewing of the symbol information in Disassembly view, set up the
  19. host and target machines.  Then place a copy of the symbol (*.sym) file in the
  20. same subdirectory pointed to by the CAT_HOST_BIN_PATH environment variable on
  21. the host.
  22.  
  23. Whether the executable is located on the target machine or is on both the host
  24. and target machines, there is no difference in performance.  Currently, the
  25. symbol file must be located on the host machine.
  26.  
  27. If the executable to be debugged was compiled to enable a separate map file to
  28. be generated, then the symbol file is obtained by running the MapSym.exe
  29. utility on that map (*.map) file.  Make certain that the symbol file has the
  30. same name as the executable.
  31.  
  32.  
  33.  
  34. UDP COMMUNICATIONS
  35.  
  36. In order to connect to the target machine via UDP, the following two
  37. environment variables on the host machine must be modified from their settings
  38. for serial communications:
  39.  
  40. set CAT_MACHINE=x.x.x.x:nnnn
  41. set CAT_COMMUNICATION_TYPE=UDP
  42.  
  43. where x.x.x.x is the IP address of the target machine, and
  44.       nnnn is the KDB port number.
  45.  
  46. The value of 1000 is suggested for the KDB port number.
  47.  
  48. Also, KDBNET.SYS must be installed on the target system, as per the following
  49. steps:
  50.  
  51. 1) In CONFIG.SYS, locate the line containing PROTMAN.OS2
  52.  
  53. 2) After this line, enter:
  54.  
  55.    DEVICE=x:\y\KDBNET.SYS /V /Id.d.d.d /Ppppp
  56.  
  57.    where x and y are the drive letter and path to the directory where you
  58.          wish to store KDBNET.SYS. The IBMCOM subdirectory is probably the
  59.          most convenient place to put it.
  60.  
  61.          d.d.d.d is the IP address of the target machine
  62.  
  63.          pppp is the port number on which KDBNET will accept UDP data
  64.          (1000 is the recommended port number)
  65.  
  66. 3) Locate the PROTOCOL.INI file, which should be in the IBMCOM subdirectory.
  67.  
  68. 4) In the stanza that begins with [IBMLXCFG], add the following line:
  69.  
  70.    kdbnet_nif = kdbnet.nif
  71.  
  72. 5) Add a new stanza to PROTOCOL.INI:
  73.  
  74. [KDBNET_nif]
  75.  
  76.    Bindings = IBMFEEO2_nif
  77.    DriverName = KDBNET$
  78.    KDBIPADDR = "d.d.d.d"
  79.    KDBSNETMASK = "255.255.248.0"
  80.    KDBPORT = 1000
  81.    NMPORT = 1001
  82.    BCASTNOTIFY = "YES"
  83.    NNOACTION = "C"
  84.  
  85.    where d.d.d.d is replaced with the IP address of the machine.
  86.  
  87. 6) Look at the other stanzas of the PROTOCOL.INI file. If the value of
  88.    "Bindings =" is something other than IBMFEE02_nif, use that value instead
  89.    of IBMFEE02_nif.
  90.  
  91. 7) Copy the file KDBNET.NIF to the IBMCOM\PROTOCOL subdirectory.
  92.  
  93. 8) Reboot the target machine. If KDBNET is properly installed, you should see
  94.    a "banner" during the bootup process.
  95.  
  96.  
  97. NOTE!  Don't reboot the target machine from ICAT's File pulldown if KDBNET.SYS
  98. is installed on that target.  ICAT and KDB and KDBNET.SYS can't resync in this
  99. manner.
  100.  
  101.  
  102. Note! limitations using KDBNET.SYS/ICAT UDP debugging:
  103.  
  104. On the target machine, KBDNET.SYS does not function until the RUN=NETBIND.EXE
  105. has been completed.  This occurs AFTER all device drivers have been loaded and
  106. initialized, therefore ICAT thru KBDNET.SYS cannot be used to debug device
  107. driver loading or initialization.
  108.  
  109. The CONFIG.SYS contains a RUN=\IBMCOM\PROTOCOL\NETBIND.EXE statement.  After
  110. NETBIND.EXE is run, UDP packets will be available for KDBNET.SYS to examine.
  111. Therefore, the earliest one can use ICAT in UDP mode is after NETBIND.EXE has
  112. completed.  To debug a device driver during system initialization time, one
  113. must use ICAT in serial mode.
  114.  
  115.  
  116. HELP AND MESSAGE FILE NOTE
  117.  
  118. Special note!  If you have a country code page that is described by the
  119. following matrix, ICAT will look for its help and message files accordingly:
  120.  
  121.  
  122.       Japan       GAM5HELJ.HLP     GAM5LDEJ.MSG
  123.  
  124.       Taiwan      GAM5H088.HLP     GAM5L088.MSG
  125.  
  126.       France      GAM5H033.HLP     GAM5L033.MSG
  127.  
  128.       Germany     GAM5H049.HLP     GAM5L049.MSG
  129.  
  130.       China       GAM5H086.HLP     GAM5L086.MSG
  131.  
  132.  
  133. In these instances, you can rename GAM5HELP.HLP to GAM5HELJ.HLP and GAM5LDE.MSG
  134. to GAM5LDEJ.MSG (in the case of a Japan country code page).  ICAT looks for
  135. these files because it is possible that in the future, IBM will provide
  136. translated modules for these countries.
  137.  
  138.