home *** CD-ROM | disk | FTP | other *** search
/ The Devil's Doorknob BBS Capture (1996-2003) / devilsdoorknobbbscapture1996-2003.iso / Dloads / OTHERUTI / TCPP10-8.ZIP / DOC.ZIP / THELP.DOC < prev    next >
Text File  |  1990-09-26  |  6KB  |  182 lines
  1.                       TURBO HELP UTILITY
  2.                       ------------------
  3.  
  4. This file explains how to use THELP.COM. THELP is a memory-resident
  5. utility that provides online help for Turbo Pascal and Turbo C++. If you
  6. are using Turbo Debugger, for example, you can load THELP, then run
  7. the debugger and get online help for Pascal or C while you are
  8. 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. Make sure
  23. the Turbo help file is in the current directory or use the /F command
  24. line option described below. The INSTALL program on the distribution
  25. disks inserts the correct path information in THELP.
  26.  
  27.  
  28. Memory Usage   - THELP requires about 20K bytes.
  29.  
  30. Default hotkey - The default hotkey is Numeric-Keypad-5 (scan
  31.                  code 4ch, shift state 00h).
  32.  
  33. Paste speed    - The default pasting speed is FAST. You'll have
  34.                  to experiment if it pastes too quickly for your
  35.                  editor. Note that you should turn off autoindent
  36.                  in the integrated environment before using the
  37.                  paste feature.
  38.  
  39. If you are using SideKick Plus or SideKick 1.x, make sure you
  40. load THELP before you load SideKick.
  41.  
  42.  
  43. 2. Command-line Options Summary
  44. -------------------------------
  45.  
  46.   USAGE:  THELP [options]
  47.  
  48. Here is a summary of the command line options. If you use more
  49. than one option, they must be separated by spaces.
  50.  
  51.   /Fname    Full path and filename of help file
  52.   /H,/?,?   Display this help screen
  53.   /Kxxyy    Change hotkey: xx=shift state(hex),
  54.             yy=scan code(hex)
  55.   /Px       Pasting speed: 0=slow, 1=medium, 2=fast
  56.   /S+       Enable snow checking for video (useful for older CGA adapters).
  57.   /S-       Disable snow checking for video (for snappier displays).
  58.   /U        Remove THELP from memory
  59.   /W        Write Options to THELP.COM and exit
  60.  
  61.  
  62. 3. Detailed Explanation of Keys Used When THELP is Active
  63. ---------------------------------------------------------
  64.  
  65.   Arrow keys:  Moves the cursor.
  66.   PgUp/PgDn:   Moves the cursor.
  67.  
  68.   Shift-Arrow keys:  Moves the cursor while marking a block.
  69.  
  70.   TAB:         Moves the cursor to the next keyword.
  71.   Shift-TAB:   Moves the cursor to the previous keyword.
  72.  
  73.   HOME:        Go to the beginning of the line.
  74.   END:         Go to the end of the line.
  75.  
  76.   ENTER:       Select help entry for the item highlighted in the
  77.                current help screen.
  78.  
  79.   ESC:         End Help.
  80.  
  81.   F1:          Help Index. F1 from any help screen brings up
  82.                the Help Index.  You can search for a specific keyword
  83.                incrementally.  For example, you can find "printf" by
  84.                typing p r i.  With each letter you type, the list
  85.                jumps to the keyword that starts with p, then to pr,
  86.                then to pri, etc.
  87.  
  88.   ALT-F1:      Displays in reverse order the last 20 screens you
  89.                have reviewed.
  90.  
  91.   CTL-F1:      Bring up help screen for THELP's hot keys.
  92.  
  93.   CTRL-P key:  Paste the example text into the application.
  94.  
  95.  
  96.  
  97. 4.  Detailed Explanation of Command-line Options
  98. ------------------------------------------------
  99.  
  100. /Fname   -- Full path and filename of help file
  101.  
  102. The name that follows the /F option should be the full
  103. drive/directory pathname of the help file to use; e.g.,
  104.  
  105.     THELP /FC:\TP\TURBO.HLP
  106.     THELP /FC:\TURBOC\TCHELP.TCH
  107.  
  108. By default, THELP looks for the help file on the logged drive and
  109. directory.
  110.  
  111.  
  112. /H,/?,?  -- Display help screen
  113.  
  114. This option displays a summary of THELP's command-line options
  115.  
  116.  
  117. /Kxxyy   -- Change hotkey: xx=shift state, yy=scan code
  118.  
  119. Virtually any shift state/scan code combination may be selected. A
  120. quick summary of some common shift-states and scan codes follows:
  121.  
  122.   Shift States (may be OR'ed together)
  123.  
  124.     right shift    01h
  125.     left shift     02h
  126.     control        04h
  127.     alt            08h
  128.  
  129.   Scan Codes
  130.  
  131.     A   --- 1eh     N   --- 31h     0   --- 0bh     F1  --- 3bh
  132.     B   --- 30h     O   --- 18h     1   --- 02h     F2  --- 3ch
  133.     C   --- 2eh     P   --- 19h     2   --- 03h     F3  --- 3dh
  134.     D   --- 20h     Q   --- 10h     3   --- 04h     F4  --- 3eh
  135.     E   --- 12h     R   --- 13h     4   --- 05h     F5  --- 3fh
  136.     F   --- 21h     S   --- 1fh     5   --- 06h     F6  --- 40h
  137.     G   --- 22h     T   --- 14h     6   --- 07h     F7  --- 41h
  138.     H   --- 23h     U   --- 16h     7   --- 08h     F8  --- 42h
  139.     I   --- 17h     V   --- 2fh     8   --- 09h     F9  --- 43h
  140.     J   --- 24h     W   --- 11h     9   --- 0ah     F10 --- 44h
  141.     K   --- 25h     X   --- 2dh
  142.     L   --- 26h     Y   --- 15h
  143.     M   --- 32h     Z   --- 2ch
  144.  
  145.  
  146.   Enhanced Keyboards only (may not work with all computers, keyboards)
  147.  
  148.     F11 --- 57h
  149.     F12 --- 58h
  150.  
  151.  
  152. /Px      -- Pasting speed: 0=slow, 1=medium, 2=fast
  153.  
  154. Some editors do not accept characters pasted into the keyboard buffer
  155. as fast as THELP can put them there. By setting an appropriate paste
  156. speed, virtually all possible configurations of editors may be used.
  157. FAST speed pastes as many characters as will fit on every timer tick;
  158. MEDIUM pastes up to four characters per tick; and SLOW pastes a single
  159. character into the buffer ONLY when the buffer is empty.
  160.  
  161. /S       -- Controls snow checking logic for video.
  162.  
  163. Some older CGA have a tendency to produce a "snow" effect when
  164. software tries to write directly into their memory space.  If you see
  165. this snow you should start up THELP with /S+ to enable the snow
  166. checking code.  You may want to use the /W switch (see below) to make
  167. it permanent.  Snow checking takes time and it is better to live
  168. without it.  To disable snow checking use /S-; this is the default.
  169.  
  170. /U       -- Remove THELP from memory
  171.  
  172. This option is used to remove THELP from memory. If other TSRs have
  173. been loaded after THELP, make sure to remove them before removing
  174. THELP.
  175.  
  176.  
  177. /W       -- Write Options to THELP.COM and exit
  178.  
  179. The /W parameter is used to create a new version of THELP that uses
  180. the options you desire as a default. All options, including may be
  181. specified and made 'permanent'.
  182.