home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / enterprs / cpm / sigm / sigmv801.ark / XREF.DOC < prev    next >
Encoding:
Text File  |  1986-02-01  |  6.1 KB  |  163 lines
  1. TOPIC:    XREF36
  2.  
  3. FROM:     LUCIEN L. PAN
  4.  
  5. DATE:     1983/10/18
  6.  
  7.  
  8. INTRODUCTION:
  9. ------------
  10.  
  11.      XRE╞á i≤á ß cross-referencσ utilit∙ designeΣ t∩á generatσá ß ì
  12. listinτá filσ whicΦ contain≤ valuablσ informatioε tha⌠ caε bσá oµ ì
  13. help to the assembly language programmer.
  14.  
  15.      I⌠á use≤á fo≥ inpu⌠ thσ '.PRNº filσ createΣ b∙ aεá assemble≥ ì
  16. anΣá write≤á ou⌠ ß modifieΣ filσ whicΦ i≤ identica∞ t∩ thσá inpu⌠ ì
  17. excep⌠á fo≥ aε identifyinτ numbe≥ anΣ somσá cosmetiπá formatting¼ ì
  18. fo≥ eacΦ sourcσ linσ encountered«á A⌠ thσ enΣ oµ input¼ XRE╞ wil∞ ì
  19. outpu⌠ ß report¼ listinτ eacΦ symbo∞ anΣ thσ linσ number(s⌐ wherσ ì
  20. thσá symbo∞á wa≤á referenced«á Thi≤á repor⌠ caεá bσá useΣá a≤á aε ì
  21. importan⌠á diagnostiπ too∞ facilitatinτ thσ tasδ oµ debugginτá aε ì
  22. assembl∙ program.
  23.  
  24.  
  25. FEATURES:
  26. --------
  27.  
  28.      Duσá t∩ thσ (relatively⌐ simplσ objective≤ oµ thi≤á program¼ ì
  29. sucΦá a≤á numberinτ eacΦ individua∞ linσ anΣ buildinτ ß tablσá oµ ì
  30. symbol≤ witΦ reference≤ t∩ wherσ the∙ arσ beinτ used¼ mos⌠ oµ thσ ì
  31. 'polishingºá i≤á aimeΣ towarΣ gettinτ ß nice-lookinτá listinτá a≤ ì
  32. output.
  33.  
  34.      Followinτá i≤á ß shor⌠ descriptioε oµ somσ oµá thσá feature≤ ì
  35. offered in this utility:
  36.  
  37. áááá-    Provide≤á ßá filenamσá banne≥ oε thσ firs⌠ pagσá oµá thσ ì
  38. áááálisting¼á whicΦá wheεá foldeΣá iε halµ (oεá thσá prope≥á pagσ ì
  39. ááááparity⌐á double≤ a≤ aε excellen⌠ prograφá listinτá separator¼ ì
  40. ááááallowinτá eas∙ indexinτ througΦ ß pilσ oµ printout≤ wheε the∙ ì
  41. ááááarσ helΣ togethe≥ iε ß binder.
  42.  
  43. áááá-    Thσá linσá identificatioεá numbe≥á appear≤á betweeεá thσ ì
  44. ááááobjec⌠ codσ expansioε anΣ thσ actua∞ sourcσ code«á Thi≤ iε m∙ ì
  45. ááááopinion¼á give≤á thσ thσ fina∞ listinτ ß morσ attractivσ looδ ì
  46. ááááb∙á makinτá i⌠ les≤ crowded«á I⌠á definitivel∙á improve≤á thσ ì
  47. ááááappearancσá oµá ß '.PRNº filσ froφ MA├ (tm)¼á a≤ therσ i≤á n∩ ì
  48. ááááblanδá spacσá betweeεá thσá objec⌠á anΣá sourcσá fielΣá (wheε ì
  49. áááádefininτá ßá strinτ greate≥ thaε ╡ character≤á iεá ßá labeleΣ ì
  50. áááásourcσ linσ fo≥ example).
  51.  
  52. áááá-    Sadly¼á mos⌠á assembler≤ tha⌠ I'vσ seeε d∩ no⌠ repor⌠á ß ì
  53. áááásummar∙ oµ errors¼ the∙ jus⌠ flaτ them« MA├ (tm⌐ report≤ theφ ì
  54. áááát∩ thσ consolσ a≤ the∙ arσ encountereΣ anΣ fortunately¼á CP/═ ì
  55. ááááallow≤ yo⌡ t∩ senΣ i⌠ t∩ thσ harΣ cop∙ device«á Howeve≥á tha⌠ ìèáááástil∞á doesn'⌠á tel∞ yo⌡ wherσ thσ error≤ arσ locateΣ iεá thσ ì
  56. áááálistinτá causinτá mucΦá timσ beinτá wasteΣá 'eyeballingºá thσ ì
  57. ááááprintout«á XRE╞ wil∞ automaticall∙ executσ ß seconΣ pas≤ wheε ì
  58. ááááerror(s⌐ werσ detecteΣ iε thσ firs⌠ pass¼á thi≤ timσá listinτ ì
  59. ááááonl∙á thσ line≤ containinτ thσ error(s⌐ alonτ witΦ thei≥ linσ ì
  60. ááááid«á numbers«á Yo⌡á als∩ havσ thσ optioε t∩ lis⌠á onl∙á erro≥ ì
  61. áááálines¼ fast!
  62.  
  63. áááá-    ┴á listinτ t∩ disδ i≤ implementeΣ anΣ i≤ usefu∞ t∩ thosσ ì
  64. ááááwh∩á usσá disδ spoolinτ beforσá printing«á T∩á conservσá disδ ì
  65. ááááspace¼á ß taΓ compression/expansioε drive≥ is included« I⌠ i≤ ì
  66. ááááßá desirablσá featurσ sincσ MA├ (tm⌐ onl∙ use≤ space≤ iεá thσ ì
  67. ááááobjec⌠á field¼á o≥á eveε worse¼á MACROI╔á (tm⌐á expand≤á tab≤ ì
  68. ááááthroughou⌠á thσ entirσ fileíá I'vσ typicall∙ seeε somσá spacσ ì
  69. ááááreductioε iε thσ orde≥ oµ 40%« 
  70.  
  71.  
  72. INSTALLATION:
  73. ------------
  74.  
  75.      XREF3╢á i≤ supplieΣ iε sourcσ codσ anΣ compileΣ object«á Thσ ì
  76. contents of the library are:
  77.  
  78.           XREF36.DOC
  79.           XREF36.AQM
  80.           XREFM.COM           (for MAC)
  81.           XREFT.COM           (for MACROII)
  82.  
  83.      Duσá t∩á thσ incompatibilit∙ betweeε MA├á (tm⌐á anΣá MACROI╔ ì
  84. (tm)¼á thσá compileΣ objec⌠ caε onl∙ handlσ onσ forma⌠ a⌠ ßá timσ ì
  85. anΣá i≤á specifieΣá a⌠ assembl∙ timσ b∙ settinτá thσá TD╠á symbo∞ ì
  86. equatσá t∩ eithe≥ truσ o≥ false«á Yo⌡ caε als∩ specif∙ thσ numbe≥ ì
  87. of lines per page by changing the symbol PGLEN.
  88.  
  89.      Fo≥á thosσá usinτá MA├ (o≥á ASM)¼á re-assembl∙á oµá XRE╞á i≤ ì
  90. straightfoward¼á requirinτá onl∙á tha⌠ thσ TD╠ symbo∞ bσá se⌠á t∩ ì
  91. false.
  92.  
  93.      Fo≥ thosσ usinτ MACROII¼ ß sligh⌠ modificatioε t∩ thσ macro-ì
  94. assemble≥áá objec⌠á modulσá (.COM⌐á itselµá i≤áá required«áá Ful∞ ì
  95. explanation≤á arσ giveε iε thσ sourcσ file«á Obviously¼á thσá TD╠ ì
  96. symbol must be set to true.
  97.  
  98.  
  99. OPERATION:
  100. ---------
  101.  
  102.      Thσá operatioεá oµá XRE╞á i≤á ver∙á simplσá a≤á i⌠á wil∞á bσ ì
  103. illustrated in the following examples:
  104.  
  105.      A help display is available by entering:
  106.  
  107.           A0>XREF <CR>
  108.  
  109.      It will also appear if an error option is detected.
  110. è
  111.      To cross-reference a file to the printer, just type:
  112.  
  113.           A0>XREF MYFILE <CR>
  114.  
  115.      XRE╞á wil∞ assumσ aε extensioε oµ '.PRNº iµ n∩ filσ typσá i≤ ì
  116. specified« T∩ ente≥ ß nul∞ filetype¼ jus⌠ typσ ß '.º (dot⌐ a≤ thσ ì
  117. only extension.
  118.  
  119.      To send the output to a disk file, just append the option:
  120.  
  121.           B0>XREF MYFILE /D
  122.  
  123.      Thσá listinτá filσ wil∞ bσ createΣ oε thσ curren⌠ drivσá anΣ ì
  124. wil∞ bea≥ thσ samσ filenamσ bu⌠ wil∞ havσ ß '.LSTºá filetype«á Iε ì
  125. thσá disδá mode¼á tab≤ arσ alway≤ substitueΣ fo≥ blank≤á wheneve≥ ì
  126. possible (tab compression).
  127.  
  128.      Thσá drivσá designator≤ synta° follow≤ thσá onσá defineΣá b∙ ì
  129. CP/M:
  130.           A0>b:xref c:myfile d:/d
  131.  
  132.      WoulΣá ge⌠ XRE╞ froφ drivσ B¼á thσ PR╬ filσ froφ drivσ ├ anΣ ì
  133. send the LST file to disk D.
  134.  
  135.      The rest of the available options are self-explanatory.
  136.  
  137.  
  138. LIMITATIONS:
  139. -----------
  140.  
  141.      Fo≥á thσá TD╠ versioε oµ XRE╞ (writteεá iεá MA├á mnemonics)¼ ì
  142. there are some non standard factors:
  143.  
  144.      XRE╞á canno⌠á detec⌠ tha⌠ tex⌠ betweeε ß .REMAR╦á shoulΣá bσ ì
  145. interpreteΣá a≤á ß 'multi-lineº commen⌠ s∩ herσ i≤ ß wa∙á t∩á ge⌠ ì
  146. arounΣá it╗á jus⌠ inser⌠ '*º a⌠ thσ beginninτ oµ eacΦ sourcσ linσ ì
  147. tha⌠ i≤ bracketeΣ iε ß .REMAR╦ pseudo-op« Actually¼ ß wholσ framσ ì
  148. of '*' can be put around the text and looks quite nice.
  149.  
  150.      I⌠ i≤ als∩ difficul⌠ t∩ accep⌠ '.º a≤ ß lega∞ globa∞á symbo∞ ì
  151. althougΦá TDL'≤ synta° allow≤ i⌠ (bu⌠ '.º doesn'⌠ sho≈ u≡ iεá thσ ì
  152. symbo∞ tablσ generateΣ b∙ MACROII)«á Thi≤ i≤ duσ t∩ thσ fac⌠ tha⌠ ì
  153. '.º i≤ als∩ useΣ a≤ thσ basσ 1░ specifie≥ anΣ als∩ a≤ thσ curren⌠ ì
  154. program address counter key.
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162. * MAC and CP/M are trademarks of DIGITAL RESEARCH INC.
  163. * MACROII and TDL are trademarks of COMPUTER DESIGN LABS INC.
  164.