home *** CD-ROM | disk | FTP | other *** search
/ POINT Software Programming / PPROG1.ISO / misc / inter41 / int2whlp / i2w-hint.txt < prev    next >
Encoding:
Text File  |  1994-05-31  |  4.8 KB  |  137 lines
  1. This is a sort of a guide to using the INT2WHLP precompiler. INT2WHLP
  2. transfers Ralf Brown's Interrupt List to some RTF (Rich-Text Format) files
  3. which can be used as input for Microsoft's HC31 WINHELP file compiler.
  4.  
  5. This text gives also some hints on using the the results of the compilation.
  6.  
  7.  
  8. COMPILATION
  9.  
  10. The easy way to compile the list is this:
  11.  
  12. Change to the directory where you want your INTWIN.HLP file. There should
  13. be at least 16 Mb free space on the disk. It can be the directory with the
  14. Interrupt List files (which we will call the Source Directory), but it is
  15. better to use a separate directory not to mess up the Source Directory. A
  16. subdirectory under the Source Directory would be fine. Copy the following
  17. files to the directory:
  18.     INTWIN.BAT
  19.     INT2WHLP.EXE
  20.     INT2WHLP.CFG
  21.     SEL_TOPC.RTF
  22.     MISC_INF.RTF
  23.     INTWIN.PH
  24. It is handy also to have:
  25.     I2W-FILE.TXT
  26.     I2W-HINT.TXT (this file)
  27.     I2W-CFG.TXT
  28.     I2W-OPT.TXT
  29. in the directory. For a partial compilation of the List, FLT_METH.RTF is
  30. required (see paragraph FLT_METH.RTF in I2W-FILE.TXT).
  31.  
  32. Make sure that the following files are in the Source Directory:
  33.     INTERRUP.LST or INTERRUP.A, INTERRUP.B, ...
  34.     INTERRUP.1ST
  35.     CATEGORY.KEY
  36.     OVERVIEW.LST
  37.     INTERRUP.PRI
  38.     PORTS.LST
  39.     MEMORY.LST
  40.     86BUGS.LST
  41.     CMOS.LST
  42.     GLOSSARY.LST
  43. where INTERRUP.LST is the concatenation of INTERRUP.A, INTERRUP.B, ... .
  44.  
  45. Make sure that HC31.EXE is somewhere on the DOS path.
  46.  
  47. Type
  48.     INTWIN
  49. at the DOS prompt to start the compilation. On a 486/33MHz computer it
  50. takes INT2WHLP 1 1/2 minut to precompile release 41 of the List, and it
  51. takes HC31 40 minutes to create the INTWIN.HLP file.
  52.  
  53.  
  54. CONFIGURATION
  55.  
  56. The INT2WHLP program lets you personalize your INTWIN.HLP file, se the files
  57. I2W-CFG.TXT and I2W-OPT.TXT.
  58.  
  59.  
  60. COMPRESSION
  61.  
  62. The HC31 program supports three levels of compression: high, medium, and
  63. none. Medium compressed and uncompressed files are about 15% and 100%
  64. longer than highly compressed files, respectively. HC31 can use an existing
  65. file with compression information (a PH file), and it needs not to be
  66. exactly up-to-date. Compiling release 41 with a PH file from release 40
  67. gives a file about 4% longer than a compilation with an up-to-date PH file.
  68. The INTWIN.PH compression information file included with release 41 is based
  69. on a 41 beta release of the Interrupt List, and it is recommended to use
  70. high compression based on that file. It takes HC31 40 minutes to compile the
  71. List on a 486/33MHz computer, it will compile if there are 16 Mb of free
  72. disk space, and INTWIN.HLP will be about 4 Mb. Creating a new INTWIN.PH file
  73. takes 20 minutes and requires more than 28 MB of free disk space, but less
  74. than 70 Mb.
  75.  
  76.  
  77. HIGH RESOLUTION SCREENS
  78.  
  79. The default settings allow you to display the List on a normal 640x480 VGA
  80. screen without the need of horizontal scroll. If you use a high resolution
  81. screen with small dimensions, you might want to use a larger font. The file
  82. package I2W-TEST.ZIP contains files that let you experiment with different
  83. fonts with very short INT2WHLP and HC31 compilation times.
  84.  
  85. Unzip the package to a subdirectory under your INT2WHLP directory and read
  86. its README file.
  87.  
  88.  
  89. INTWIN's TOPIC SEARCH FACILITIES
  90.  
  91. INTWIN facilitates seaching interrupt topics with many different keys, based
  92. on:
  93.     a. Elements in the interrupt header line.
  94.     b. Keys in the file CATEGORY.KEY for the appropriate interrupt
  95.        category.
  96.     c. Combinations of interrupt number and register contents.
  97.  
  98. For example,
  99.  
  100. --------O-214302-----------------------------
  101. INT 21 - DR-DOS 3.41+ internal - GET ACCESS RIGHTS
  102.         AX = 4302h
  103.  
  104. will be listed with the following search keys:
  105.     DR-DOS 3.41+ internal        \ a
  106.     GET ACCESS RIGHTS        /
  107.     other operating systems        \ 
  108.     non-standard operating systems      b
  109.     operating systems (non-standard)/
  110.     INT 21 AX = 4302        \
  111.     INT 21 AH = 43             \
  112.     INT 21        *)          \
  113.     21 4302                   \ c
  114.     21 43                   /
  115.     21        *)          /
  116.     AX = 4302             /
  117.     AH = 43                /
  118. *) WINHELP lists only the first 400 search hits.
  119.  
  120.  
  121. TABLE CROSS-REFERENCES
  122.  
  123. New in the Interrupt List release 41 are numbered tables, and an interim
  124. cross-reference solution was implemented in INT2WHLP. The cross-reference
  125. is to the interrupt, where the table is defined, and therefore many of the
  126. references are "references to self" and thus not very useful. However,
  127. the cross-references are useful when the table is defined at another
  128. interrupt, and there are a couple of indicators for that:
  129.     1. If the reference "#nnnn" is followed by " at xxxx" the table is
  130.        defined at another interrupt, and the hotspot cross-reference is
  131.        useful.
  132.     2. If the text in the window is short and no (Table nnnn) appear
  133.        after the "SeeAlso" paragraph, apparently the table was defined
  134.        somewhere else, and the hotspot cross-reference is useful.
  135. In other cases, page down through the text to look for the table before
  136. you click on the hotspot.
  137.