home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 April / Chip_2000-04_cd.bin / zkuste / TPascal / DOC.ARC / THELP.DOC < prev    next >
Encoding:
Text File  |  1989-05-02  |  12.4 KB  |  334 lines
  1.                       TURBO HELP UTILITY
  2.                       ------------------
  3.  
  4. This file explains how to use THELP.COM. THELP is a
  5. memory-resident utility that provides online help for Turbo
  6. Pascal and Turbo C. If you are using Turbo Debugger, for
  7. example, you can load THELP, then run the debugger and get
  8. online help for Pascal or C while you are debugging.
  9.  
  10.  
  11. Table of Contents
  12. -----------------
  13. 1.  Starting THELP
  14. 2.  Command-line Options Summary
  15. 3.  Detailed Explanation of Keys Used When THELP is Active
  16. 4.  Detailed Explanation of Command-line Options
  17.  
  18.  
  19. 1.  Starting THELP
  20. ------------------
  21.  
  22. Load THELP at the DOS command-line simply by typing THELP.
  23. Make sure the Turbo help file (TURBO.HLP for Turbo Pascal,
  24. TCHELP.TCH for TURBO C) is in the current directory or use the /F
  25. commandline option described below.
  26.  
  27.  
  28. Memory Usage   - THELP requires about 8K bytes (+ 32K swap file);
  29.                  40K with no swapping.
  30.  
  31. Default hotkey - The default hotkey is Numeric-Keypad-5 (scan
  32.                  code 4ch, shift state 00h).
  33.  
  34. Paste speed    - The default pasting speed is FAST. You'll have
  35.                  to experiment if it pastes too quickly for your
  36.                  editor. Note that you should turn off autoindent
  37.                  in the integrated environment before using the
  38.                  paste feature (Ctrl-Q I toggles autoindent).
  39.  
  40. If you are using SideKick Plus or SideKick 1.x, make sure you
  41. load THELP before you load SideKick.
  42.  
  43.  
  44. 2. Command-line Options Summary
  45. -------------------------------
  46.  
  47.   USAGE:  THELP [options]
  48.  
  49. Here is a summary of the command line options. If you use more
  50. than one option, they must be separated by spaces.
  51.  
  52.   /B        Use BIOS for video
  53.   /C#xx     Select color: #=color number, xx=hex color value
  54.   /Dname    Full path for disk swapping (implies /S1)
  55.   /Fname    Full path and filename of help file
  56.   /H,/?,?   Display this help screen
  57.   /Kxxyy    Change hotkey: xx=shift state, yy=scan code
  58.   /Lxx      Force number of rows on screen: xx=25,43,50
  59.   /M+,/M-   Display help text: on monochrome screen(+),
  60.             on default screen(-)
  61.   /Px       Pasting speed: 0=slow, 1=medium, 2=fast
  62.   /R        Send options to resident THELP
  63.   /Sx       Default Swapping Mode: 1=Use Disk, 2=Use EMS,
  64.             3=No Swapping
  65.   /U        Remove THELP from memory
  66.   /W        Write Options to THELP.COM and exit
  67.  
  68.  
  69. 3. Detailed Explanation of Keys Used When THELP is Active
  70. ---------------------------------------------------------
  71.  
  72.   Arrow keys:  Move the highlight from item to item within the
  73.                current help screen.
  74.  
  75.   PgUp/PgDn:   Move from screen to screen if additional screens
  76.                are available.
  77.  
  78.   ENTER:       Select help entry for the item highlighted in the
  79.                current help screen.
  80.  
  81.   ESC:         End Help.
  82.  
  83.   F1:          Help Index. F1 from any help screen brings up
  84.                the Help Index.
  85.  
  86.   ALT-F1:      Displays in reverse order the last 20 screens you
  87.                have reviewed.
  88.  
  89.   CTL-F1:      Bring up help screen for THELP's hot keys.
  90.  
  91.   F key:       Select new help file. 'F' or 'f' brings up a
  92.                window that allows you to change help files on the
  93.                fly. Type in the complete path name of the new
  94.                help file, and it will be read into memory and
  95.                initialized to the help index of the new file
  96.                (Page 100). If the new file does not exist, or is
  97.                in an invalid format, THELP will beep twice, and
  98.                return you to the original file.
  99.  
  100.   J key:       Jump to specified help page number. 'J' or 'j'
  101.                brings up a window that allows you to jump to any
  102.                particular page (9999 max) in the help file. The
  103.                only editing key permitted in this window is
  104.                BackSpace. ESC aborts, CR (or four digits)
  105.                completes.
  106.  
  107.   K key:       Search help file for specified keyword. 'K' or 'k'
  108.                brings up a window in which you can enter a
  109.                keyword (40 characters max), and have THELP search
  110.                the help file for a match. If there is no matching
  111.                keyword in the current help file, THELP will beep
  112.                twice and return you to the original help screen.
  113.  
  114.   I key:       Paste highlighted keyword into application. 'I' or
  115.                'i' inserts the current highlighted keyword into
  116.                the keyboard buffer, and immediately pops down.
  117.  
  118.   P key:       Paste entire help screen into application. 'P' or
  119.                'p' inserts the entire current help page (as it
  120.                appears in the help window) into the current
  121.                application, and then immediately pops down.
  122.                Pasting can be interrupted with ^C or ^Break.
  123.  
  124.   S Key:       Save help screen to disk file (THELP.SAV). 'S' or
  125.                's' from any help screen saves the current help
  126.                page to the disk file THELP.SAV, in the current
  127.                directory. If the file already exists, the new
  128.                help information is appended to the end.
  129.  
  130.   <Hotkey Combo>
  131.                Pressing the hotkey combination when using THELP
  132.                on a second monitor ends this session of the
  133.                resident help, but leaves the current help screen
  134.                on the monochrome monitor.
  135.  
  136.  
  137. 4.  Detailed Explanation of Command-line Options
  138. ------------------------------------------------
  139.  
  140. /B       -- Use BIOS for video
  141.  
  142. This option forces THELP to use Interrupt 10h BIOS video calls
  143. for all writing to/reading from the video display. Normally, THELP
  144. will write directly to video RAM. Note that the use of this
  145. option negates the effect of the /M switch described below; the
  146. alternate monitor may not be used if /B is in effect. This option
  147. is enabled with '/B+', and disabled with '/B-' (enable is the
  148. default).
  149.  
  150. /C#xx     Select color: #=color number, xx=hex color value
  151.  
  152. There are eight possible colors, described as follows:
  153.  
  154.   1 = Color Normal Text
  155.   2 = Monochrome Normal Text
  156.   3 = Color Possible reference pages; top/bottom description line
  157.   4 = Monochrome Possible reference pages; top/bottom description line
  158.   5 = Color Border Color
  159.   6 = Monochrome Border Color
  160.   7 = Color Current Reference Selection
  161.   8 = Monochrome Current Reference Selection
  162.  
  163. Any or all of these eight colors may be specified on the command
  164. line.
  165.  
  166. The color numbers for a standard IBM-compatible Color Display are
  167. as follows:
  168.  
  169. First Digit (Background)              Second Digit (Foreground)
  170.  
  171. 0 -- Black                            0 -- Black
  172. 1 -- Blue                             1 -- Blue
  173. 2 -- Green                            2 -- Green
  174. 3 -- Cyan                             3 -- Cyan
  175. 4 -- Red                              4 -- Red
  176. 5 -- Magenta                          5 -- Magenta
  177. 6 -- Brown                            6 -- Brown
  178. 7 -- Grey                             7 -- Grey
  179.                                       8 -- Intense Black
  180.  ORing the color value with           9 -- Intense Blue
  181.  Hex 80 produces a blinking           A -- Intense Green
  182.  color unless blinking has been       B -- Intense Cyan
  183.  disabled.                            C -- Intense Red
  184.                                       D -- Intense Magenta
  185.                                       E -- Intense Brown (Yellow)
  186.                                       F -- Intense Grey (White)
  187.  
  188. On Monochrome monitors, the attribute values can differ widely,
  189. so some experimentation would be needed. Note that the monochrome
  190. attributes are used in only two cases; when the current video
  191. mode is 7, or when force mono is used (see the /M option)
  192.  
  193.  
  194. /Dname   -- Full path for disk swapping (implies /S1)
  195.  
  196. This option is used to override where THELP will place its swap
  197. files when swapping to disk. A full path should be specified,
  198. but a trailing '\' is not necessary. If no /D option is
  199. specified, under DOS 3.x swap files are placed in the directory
  200. where THELP.COM resides. Under DOS 2.x, swap files are placed by
  201. default in C:\.
  202.  
  203. Using this option also sets the flag that forces disk swapping
  204. instead of checking first for EMS.
  205.  
  206.  
  207. /Fname   -- Full path and filename of help file
  208.  
  209. The name that follows the /F option should be the full
  210. drive/directory pathname of the help file to use; e.g.,
  211.  
  212.     THELP /FC:\TP\TURBO.HLP
  213.     THELP /FC:\TURBOC\TCHELP.TCH
  214.  
  215. By default, THELP looks for the help file on the logged drive and
  216. directory.
  217.  
  218.  
  219. /H,/?,?  -- Display help screen
  220.  
  221. This option displays a summary of THELP's command-line options
  222.  
  223.  
  224. /Kxxyy   -- Change hotkey: xx=shift state, yy=scan code
  225.  
  226. Virtually any shift state/scan code combination may be selected.
  227. A quick summary of some common shift-states and scan codes
  228. follows:
  229.  
  230.  
  231.   Shift States (may be OR'ed together)
  232.  
  233.     right shift    01h
  234.     left shift     02h
  235.     control        04h
  236.     alt            08h
  237.  
  238.   Scan Codes
  239.  
  240.     A   --- 1eh     N   --- 31h     0   --- 0bh     F1  --- 3bh
  241.     B   --- 30h     O   --- 18h     1   --- 02h     F2  --- 3ch
  242.     C   --- 2eh     P   --- 19h     2   --- 03h     F3  --- 3dh
  243.     D   --- 20h     Q   --- 10h     3   --- 04h     F4  --- 3eh
  244.     E   --- 12h     R   --- 13h     4   --- 05h     F5  --- 3fh
  245.     F   --- 21h     S   --- 1fh     5   --- 06h     F6  --- 40h
  246.     G   --- 22h     T   --- 14h     6   --- 07h     F7  --- 41h
  247.     H   --- 23h     U   --- 16h     7   --- 08h     F8  --- 42h
  248.     I   --- 17h     V   --- 2fh     8   --- 09h     F9  --- 43h
  249.     J   --- 24h     W   --- 11h     9   --- 0ah     F10 --- 44h
  250.     K   --- 25h     X   --- 2dh
  251.     L   --- 26h     Y   --- 15h
  252.     M   --- 32h     Z   --- 2ch
  253.  
  254.  
  255.   Enhanced Keyboards only (may not work with all computers,
  256.   keyboards)
  257.  
  258.     F11 --- 57h
  259.     F12 --- 58h
  260.  
  261.  
  262. /Lxx     -- Force number of rows on screen: xx=25,43,50
  263.  
  264. Some video adapters do not correctly store the number of video
  265. rows on the screen in the BIOS data location specified for the
  266. IBM-PC. This option forces THELP to use the given value, rather
  267. than the number the BIOS reports.
  268.  
  269.  
  270. /M+,/M-  -- Display help text: on monochrome screen(+),
  271.             on default screen(-)
  272.  
  273. For users with dual-monitor systems, this option may be used to
  274. instruct THELP to bring up its display on the monochrome monitor,
  275. rather than on the color monitor. This option is enabled with
  276. '/M+', and disabled with '/M-' (enable is the default). Note that
  277. /M is incompatible with /B (see above).
  278.  
  279.  
  280. /Px      -- Pasting speed: 0=slow, 1=medium, 2=fast
  281.  
  282. Some editors do not accept characters pasted into the keyboard
  283. buffer as fast as THELP can put them there. By setting an
  284. appropriate paste speed, virtually all possible configurations of
  285. editors may be used. FAST speed pastes as many characters as will
  286. fit on every timer tick; MEDIUM pastes up to four characters per
  287. tick; and SLOW pastes a single character into the buffer ONLY
  288. when the buffer is empty.
  289.  
  290.  
  291. /R       -- Send options to resident THELP
  292.  
  293. The /R option is used to pass parameters (like new colors, or new
  294. hotkeys) to the resident portion of THELP. All THELP command-line
  295. options may be sent to the resident portion except for the
  296. swapping mode, which cannot be modified once THELP has been
  297. initialized.
  298.  
  299. In combination with these options, you can create a batch file
  300. that changes THELP's configuration as you change editors; i.e.:
  301.  
  302.   THELP /M /P0 /FC:\TP\TURBO.HLP /R
  303.     Use mono monitor, slow pasting, and the Turbo Pascal help
  304.     file. Options are not saved to disk.
  305.  
  306.   THELP /P2 /FC:\TC\TCHELP.TCH /R
  307.     Use default monitor, fast pasting, and the Turbo C help file.
  308.     Options are not saved to disk.
  309.  
  310.  
  311. /Sx      -- Default Swapping Mode: 1=Use Disk, 2=Use EMS,
  312.             3=No Swapping
  313.  
  314. If no '/S' parameter is used, THELP first tests to see if
  315. Expanded Memory is available in the system. If so, and if enough
  316. memory can be allocated, swapping is done to EMS. If EMS is not
  317. available, disk swapping is used. See the /D parameter for
  318. information on where the swap file will be written if disk
  319. swapping is used.
  320.  
  321.  
  322. /U       -- Remove THELP from memory
  323.  
  324. This option is used to remove THELP from memory. If other TSRs
  325. have been loaded after THELP, make sure to remove them before
  326. removing THELP.
  327.  
  328.  
  329. /W       -- Write Options to THELP.COM and exit
  330.  
  331. The /W parameter is used to create a new version of THELP that
  332. uses the options you desire as a default. All options, including
  333. /S (but not /R) may be specified and made 'permanent'.
  334.