home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / sysutl / hlpmst11.arc / HM.DOC < prev    next >
Encoding:
Text File  |  1989-10-31  |  14.1 KB  |  416 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                   HelpMaster
  20.  
  21.                 Copyright 1989 by Threshold Computer Associates
  22.  
  23.                               All Rights Reserved
  24.  
  25.                                  Version 1.10
  26.  
  27.  
  28. Copyright 1989 by Threshold Computer Associates, all rights
  29. reserved.
  30. October 30, 1989
  31. Glen Allen, Virginia
  32.  
  33. Sprint is a registered trademark of Borland International, Inc.
  34.  
  35. Word is a registered trademark of Microsoft Corporation.
  36.  
  37. IBM is a registered trademark of International Business Machines
  38. Corporation.
  39.  
  40.  
  41.  
  42.  
  43.                                   Contents
  44.  
  45.  
  46.          1  - Disclaimer and License  . . . . . . . . . . . . 1
  47.          2  - Registration  . . . . . . . . . . . . . . . . . 2
  48.          3  - Version History . . . . . . . . . . . . . . . . 3
  49.          4  - General & Technical Information . . . . . . . . 3
  50.          5  - Program Description . . . . . . . . . . . . . . 3
  51.          6  - Installing HelpMaster . . . . . . . . . . . . . 3
  52.          7  - Executing HelpMaster  . . . . . . . . . . . . . 4
  53.          8  - Troubleshooting . . . . . . . . . . . . . . . . 5
  54.               Order Form
  55.  
  56.  
  57.  
  58.                          DISCLAIMER 
  59.  
  60.     Threshold Computer Associates (TCA) hereby disclaims all
  61. warranties relating to this product, whether express or implied,
  62. including without limitation any implied warranties of
  63. merchantability or fitness for a particular purpose. TCA cannot
  64. and will not be liable for any special, incidental,
  65. consequential, indirect or similar damages due to loss of data or
  66. any other reason, even if TCA or an authorized TCA agent has been   
  67. advised of the possibility of such damages.  In no event shall
  68. the liability for any damages ever exceed the price paid for the
  69. license to use the software, regardless of the form and/or extent
  70. of the claim.  The user of this program bears all risk as to the
  71. quality and performance of the software.
  72.  
  73.  
  74.                          LICENSE 
  75.  
  76.     HelpMaster is a Shareware product.  As such, it is made
  77. available to the general computing public for evaluation.  Users
  78. are licensed to operate HelpMaster on their personal computers
  79. for the purpose of test and evaluation on a trial basis for a
  80. limited trial period.  It is not possible to reasonably define
  81. any definitive limits of a fair and equitable time period for
  82. evaluation, therefore it is left to the user's judgement and
  83. sense of fair play as to the time required to make a decision as
  84. to its usefulness.  If the user decides the program is not of
  85. sufficient merit to warrant purchase through registration with   
  86. Threshold Computer Associates, the program should be removed from
  87. their personal computer. Otherwise, if the program is deemed
  88. useful and is in regular use on the user's personal computer
  89. system, registration with TCA is required.
  90.  
  91.     Registered users are those users that elect to pay for
  92. HelpMaster and register that payment with TCA.  By virtue of
  93. registration and payment for the program, registered users are
  94. granted a license to continue to utilize the program on their
  95. personal computer for as long as they choose.  This license
  96. authorizes the user to use the program on any personal computer
  97. system he or she may own so long as the program is operated on
  98. only one computer system at a time.
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.                                  - 1 -
  118.  
  119.  
  120.  
  121.  
  122.     2  - REGISTRATION
  123.  
  124.  
  125.     HelpMaster is sole property of Threshold Computer Associates.
  126. The Shareware version may be freely copied and transferred to
  127. individual parties for evaluation purposes.  It may be posted on
  128. Bulletin Board systems (BBS) for electronic access as long as NO
  129. FEE is charged for its distribution except for private BBS
  130. operations that charge a regular user subscription fee.  Computer
  131. information services such as Compuserve (CIS), GEnie, etc., are
  132. authorized to post this product for subscriber access. 
  133. HelpMaster may NOT be distributed on diskette by any disk
  134. distributor/vendor that charges more than $10.00 for the diskette
  135. upon which the program and attendant files are recorded without
  136. written consent from Threshold Computer Associates.
  137.  
  138.     HelpMaster is a fully functional Shareware product. 
  139. Shareware is a computer program distribution/marketing method
  140. that permits potential buyers to thoroughly try the program prior
  141. to purchase. It is NOT free and it is NOT in the Public Domain. 
  142. If, after evaluating the program, you find it to be useful enough
  143. to use it on a regular basis, you are expected to pay for it by
  144. registering with TCA. The registration fee is $15.00.
  145.  
  146.     You may register HelpMaster by mail with check or money order
  147. to:
  148.  
  149.                  Threshold Computer Associates
  150.                  10831 W. Broad Street
  151.                  Suite 237
  152.                  Glen Allen, VA 23060
  153.  
  154.     VIRGINIA RESIDENTS MUST INCLUDE 4 1/2% STATE SALES TAX!
  155.  
  156.     The Shareware version of HelpMaster provides help screens for
  157. Borland Sprint, DOS, and Microsoft Word. Registered users can
  158. choose 2 additional packages at the time of registration and for
  159. $2.00 each thereafter.  If we do not currently support a
  160. requested program, we will refund your money or you may supply a
  161. layout of the help screen(s) and we will create them for you at
  162. no additional charge.  Additionally, registered users will
  163. receive the latest version of the program at time of
  164. registration.
  165.  
  166.     A representative of TCA can be contacted on CIS via PPN
  167. 74206,3572 (please use EASYPLEX).
  168.  
  169.     This Shareware version of HelpMaster may be freely copied and
  170. passed on to other individual users for their evaluation. The
  171. Shareware version consists of the following files:
  172.  
  173.               HM.EXE    -  HelpMaster executable file
  174.               HM.DOC    -  HelpMaster Documentation
  175.               DOS%%.000 -  DOS help file
  176.               SP%%.*    -  Borland Sprint help files
  177.               WORD%%.*  -  MicroSoft Word help files
  178.  
  179.  
  180.                                  - 2 -
  181.  
  182.  
  183.     Additional help files may be purchased from Threshold
  184. Computer Associates and are NOT Shareware and MAY NOT be
  185. distributed by the purchaser without prior written consent from
  186. Threshold Computer Associates.
  187.  
  188.     One of the great strengths of the Shareware concept is the
  189. interaction between the program author and the users.  Many of
  190. the features contained in HelpMaster are the result of user
  191. input. If you have a problem evaluating this program or desire to
  192. make a suggestion, comment, or complaint, please do not hesitate
  193. to contact us. It is not necessary that you be a registered user
  194. to contact us for technical support.  Technical support will be
  195. available through the U.S mail, or CompuServe via PPN 74206,3572.
  196.  
  197.  
  198.     3  - VERSION HISTORY
  199.  
  200.  
  201. 1.00  -  09/26/89
  202.          Initial Beta test release.
  203.  
  204. 1.10  -  10/30/89
  205.          Initial Shareware release.
  206.  
  207.  
  208.     4  - GENERAL & TECHNICAL INFORMATION
  209.  
  210.  
  211.     HelpMaster will work with PC/MS DOS version 3.0 or higher and
  212. has been tested on the following machines:
  213.  
  214.           NEC Powermate 1 Plus
  215.           PC Network Turbo PC/XT
  216.           IBM PC/XT
  217.           IBM PC/AT
  218.  
  219.  
  220.     5  - PROGRAM DESCRIPTION
  221.  
  222.  
  223.     HelpMaster is a Terminate and Stay Resident (TSR) program
  224. designed to add online help capabilities to any software package.
  225.  
  226.     When configured properly, HelpMaster will remain invisible
  227. behind all other software running on your PC. When you need help,
  228. simply press the "hot key" combination you have chosen, and
  229. HelpMaster will pop up the help window! There's no need to tell
  230. HelpMaster what program is running, it will figure it out and
  231. access the proper help screens.
  232.  
  233.  
  234.     6  - INSTALLING HELPMASTER
  235.  
  236.  
  237.     The HelpMaster program may reside in any directory. The help
  238. files (those files with extensions numbered from 000 to 015) must
  239. reside in the same directory as the executable portion of the
  240. program which is running at the time help is requested.  The DOS
  241. help file (DOS%%.000) should be placed in the root directory.
  242.  
  243.                                  - 3 -
  244.  
  245.  
  246.  
  247.     The "hot key" used to bring up a particular help window is
  248. determined by the file name extension as follows:
  249.  
  250.         Extension    Hot Key
  251.         ---------    -------------------------------
  252.           000        Default
  253.           001        Right-Shift
  254.           002        Left-Shift
  255.           003        Left-Shift+Right-Shift
  256.           004        Ctrl
  257.           005        Ctrl+Right-Shift
  258.           006        Ctrl+Left-Shift
  259.           007        Ctrl+Right-Shift+Left-Shift
  260.           008        Alt
  261.           009        Alt+Right-Shift
  262.           010        Alt+Left-Shift
  263.           011        Alt+Right-Shift+Left-Shift
  264.           012        Ctrl+Alt
  265.           013        Ctrl+Alt+Right-Shift
  266.           014        Ctrl+Alt+Left-Shift
  267.           015        Ctrl+Alt+Right-Shift+Left-Shift
  268.  
  269.     HelpMaster can be configured to pop up any number of seconds
  270. after the "hot key" is pressed. For example, you could have a
  271. help file for all the CTRL functions of your program and
  272. configure HelpMaster to pop if the CTRL key is held for 3
  273. seconds. You could then use the CTRL key as usual in your
  274. program, but if you forget one of the CTRL functions, simply hold
  275. the key down a little longer, and voila! HelpMaster pops up the
  276. help you need!  Do the same for the ALT and SHIFT functions! You
  277. say your program doesn't use CTRL, ALT or SHIFT functions? No
  278. problem, you can still use HelpMaster to pop up your help
  279. screens, simply choose a key combination you like, and assign the
  280. proper extension to the help file, and you are all set! You say
  281. you don't want to have to remember the "hot key"? No problem,
  282. just use the 000 extension and type any of the hot keys!  If
  283. HelpMaster can't find a help file for the key(s) pressed, it will
  284. look for a file with the 000 extension. Now you can trash all
  285. those keyboard templates, HelpMaster has made them obsolete!
  286.  
  287.     If you do not own Borland Sprint or Microsoft Word but would
  288. like to see what the help screens look like and how HelpMaster
  289. would interract with one of your programs, simply rename the
  290. SP%%.* and/or WORD%%.* help files as follows:
  291.  
  292.           aaaaaa%%.nnn    where:
  293.                                  aaaaaa = program name
  294.                                      %% = MUST be %%
  295.                                     nnn = extension for appropriate
  296.                                           hot key as defined above
  297.  
  298.  
  299.     7  - EXECUTING HELPMASTER
  300.  
  301.  
  302.     HelpMaster's executable file is named HM.EXE. HelpMaster may
  303.  
  304.  
  305.  
  306.                                  - 4 -
  307.  
  308.  
  309.  
  310. be executed by entering the file name at the DOS command level or
  311. called from a .BAT file or DOS shell.  There are several command
  312. line parameters supported.  A command line parameter is a string
  313. of characters that follows the program name.  Here is an example:
  314.  
  315.                     C:\> HM /d2
  316.  
  317.     The command string is NOT case sensitive.  In this example,
  318. DOS will load and execute HelpMaster and HelpMaster will set the
  319. delay for pop up at 2 seconds (if the /d parameter is not
  320. specified, the default pop-up time is 3 seconds).  Other
  321. execution parameters are:
  322.  
  323.                     /q - Remove HelpMaster from memory (must be
  324.                          the last TSR loaded).
  325.                     /s - Suspend HelpMaster
  326.                     /r - Resume HelpMaster
  327.  
  328.     We recommend that you execute HelpMaster from your
  329. AUTOEXEC.BAT file so that it will be ready to help you regardless
  330. of what program you are running.  Note: HelpMaster will not pop
  331. up over a graphics screen. Attempting to do so will result in an
  332. error tone from the program.
  333.  
  334.  
  335.     8  - TROUBLESHOOTING
  336.  
  337.  
  338.     HelpMaster will always inform the user (with an error tone)
  339. if it is unable to pop up for one reason or another. The two most
  340. common reasons for errors are attempting to pop over a graphics
  341. screen, or HelpMaster is unable to find the help file for the key
  342. being pressed. The cure for the first problem is self-evident.
  343. The second problem may be caused by one of two things:
  344.  
  345.           1) The program under execution has no help file for the
  346.              key being pressed. If there should be one, or if
  347.              you'd like one, please contact us immediately.
  348.  
  349.           2) The help files have been placed in the wrong
  350.              directory. Please be sure that the help files (those
  351.              files with names in the form of xxxxxx%%.nnn [where
  352.              xxxxxx is the program name and nnn is a number from
  353.              000 to 015]) are in the same directory as the EXE or
  354.              COM file currently running.
  355.  
  356.     If you receive an error tone for which you cannot determine
  357. the cause, or HelpMaster does not perform correctly, please
  358. contact us as soon as possible so that we may solve the problem.
  359.  
  360.     While our testing has shown this to be a very "well behaved"
  361. TSR, it is in the nature of some TSRs to interact poorly with
  362. others. If you are experiencing problems with HelpMaster that
  363. cannot be explained by (1) or (2) above, before contacting us,
  364. try making HelpMaster either the first or last TSR loaded in your
  365. system.
  366.  
  367.  
  368.  
  369.                                  - 5 -
  370.  
  371.  
  372.  
  373.                          H E L P M A S T E R 
  374.                              Version 1.10 
  375.  
  376.                         O r d e r    F o r m 
  377.  
  378.  
  379.  
  380. Name:__________________________
  381.  
  382. Company:_______________________
  383.  
  384. Street:________________________
  385.  
  386. City:__________________________
  387.  
  388. State:_____________ Zip:_______
  389.  
  390. Phone:  Day: (____)____________
  391.  
  392.       Night: (____)____________
  393.  
  394.  
  395. (  )I have enclosed $15.00. Please enter my registration for
  396. HelpMaster and send me help files for the following 2 programs:
  397.  
  398.        1) ___________________________  Version:_______
  399.  
  400.        2) ___________________________  Version:_______
  401.  
  402.  
  403. (  )I am a registered user of HelpMaster, please send me help
  404. files for the following program(s) at $2.00 each:
  405.  
  406.       1) ____________________________  Version:_______
  407.  
  408.       2) ____________________________  Version:_______
  409.  
  410.       3) ____________________________  Version:_______
  411.  
  412.       4) ____________________________  Version:_______
  413.  
  414.       5) ____________________________  Version:_______
  415.  
  416.