home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / info / help201.arc / HELP20.DOC < prev    next >
Encoding:
Text File  |  1987-10-04  |  16.1 KB  |  511 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                             HELP / POP-HELP USER'S GUIDE
  30.                                     Version 2.01
  31.  
  32.                             Copyright 1987, HELP SOFTWARE
  33.                                   16706 Bradley Ct.
  34.                                   Belton, MO 64012
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.                                   TABLE OF CONTENTS
  81.  
  82.  
  83.           SHAREWARE CONCEPT  .............................  1
  84.  
  85.           DIFFERENCES BETWEEN VERSION 2.01 AND OTHERS ....  1
  86.  
  87.           WHAT DOES HELP!! DO ?? .........................  2
  88.  
  89.           INSTALLING HELP!!  .............................  2
  90.  
  91.           USING HELP!!  ..................................  3
  92.  
  93.           DIFFERENCES BETWEEN HELP!! AND POP-HELP  .......  5
  94.  
  95.           MODIFYING AND ADDING HELP!! COMMANDS  ..........  5
  96.  
  97.           USING HELPINDX .................................  7
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                                   SHAREWARE CONCEPT
  126.  
  127.           HELP!! and POP-HELP represent many months of very hard work.  I
  128.           urge you to support the Shareware concept and fight the high cost
  129.           of software.  
  130.  
  131.           HELP!! and POP-HELP are user supported programs.  They are not
  132.           public domain programs and they are not free.  You are granted a
  133.           limited license to use HELP!! and POP-HELP on a trial basis.  If
  134.           you wish to continue using HELP!! and/or POP-HELP after the trial
  135.           period, you must register by sending either 
  136.  
  137.           (1) $15.00 for registration only (no disk) or 
  138.           (2) $25.00 for registration and the latest version on disk.  
  139.           (Indicate the version that you currently have.)
  140.  
  141.           Discounts are available for purchases over 10 units.  Write for
  142.           details.
  143.  
  144.           Send all registration fees to:
  145.  
  146.                                  HELP SOFTWARE
  147.                                  16706 Bradley Ct.
  148.                                  Belton, MO 64012
  149.  
  150.           Whether you find this program useful or not, you are encouraged
  151.           to share this program with others.
  152.  
  153.           Both HELP!! and POP-HELP have been thoroughly tested, but if you
  154.           should find a bug or have an idea how HELP!! could be improved,
  155.           please let me know.
  156.  
  157.  
  158.  
  159.              DIFFERENCES BETWEEN HELP / POP-HELP 2.01 AND PREVIOUS VERSIONS
  160.  
  161.           If you  have been  using other  versions of HELP, there are a few
  162.           key differences between HELP  2.01 and  previous versions.   They
  163.           are listed below.
  164.  
  165.  
  166.           1)  CONVERT has been replaced by HELPINDX.
  167.  
  168.           2)  SETUP has been replaced by HELPINST.
  169.  
  170.           3)   HELP and  POP-HELP now  use significantly smaller data files
  171.           (roughly half the size) and saves you a lot of disk space.
  172.  
  173.           4)  POP-HELP uses considerably less RAM memory (about 20% less).
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.                                WHAT DOES HELP!! DO ??
  185.  
  186.           HELP!! is  designed to  be an  on-line reference  manual.  HELP!!
  187.           comes  with  a  text  file  (HELP.DAT)  that  contains a complete
  188.           listing of DOS commands through DOS 3.3.  It is designed to be as
  189.           flexible as  possible.   You can create your own file of commands
  190.           so that HELP!! can be tailored to your needs. 
  191.  
  192.           HELP!! is available from the DOS command line at any time.  POP-
  193.           HELP is a pop-up or memory resident version of HELP!!  There are
  194.           a few minor differences between HELP and POP-HELP and they are
  195.           explained in a later section.
  196.  
  197.           The text file that HELP!! uses (HELP.DAT) is included on this
  198.           disk.  You can add commands, edit commands, or personalize it any
  199.           way you want.  (See the section on Modifying and Adding HELP!!
  200.           Commands for instructions).
  201.  
  202.  
  203.  
  204.                                   INSTALLING HELP!!
  205.  
  206.           The installation of HELP!! is either a one or two step process. 
  207.           If your copy of HELP!! was downloaded from a bulletin board, you
  208.           may need to run the HELPINDX program before HELP!! will be
  209.           usable.
  210.  
  211.           Here's how to tell if you need to run HELPINDX.  Check your
  212.           directory for two files.  If you do not have the files HELP.NDX
  213.           and HELP.DAT, then you will need to run HELPINDX.  (See the
  214.           instructions in the section labeled USING  HELPINDX).   If you do
  215.           have these files, then go on to the next step.
  216.  
  217.           Next type HELPINST and press Enter.  A screen will be displayed
  218.           prompting you to enter several pieces of information.
  219.  
  220.           The first thing that HELPINST will ask for is the drive and path
  221.           where the file HELP.NDX can be found.  HELP.NDX is the index file
  222.           that HELP!! and POP-HELP use.  Just type in the name of the drive
  223.           and directory for HELP.NDX (Example  C:\HELP  or A:).
  224.  
  225.           The next thing that HELPINST will ask for is the drive and path
  226.           where the file HELP.DAT can be found.  HELP.DAT is the data file
  227.           that HELP!! and POP-HELP use.  Just type in the name of the drive
  228.           and directory for HELP.DAT (Example  C:\HELP  or A:).
  229.  
  230.           Next HELPINST will ask you if you want to force color to
  231.           monochrome.  Both HELP!! and POP-HELP are quite capable of
  232.           figuring out what type of adapter that you have.  However, if you
  233.           have a monochrome monitor that is attached to a color adapter,
  234.           (such as a Compaq Computer or a composite monitor of some sort)
  235.           you may have trouble reading the screen because of the colors
  236.           used.  By forcing color to monochrome you will be able to read
  237.           the display much easier.
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.           The last thing that HELPINST will ask you for is the key sequence
  245.           to use to start POP-HELP.  Remember that POP-HELP is the pop-up
  246.           or memory resident version of HELP!!.  The key sequences that can
  247.           be used are:
  248.  
  249.           ALT and 0 through 9
  250.           ALT and A through Z
  251.           ALT and F1 through F10
  252.           CTRL-Home, CTRL-End, CTRL-PgUp, and CTRL-PgDn
  253.  
  254.           You  should  have  enough  choices  so  that  POP-HELP's  startup
  255.           keystrokes won't interfere with your other programs.
  256.  
  257.           When you are finished entering the required information press
  258.           F10.  HELPINST will ask you if you are sure.  Press "Y" to save
  259.           and exit or "N" to return to HELPINST.
  260.  
  261.           If you want to ESCape without saving any changes simply press
  262.           ESCape.  HELPINST will ask you if you are sure.  Press "Y" to
  263.           exit without saving or "N" to return to HELPINST.
  264.  
  265.           You may use the up and down arrow keys to move back and forth
  266.           between the different choices.
  267.  
  268.  
  269.  
  270.  
  271.                                     USING HELP!!
  272.  
  273.           HELP!! and POP-HELP are so easy to use and you will probably not
  274.           even need to use the documentation.  Nevertheless, documentation
  275.           is provided.
  276.  
  277.           There are two key differences between HELP!! and POP-HELP and you
  278.           will want to be sure to read the section that explains the
  279.           differences.
  280.  
  281.           Before you are able to use POP-HELP, you need to load it into
  282.           memory by typing POP-HELP and pressing enter.
  283.  
  284.           Once you have loaded POP-HELP, just press the key sequence that
  285.           you defined (using HELPINST) to start POP-HELP.  When you press
  286.           the proper key sequence, POP-HELP will display the list of
  287.           available commands.
  288.  
  289.  
  290.           To start HELP!! all that you need to do is enter HELP and an
  291.           optional command name from the DOS command line.
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.           The syntax for HELP!! is:  HELP [COMMAND]
  304.  
  305.           [COMMAND] is optional.  If HELP is entered without a COMMAND, a
  306.           list of available commands will be displayed and you will be able
  307.           to select one using the cursor keys.  
  308.  
  309.           If HELP!! is entered with a COMMAND name, HELP!! will search the
  310.           list of commands for the command entered.  If HELP!! finds the
  311.           command entered then the list of commands will not be shown.
  312.           Instead the HELP information for the command entered will be
  313.           displayed.
  314.  
  315.           If COMMAND is not found then the list of available commands will
  316.           be displayed and you may scroll through them using the cursor
  317.           keys.
  318.  
  319.           While you are in the list of commands, you may use the following
  320.           cursor keys:
  321.  
  322.           UP and DOWN arrows    scrolls one COMMAND NAME at a time 
  323.           PgUp and PgDn         scrolls one screen at a time 
  324.           Home and End          scrolls to the first and last COMMAND NAMES
  325.           Enter                 selects the COMMAND that is highlighted 
  326.           ESCape                exits the program
  327.  
  328.           While you are in the window which displays the HELP!! text, you
  329.           may use the following cursor keys:
  330.            
  331.           UP and DOWN arrows    scrolls one line at a time 
  332.           PgUp and PgDn         scrolls one screen at a time 
  333.           CTRL-PgUp             displays the previous command
  334.           CTRL-PgDn             displays the next command
  335.           Home and End          scrolls to the first and last lines
  336.           C                     selects the command window 
  337.           ESCape                exits the program
  338.  
  339.  
  340.           Any time that the second window (HELP window) is displayed, you
  341.           may display the COMMAND WINDOW by pressing C.
  342.  
  343.           The COMMAND WINDOW provides an easy way to enter the command that
  344.           you need help with.  The COMMAND WINDOW is designed to allow you
  345.           to enter the command that you have requested help with while you
  346.           are still able to read the help information.  
  347.  
  348.           Even when you are in the COMMAND WINDOW you still have access to
  349.           all of the information in the HELP window (second window).  You
  350.           are still able to scroll the help information up and down using
  351.           the cursor keys.
  352.  
  353.           When you are using HELP, the command that you enter using the
  354.           COMMAND WINDOW will be processed immediately and you will remain
  355.           in HELP!!  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.           When you enter a command using the COMMAND WINDOW with POP-HELP,
  363.           nothing will happen right away.  In fact, nothing will happen at
  364.           all until you exit POP-HELP.  When you do exit POP-HELP, the
  365.           command that you entered will be sent to the keyboard buffer just
  366.           as you entered it.
  367.  
  368.           REMHELP is available if you need to remove POP-HELP from memory. 
  369.           All that you need to do is type REMHELP and POP-HELP will be
  370.           removed from memory.
  371.  
  372.  
  373.  
  374.  
  375.  
  376.                         DIFFERENCES BETWEEN HELP!! AND POP-HELP
  377.  
  378.           There are two major differences between HELP!! and POP-HELP
  379.  
  380.           1.  When using HELP!! (from the command line) you may specify the
  381.           optional command name.  An example of this would be invoking
  382.           HELP!! with the command HELP MODE.  After issuing this command,
  383.           HELP!! will look in its list of commands to see if it can find
  384.           the command MODE.  If it finds the MODE command, then HELP!! will
  385.           immediately display the information available for MODE.  If
  386.           HELP!! cannot find the MODE command then the list of available
  387.           commands will be displayed.  
  388.  
  389.           POP-HELP obviously has no way to allow for this since it is
  390.           invoked by a HOT key sequence.
  391.  
  392.  
  393.           2.  The second difference has to do with the way that HELP!! and
  394.           POP-HELP handle a command entered from the command window.
  395.  
  396.           If you enter a command from the command window using HELP!! it
  397.           will be executed immediately and you will remain inside HELP!!
  398.  
  399.           When you enter a command from the command window using POP-HELP
  400.           nothing will happen right away.  In fact nothing will happen
  401.           until you exit POP-HELP.  When you do exit POP-HELP, however, the
  402.           command that you entered will be passed to the keyboard buffer
  403.           just as you entered it.
  404.  
  405.                         MODIFYING AND ADDING HELP!! COMMANDS
  406.  
  407.           One of the great things about HELP!! and POP-HELP is that you can
  408.           add your own commands or you can change the text for the commands
  409.           that are supplied.
  410.  
  411.           If you want to add to the list of commands you can simply
  412.           edit the text file using a word processor or the EDLIN line
  413.           editor.  If you wish, you may create a completely new file using
  414.           any name that you choose.
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.                                     IMPORTANT:
  423.  
  424.           When you are modifying the text to be used by HELP!! there are a
  425.           few things that you must remember.
  426.  
  427.           1.  The maximum length of any line is 40 characters.  Any text
  428.           over 40 characters will be cut off.
  429.  
  430.           2.  HELP!! and POP-HELP can handle a maximum of 500 different
  431.           commands.  Each command may have up to 135 lines of text.  Each
  432.           command name may be up to 11 characters long.
  433.  
  434.           3.  HELP!! and POP-HELP expect to find an index file so that they
  435.           know where to find the individual commands.  After you have
  436.           finished modifying your text file, you must run the HELPINDX
  437.           program to create an index file.
  438.  
  439.           4.  HELPINDX is very particular about how the commands are
  440.           separated.  Be sure to read below about how new commands are
  441.           recognized. (Using Ctrl-A)
  442.  
  443.  
  444.                                SPECIAL CHARACTERS:
  445.  
  446.           There are a few special characters which will cause special
  447.           effects when used in the text file.  They are listed below.
  448.  
  449.           ^A (Ctrl-A) - notes the start of a new command.  HELPINDX expects
  450.           Ctrl-A to be the first character in the text file being indexed. 
  451.           HELPINDX also expects the command name to immediately follow the
  452.           Ctrl-A.  You may want to take a look at how the HELP.DAT file is
  453.           set up.  
  454.  
  455.           An example of how HELPINDX would expect a text file to look is
  456.           given below.
  457.  
  458.           ^ANEW COMMAND
  459.           This is the start of a new command.
  460.  
  461.           ^A2nd COMMAND
  462.           Here is some text for the second
  463.           command.
  464.  
  465.  
  466.           ^E (Ctrl-E) - makes text yellow on a color monitor or high
  467.           intensity white on a monochrome monitor.
  468.  
  469.           ^B (Ctrl-B) - makes text green on a color monitor or high
  470.           intensity white on a monochrome monitor.
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.           ^N (Ctrl-N) - creates blinking text.  Text will be blinking red
  481.           on a color monitor or blinking high intensity white on a
  482.           monochrome monitor.
  483.  
  484.           ^  (Shift-6) - returns text to normal.  Normal text is light blue
  485.           on a color monitor or light gray on a monochrome monitor.
  486.  
  487.  
  488.  
  489.  
  490.                                    USING HELPINDX:
  491.  
  492.           After you modify your file, you will need to run HELPINDX to make
  493.           your changes usable by HELP!! and POP-HELP.
  494.  
  495.           When you run HELPINDX, you will be asked for the full path where
  496.           the text file to be indexed is located.  For instance, if you are
  497.           using the file HELP.DAT and it is located in C:\DATAFILE then
  498.           enter C:\DATAFILE\HELP.DAT.
  499.  
  500.           You will then be asked the full path where you want the index
  501.           file to be placed.  If you want the file placed in C:\HELP then
  502.           enter C:\HELP, if you want the file placed in the current
  503.           directory then just press enter.
  504.  
  505.           At this point, HELPINDX will display the commands that it is
  506.           indexing until it has indexed the entire file.
  507.  
  508.           After this is finished, you are ready to use HELP!! or POP-HELP
  509.           and your new commands or modified commands will be included.
  510.  
  511.