home *** CD-ROM | disk | FTP | other *** search
/ POINT Software Programming / PPROG1.ISO / misc / inter41 / int2whlp / i2w-cfg.txt < prev    next >
Encoding:
Text File  |  1994-05-29  |  11.8 KB  |  274 lines
  1. ; The INT2WHLP configuration file has sections and entries similar to
  2. ; Windows INI files.
  3. ; Sections have identifiers enclosed in brackets [], starting at the left
  4. ; margin. A section extends up to the next line starting with a left
  5. ; bracket [ at the left margin.
  6. ; Entries have identifiers starting at the left margin and extending up
  7. ; to an equal sign =. The value of an entry is the string or integer after
  8. ; the equal sign. INT2WHLP interprets digit 0 as boolean value false and
  9. ; any non-zero integer as boolean true when interpreted with the
  10. ; profileBoolean() procedure.
  11. ; Section and entry identifiers are not case sensitive, however spaces
  12. ; are significant caracters in identifiers. There may not be excessive
  13. ; spaces around the equal sign in entries (i.e. only spaces which are part
  14. ; of the identifier or value).
  15. ; A semicolon ; at the left margin identifies a comment.
  16.  
  17. ; In the following text enabled identifiers specify default program
  18. ; settings (unless otherwise noted), and commented-out identifiers are
  19. ; examples of valid values.
  20.  
  21. ; The FILES section specifies the pathes for the input and output files.
  22. ; These values can also be specified as program parameters, program
  23. ; parameters take precedence over values defined in the configuration
  24. ; file. The program will request values if neither program parameters,
  25. ; nor the configuration file, define values.
  26. [FILES]
  27. inPath=
  28. ; inPath=c:\interrup
  29. ; The input files are in directory C:\INTERRUP.
  30. outPath=
  31. ; outPath=.
  32. ; Pass the output files to the current directory.
  33.  
  34. ; The OPTIONS section specifies values which can also be set by program
  35. ; parameter options. Program paramter options take precedence over values
  36. ; specified in the configuration file.
  37. [OPTIONS]
  38. build=
  39. ; build=(WINENV | APP1) & TESTBUILD
  40. ; Copies the build expression to the HPJ file's [OPTIONS] section build=
  41. ; entry. See also the [BUILDTAGS] section. Program option -b. Note that
  42. ; the OR operator "|" cannot be passed as a program option, only the
  43. ; configuration file can pass the OR operator to the program.
  44. compression=none
  45. ; compression=medium
  46. ; compression=high
  47. ; Sets HC31 compression option. Program option -c.
  48. filterFile=
  49. ; filterFile=INTWIN.FLT
  50. ; Should be empty for a compilation of the entier Interrupt List, or define
  51. ; a filter file for a partial compilation. Program option -f.
  52. ; NOTE! It is recommended not to perform a partial compilation because
  53. ; references to tables may be missing.
  54. singlesInMain=0
  55. ; singlesInMain=1
  56. ; If 1, interrupt numbers with only one entry are inserted directly in the
  57. ; compressed index rather than a reference to a one-entry subindex, provided
  58. ; that the number of compressed index columns is set to 1. singlesInMain=1
  59. ; may be an advantage for a strongly filtered list. Program option -1.
  60. twoIndexes=1
  61. ; twoIndexes=0
  62. ; Enables or disables the expanded index. Program option -2.
  63. errorLog=0
  64. ; errorLog=1
  65. ; Disables or enables HC31's log file OutPath\INTWIN.ERR. Program option -e.
  66. headers=1
  67. ; headers=0
  68. ; If 1, insert a header for each new interrupt number in the expanded index.
  69. ; Program option -h.
  70. indexColumns=1
  71. ; indexColumns=4
  72. ; indexColumns=8
  73. ; indexColumns=16
  74. ; Specifies the number of columns in the compressed index. Program option -i.
  75. equalBlanks=1
  76. ; equalBlanks=0
  77. ; Specifies whether or not spaces are inserted around the equal sign in
  78. ; register search strings, e.g. "INT 21 AH = 4C" or "INT 21 AH=4C". Program
  79. ; option -q.
  80. scrollIndexTitle=1
  81. ; scrollIndexTitle=0
  82. ; Index windows have a general header and a title. If scrollIndexTitle=1,
  83. ; the title scrolls with the rest of the index window, otherwise the title
  84. ; is part of the non-scrolling header region. Program option -s.
  85.  
  86. ; The CONFIG section defines WINHELP setups and defaults.
  87. [CONFIG]
  88. pos and size=
  89. ; pos and size=(0,0,980,1023)
  90. ; Defines the position and size of the initial window. The format is
  91. ; (xpos,ypos,width,height) and valid values are 0..1023, defining 1024th
  92. ; of the screen witdh and hight.
  93. background=
  94. ; background=(255,255,255)
  95. ; Defines the background color of the normal text window in the format
  96. ; (red,green,blue). Valid values are 0..255. (255,255,255) defines a
  97. ; white background color.
  98. header background=
  99. ; header background=(255,255,192)
  100. ; Defines the background color of the non-scrolling part of the windows.
  101. ; (255,255,192) defines a light yellow color.
  102. text font=modern Courier New
  103. ; Defines the font used for the plain text. Due to the tables in the
  104. ; Interrupt List, this should be a fixed pitch font, and because it should
  105. ; be a TrueType font to take advantage of the font sizing, Windows 3.1
  106. ; has no alternatives. "modern" is the font family (modern=fixed pitch,
  107. ; roman=proportionally spaced serif, swiss=proportionally spaced sans serif),
  108. ; and "Courier New" is the font name.
  109. ; If point size 10 or 12 (see deciPoints) is used, the bitmapped font
  110. ; "modern Courier" can be used, though.
  111. header font=roman Times New Roman
  112. ; header font=swiss Arial
  113. ; Font used for headers.
  114. deciPoints=90
  115. ; deciPoints=95
  116. ; deciPoints=100
  117. ; deciPoints=120
  118. ; 10 times the font point size. A 9 point font can be displayed on a
  119. ; standard VGA screen without the need of horizontal scroll. The point
  120. ; size is not true typographical point size, it varies with screen
  121. ; resolution and size, and a larger point size is preferable for a high
  122. ; resolution screen with small dimensions. HC31 assigns size in half-points,
  123. ; corresponding to deciPoints increments of 5.
  124. header deciPoints=140
  125. header 2nd deciPoints=120
  126. ; Two font sizes used in the headers.
  127.  
  128. ; The WINDOWS section defines the number of extra "windows" included in
  129. ; the compilation in addition to the Interrupt List.
  130. [WINDOWS]
  131. number=4
  132. ; Number of additional windows (5 are defined, but only 4 enabled).
  133. ; NB! number=0 is the program default, and the following windows are not
  134. ; defined by default.
  135.  
  136. ; For each window defined by the [WINDOWS] number=n entry, there must be
  137. ; a section [WINDOW 1], ... [WINDOW 9], [WINDOW 10], ... [WINDOW n] with
  138. ; 3 obligatory entries and some optional entries.
  139. [WINDOW 1]
  140. title=Ports
  141. id=idPorts
  142. ; title and id are obligatory entries defining the topic title and
  143. ; identifier (context string). [WINDOW i] sections with an empty title=
  144. ; or id= entry are ignored, and a warning is printed on the screen.
  145. type=2
  146. ; There are 3 window types: type=1 are single entry windows referenced
  147. ; directly from the main index. type=1 is the default type. type=2 are
  148. ; windows with their own index, which is referenced from the main index.
  149. ; The differences between type=1 and type=2 are the browse chain linkage
  150. ; and the default "file n type=" value. type=3 defines a window with at
  151. ; least one RTF file defining the window properties. The RTF file must
  152. ; have a topic with the identifier (context string) defined by id=, and
  153. ; that topic should have a title defined by title= and contain an index
  154. ; for the system.
  155. ; files=1
  156. ; The entry files= defines the number of files included in the current
  157. ; window. Only type=3 windows can have more than one file, and files=1 is
  158. ; the default value.
  159. file 1=ports.lst
  160. ; For each file i = 1..n defined by the files=n entry (normally only 1)
  161. ; there must be a file i=<file name> entry specifying a file. See a later
  162. ; paragraph about default directories.
  163. ;
  164. ; file 1 type=2
  165. ; There are 4 file types: file i type=1 are files passed to the program's
  166. ; ProcessFile() procedure. file i type=2 are files passed to the program's
  167. ; ProcessPort() procedure. file i type=3 are RTF files defining their own
  168. ; and other included files' properties. file i type=4 are files assigned
  169. ; their own titles and identifiers (context strings). type=4 files are
  170. ; passed to the program's ProcessFile() procedure, and they should be
  171. ; referenced from an RTF file.
  172. ; The default file i type= value is the window's type= value.
  173. ; Files' default directories depend on the file types. File types 1 and 2
  174. ; are typically files included in the Interrupt List: PORTS.LST, MEMORY.LST
  175. ; etc. Therefore, the default directory for file types 1 and 2 are the
  176. ; InPath directory. File type 3 are typically the user's own file or one
  177. ; of the RTF files supplied in this package, so the default directory
  178. ; is 1) the current directory or 2) INT2WHLP's home directory. File type
  179. ; 4 are the users own files, and the default directory is the current
  180. ; directory.
  181. ; In all cases the full path (a path including a drive, the root, or the
  182. ; current or parent directory . or ..) can be specified to override the
  183. ; default directory.
  184. ;
  185. ; file i title=<title>
  186. ; file i id=<id>
  187. ; file i chain=<browse chain>
  188. ; Type 4 files have titles, identifiers, and browse chain definitions.
  189. ; The default values are "<window title> - i", "<window id>_i", and
  190. ; "<window id>:5" where i is the current file number. The empty value is
  191. ; legal for file i chain= and causes the file to be excluded from any
  192. ; browse chain.
  193.  
  194. [WINDOW 2]
  195. title=Memory
  196. id=idMemory
  197. ; type=1 is the default window type
  198. ; files=1 is the default number of files
  199. file 1=memory.lst
  200. ; file 1 type=1 is the default type because the window type is 1.
  201.  
  202. [WINDOW 3]
  203. title=CPU
  204. id=idCPU
  205. file 1=86bugs.lst
  206.  
  207. [WINDOW 4]
  208. title=CMOS
  209. id=idCMOS
  210. file 1=cmos.lst
  211.  
  212. ;[WINDOW 5]
  213. ;   (This part is disabled due to aliases required by the assosiated file)
  214. ;title=Miscellaneous Information
  215. ;id=MISC_INF_0
  216. ;type=3
  217. ; type=3 specifies a window with its own definition in an RTF file.
  218. ; MISC_INF_0 is the identifier (context string) for one of the topics in
  219. ; the RTF file. That topic is normally an index for other topics in the
  220. ; file.
  221. ;
  222. ; files=1 is the default number of files
  223. ;file 1=misc_inf.rtf
  224. ;   (misc_inf.rtf references context strings that should be defined in the
  225. ;    ALIAS part of the configuration file)
  226. ; file 1 type=3 is the default type because the window type is 3. It
  227. ; specifies an RTF file.
  228.  
  229. ; The ALIAS section is optional and is not used for program generated
  230. ; output. It compiles an ALIAS list to the HPJ file. Two of the RTF files
  231. ; supplied in this pasckage (SEL_TOPC.RTF and MISC_INF.RTF) require
  232. ; some aliases.
  233. ; [ALIAS]
  234. ; id87err=INT 10 ---- - CPU-generated (80286+) - COPROCESSOR ERROR
  235. ; idVideo_00=INT 10 00-- - VIDEO - SET VIDEO MODE
  236. ; idVideo_1013=INT 10 1013 - VIDEO - SELECT VIDEO DAC COLOR PAGE (VGA)
  237. ; Each entry is of the form
  238. ;   id=<modified INT header>
  239. ; where id is a user defined identifier (context string) no longer than 18
  240. ; characters, and <modified INT header> is an INT header with flags removed
  241. ; from char. pos. 8+ (i.e. if char. 8 is not "-" then delete up to, but not
  242. ; including, a "-" character), and with a register value (from the divider
  243. ; line char. pos. 13-16) + a space inserted at char. pos. 8-12, as shown in
  244. ; the example. The program substitutes the actual identifier (context string)
  245. ; for the <modified INT header> and copies the id=actual_id part to an
  246. ; [ALIAS] section in the HPJ file. The example would result in an HPJ
  247. ; section (based on Interrupt List release 40):
  248. ;
  249. ; [ALIAS]
  250. ; id87err=10_1
  251. ; idVideo_00=10_2
  252. ; idVideo_1013=10_46
  253. ;
  254. ; The entries must appear in the same order as the <modified INT header>
  255. ; appear in the Interrupt List. The program can assign more than one user
  256. ; defined id to the same interrupt entry in the list, the entries must of
  257. ; course be consecutive and have identical <modified INT header> values.
  258. ;
  259. ; Empty lines and lines starting with a semicolon (;) are ignored.
  260.  
  261. ; The BUILDTAGS section is optional and is not used for program generated
  262. ; output. It is included to support users' RTF files with conditional
  263. ; build. If the user's RTF files have build tags ("*" footnotes), the tags
  264. ; must be defined in a BUILDTAGS section in the configuration file.
  265. ; [BUILDTAGS]
  266. ; WINENV
  267. ; APP1
  268. ; TESTBUILD
  269. ;
  270. ; The BUILGTAGS section is simply copied to the HPJ file, ignoring empty
  271. ; lines and lines starting with a semicolon (;).
  272. ;
  273. ; See also the [OPTIONS] section's build= entry.
  274.