home *** CD-ROM | disk | FTP | other *** search
/ Complete Bookshop / CompleteWorkshop.iso / utils / helpdos / help.doc < prev    next >
Text File  |  1987-12-22  |  24KB  |  859 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.                                     H E L P
  26.  
  27.  
  28.  
  29.                               A DOS Help Function
  30.  
  31.  
  32.  
  33.                                    Version B
  34.  
  35.  
  36.  
  37.  
  38.                         R E F E R E N C E   M A N U A L
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.                           Focused Magic Software, Inc.
  53.                                  P.O. Box 1069
  54.                            Washington Grove, MD 20880
  55.  
  56.  
  57.  
  58.  
  59.                 Copyright (c) 1987 Focused Magic Software, Inc.
  60.                               All Rights Reserved
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.          This Manual was completely updated to reflect the current
  101.          state of the help programs as of release B.
  102.  
  103.          Specifications subject to change without notice
  104.  
  105.          HELP 2.1, HELP 3.1, HELP 3.2, and HELP 3.3 software copyright
  106.          (C) 1987 FM Software, Inc. All rights reserved.
  107.  
  108.          The Software names in this manual are trademarks or trade
  109.          names of specific manufacturers.
  110.  
  111.          Printed in the United States of America
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                                                         HELP Version B
  136.                                                                  - 3 -
  137.  
  138.  
  139.                                TABLE OF CONTENTS
  140.  
  141.  
  142.          License ..............................................  4
  143.  
  144.          Warranty .............................................  5
  145.  
  146.          Ordering Information .................................  6
  147.  
  148.          Preface ..............................................  7
  149.  
  150.          Introduction .........................................  8
  151.  
  152.          Installation .........................................  9
  153.  
  154.          Getting Started ...................................... 10
  155.  
  156.          Personalizing HELP ................................... 12
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.          Copyright (C) 1987 Focused Magic Software, Inc.
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                                                         HELP Version B
  202.                                                                  - 4 -
  203.  
  204.  
  205.                                     LICENSE
  206.  
  207.  
  208.          All versions of Help, including version B, are distributed
  209.          under the "ShareWare" concept.  They are neither Public
  210.          Domain nor FreeWare.
  211.  
  212.          HELP is copyright (C) 1987 by FM Software, Inc.
  213.  
  214.          Non-registered users are granted a limited license to use
  215.          any version of HELP on a 30 day trial basis for the purpose
  216.          of determining whether it is useful to them.  Use of any
  217.          version of HELP, besides on this trial basis, requires
  218.          registration.  Use of non-registered copies of any version of
  219.          Help by any person, business, corporation, government agency,
  220.          or any other institution is strictly prohibited.
  221.  
  222.          Registration permits a user the license to use the version of
  223.          Help registered on a single computer; a registered user may
  224.          use the program on a different computer, only if the program
  225.          is not run on more than one computer at the same time.
  226.  
  227.          No registered or non-registered user may modify any version
  228.          of HELP in any way, including decompiling or reverse
  229.          engineering of the program.
  230.  
  231.          All users are granted a limited license to make copies of a
  232.          version of HELP only for the trial basis of others and
  233.          subject to the following conditions:
  234.  
  235.               HELP must be copied in unmodified form, including the
  236.               file which contains this license information.
  237.  
  238.               The full HELP documentation which is provided with the
  239.               executable of the HELP program must be included with the
  240.               copy.
  241.  
  242.               The user may not collect or request any fee, charge or
  243.               other compensation for the copy provided.
  244.  
  245.               HELP may not be distributed in conjunction with any
  246.               other product without the express written consent of FM
  247.               Custom Software, Inc.
  248.  
  249.          Operators of electronic bulletin board systems may post any
  250.          version of HELP for downloading by their users only as long
  251.          as the above conditions are followed.
  252.  
  253.          Distributors of public domain or user supported software may
  254.          distribute copies of any version of HELP subject to the above
  255.          conditions and after obtaining written permission from FM
  256.          Software, Inc.  Permission is usually given; write for
  257.          details.
  258.  
  259.  
  260.  
  261.          Copyright (C) 1987 Focused Magic Software, Inc.
  262.  
  263.  
  264.  
  265.  
  266.  
  267.                                                         HELP Version B
  268.                                                                  - 5 -
  269.  
  270.  
  271.                                     WARRANTY
  272.  
  273.          FM Software, Inc. makes no warranty of any kind, expressed or
  274.          otherwise any warranties of merchantability and/or fitness
  275.          for a particular purpose.  FM Custom Software, Inc. shall not
  276.          be liable for any damages, whether direct, or indirect
  277.          arising from the failure of any HELP program to operate in
  278.          the manner desired by a user.  FM Software, Inc. shall not be
  279.          liable for any damage to data or property which may be caused
  280.          directly or indirectly from the use or misuse of any version
  281.          of the HELP program.
  282.  
  283.          IN NO EVENT WILL FM Software, Inc.  BE LIABLE TO ANY USER FOR
  284.          DAMAGES, INCLUDING LOST PROFITS, LOST SAVINGS, OR OTHER
  285.          INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE,
  286.          MISUSE, OR INABILITY TO USE ANY VERSION OF HELP, OR FOR ANY
  287.          CLAIM BY ANY OTHER PARTY.
  288.  
  289.          In the event of permanent failure of a registered user's
  290.          version of HELP, FM Custom Software will replace the version
  291.          at a cost not to exceed the cost of a floppy disk and the
  292.          shipping and handling associated with the mailing of the disk
  293.          to the registered user.
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.          Copyright (C) 1987 Focused Magic Software, Inc.
  328.  
  329.  
  330.  
  331.  
  332.  
  333.                                                         HELP Version B
  334.                                                                  - 6 -
  335.  
  336.  
  337.                               ORDERING INFORMATION
  338.  
  339.  
  340.          A HELP registration license allows the use of the product on
  341.          a regular basis.  Registration includes notification of
  342.          updates and a printed manual.  Users need to register only
  343.          one version of HELP; registration includes licensed use of
  344.          all upgrades.
  345.  
  346.          Individual registrations cost $35.  All upgrades of HELP are
  347.          available to registered users at a reduced cost of $8.  This
  348.          cost is to cover the disk, printing, shipping and handling.
  349.  
  350.          All corporate, business, government or other commercial users
  351.          of any version of HELP must be registered.  An individual
  352.          registration of HELP for a corporation or business does not
  353.          grant the business the right to make unlimited copies of HELP
  354.          for their employees.  A registered copy of HELP is required
  355.          for each user of the program.
  356.  
  357.          FM Software does sell this product at a discount for quantity
  358.          orders and will engage in site licensing.  Please send a
  359.          written request for information about quantity ordering, and
  360.          include in the request the number of copies which you are
  361.          interested in purchasing.
  362.  
  363.          For use outside the US: Send checks drawn on US Banks in US
  364.          dollars.  We can accept non-US currency, however, include an
  365.          additional $5 to cover conversion and collection costs.
  366.  
  367.          Send all requests for registration to:
  368.  
  369.                                FM Software, Inc.
  370.                                  P.O. Box 1069
  371.                            Washington Grove, MD 20880
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.          Copyright (C) 1987 Focused Magic Software, Inc.
  394.  
  395.  
  396.  
  397.  
  398.  
  399.                                                         HELP Version B
  400.                                                                  - 7 -
  401.  
  402.  
  403.                            PREFACE TO HELP VERSION B
  404.  
  405.  
  406.          The B versions of Help 2.1, Help 3.1, Help 3.2, Help 3.3 have
  407.          a new look.  In a effort to save on code size, the Help
  408.          programs now contain a data file with all the DOS command
  409.          information.  In addition, the program comes in two versions
  410.          which are included with the documentation.  The first is a
  411.          version similar to version A in that it is called from the
  412.          DOS command line.  The second is a "Terminate and Stay
  413.          Resident" (TSR) which can be loaded at any time and
  414.          subsequently accessed by typing Alt-H, or a user defined
  415.          "Hot Key".
  416.  
  417.          The B version of Help also will leave your screen in the
  418.          condition from which you called it with the addition of a
  419.          up to 5 lines containing the format of the command on which
  420.          help was requested (this does not apply to the TSR version,
  421.          which will not alter the screen).  All of the improvements
  422.          and changes to the Help Versions are explained within the
  423.          Reference Manual.
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.          Copyright (C) 1987 Focused Magic Software, Inc.
  460.  
  461.  
  462.  
  463.  
  464.  
  465.                                                         HELP Version B
  466.                                                                  - 8 -
  467.  
  468.  
  469.                                   INTRODUCTION
  470.  
  471.  
  472.               Help has designed to provide a quick reference for the
  473.          DOS commands and programs which are used frequently.  It
  474.          is available for DOS versions 2.1, 3.1, 3.2, and 3.3.  The
  475.          program consists of the executable code as well as a data
  476.          file containing the information about the various commands.
  477.  
  478.               In addition to the data about commands, programs and
  479.          features of DOS, the Help program has been designed to allow
  480.          the user to add his own text files containing information
  481.          about programs and utilities which he uses regularly.  These
  482.          files can be any Ascii text file up to 69 lines in length.
  483.  
  484.               Help comes in two versions.  One is a version which is
  485.          called by typing in "help" at the DOS Command Line.  The
  486.          second is memory resident and is installed by typing
  487.          "tsrhelp" at the DOS Command Line.  Thereafter, the memory
  488.          resident version is typically invoked by typing "Alt-H".
  489.  
  490.          Help Files:
  491.  
  492.               In order to run any version of help the following files
  493.          are required:
  494.  
  495.               HELP.COM, the help executable file;
  496.               TSRHELP.COM, the resident version of help;
  497.               COMMANDS.HLP, the help data file.
  498.  
  499.          In addition, any text files, which are created by the user,
  500.          should be located in the directory with the above files.
  501.          These files should be named "<command>.hlp", where <command>
  502.          is the name of the function which is requested from the help
  503.          command line.  It should be noted that the user created help
  504.          files will not be included in the index of DOS commands and
  505.          functions which are supported by HELP (the display which is
  506.          invoked by typing "help<cr>").
  507.  
  508.          HELP Environment Variables:
  509.  
  510.               Version B of HELP supports the use of DOS Environment
  511.          Variables.  These variables are used to set the filename of
  512.          the main help file, if other than the default; to designate
  513.          the path where all the help files exist; the colors which the
  514.          help screens will be displayed in; and the Hot Key which is
  515.          to be used to invoke the resident version of HELP.  The exact
  516.          description and use of the HELP environment variables are
  517.          contained in the Personalizing HELP section of this manual.
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.          Copyright (C) 1987 Focused Magic Software, Inc.
  526.  
  527.  
  528.  
  529.  
  530.  
  531.                                                         HELP Version B
  532.                                                                  - 9 -
  533.  
  534.  
  535.                                 INSTALLING HELP
  536.  
  537.  
  538.               Once the files have been dearchived, they need to be
  539.          properly located on the disk.  HELP assumes that it will be
  540.          used on a hard disk with the drive letter c:.  These defaults
  541.          can be changed by use of environment variables, if the
  542.          default configuration is particularly unpalatable to the
  543.          user.
  544.  
  545.               The first step is to create a subdirectory "\help".
  546.          This subdirectory must be one level below the root directory
  547.          on the drive c:.  The file "commands.hlp" must then be placed
  548.          into this subdirectory.  Additionally, all user created help
  549.          files must also be placed in this directory.  The files
  550.          "help.com"  and "tsrhelp.com" may be placed anywhere on the
  551.          disk, and ideally should be placed within the DOS PATH.
  552.          Usually, this file is placed either in the directory "\help",
  553.          or in the directory where external DOS command files are kept
  554.          (such as "format.com").  Note that if the file is placed in
  555.          the "\help" directory, then a path should be created to allow
  556.          DOS to find the file.  Usually this is accomplished by
  557.          placing the command "PATH C:\HELP" in the "autoexec.bat"
  558.          file.  At this point help is ready to run.  Simply type "help
  559.          <command>" at the command line to get help about the DOS
  560.          command you specified.
  561.  
  562.               Not everyone will want to use this particular directory
  563.          configuration.  Some may wish to use a different directory
  564.          name, and others may wish to put the information file on
  565.          another disk, such as a RAM disk.  HELP will be happy to look
  566.          elsewhere for the information requested, but must be told
  567.          where to look.  This is accomplished by the used of an
  568.          environment variable.  HELP looks in the environment for the
  569.          string "HELPPATH" (among others) to determine if it should be
  570.          looking elsewhere for its information file(s).  To set this
  571.          environment variable, simple type "SET HELPPATH=<path>" at
  572.          the DOS prompt, where <path> is a full DOS path, including a
  573.          drive specification (e.g. d:\tools\hfiles).  One warning, DO
  574.          NOT follow the <path> with a backslash, this will lead to
  575.          unpredictable results.  Best results are obtained by putting
  576.          this DOS command in you "autoexec.bat" file.  For more
  577.          information about the environment variables, see the section
  578.          Personalizing HELP.
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.          Copyright (C) 1987 Focused Magic Software, Inc.
  592.  
  593.  
  594.  
  595.  
  596.  
  597.                                                         HELP Version B
  598.                                                                 - 10 -
  599.  
  600.  
  601.                            GETTING STARTED WITH HELP
  602.  
  603.  
  604.          Command Line Version:
  605.  
  606.               To use HELP, type the following command:
  607.  
  608.                    HELP <command name> [/F]
  609.  
  610.          where <command name> is the name of the command on which help
  611.          is wanted and /F indicates that only the format of the
  612.          command is desired.  The <command name> and /F parameters are
  613.          both optional.
  614.  
  615.               If HELP is invoked with no parameters, a list of DOS
  616.          commands which are supported by the HELP version being used
  617.          is displayed.  When HELP is called with a command name, the
  618.          information about that command is displayed to the screen.
  619.          If the /F parameter is used, only the format of the command
  620.          is written to the screen.  To exit HELP, type ESC.
  621.  
  622.               It is possible for the information about a command to
  623.          require multiple screens.  To page through the screens use
  624.          Pg-Up and Pg-Dn.  In addition, when there are more than two
  625.          screens worth of information, the Home and End keys are also
  626.          active.  The Home key will display the first page of
  627.          information and the End key will display the last page of
  628.          information.  It should be noted that when only two pages of
  629.          information about a command exist, the Pg-Up and Pg-Dn keys
  630.          function identically to the Home and End keys, respectively.
  631.  
  632.  
  633.          Memory Resident Version:
  634.  
  635.               If the Memory Resident version of HELP is being used,
  636.          installation of the program is required before it can be
  637.          used.  To install the program, type "TSRHELP" at any DOS
  638.          command line.  After the initialization of the program, the
  639.          user can gain access to it by typing ALT-H.  The <command
  640.          name> parameter is requested in a small window.  To get help
  641.          on a specific subject, enter the subject and press carriage
  642.          return.  If the index of subjects is desired, then simply hit
  643.          carriage return at the prompt.  The /F parameter is
  644.          meaningless in this version.  As in the Command line version,
  645.          multiple screens of data are manipulated using the Pg-Up,
  646.          Pg-Dn, Home and End keys.
  647.  
  648.          User Created HELP Files:
  649.  
  650.               The user can create his own HELP files easily, greatly
  651.          enhancing the utility of HELP.  The files are simply Ascii
  652.          text files which are no longer than 69 lines in length.  Once
  653.          the text file has been created, store in the same directory
  654.          where the file "commands.hlp" was stored.  The file MUST have
  655.  
  656.  
  657.          Copyright (C) 1987 Focused Magic Software, Inc.
  658.  
  659.  
  660.  
  661.  
  662.  
  663.                                                         HELP Version B
  664.                                                                 - 11 -
  665.  
  666.  
  667.          the extension ".hlp".  From then on, entering "help <file>"
  668.          will display the text file "file.hlp" within the HELP
  669.          environment.  Note that the extension ".hlp" is NOT entered
  670.          when requesting the display of a User Defined Help File.  As
  671.          an example, if the user had an address list that he wished to
  672.          be able to easily access, he could put the list into an Ascii
  673.          file called "address.hlp", and store it in the directory
  674.          "\help".  From then on, when he wished to reference the list
  675.          he would simply type "help address" from the command line, or
  676.          enter "address" in the window of the resident version.  The
  677.          file that he developed would then be displayed.
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.  
  692.  
  693.  
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.          Copyright (C) 1987 Focused Magic Software, Inc.
  724.  
  725.  
  726.  
  727.  
  728.  
  729.                                                         HELP Version B
  730.                                                                 - 12 -
  731.  
  732.  
  733.                                PERSONALIZING HELP
  734.  
  735.          HELP Environment:
  736.  
  737.               Version B of HELP defaults to the following:
  738.  
  739.               *  The command file for HELP is "commands.hlp".
  740.  
  741.               *  The directory which contains the help files is
  742.                  "c:\help".
  743.  
  744.               *  The default colors are high intensity white on
  745.                  black for the help text and high intensity white on
  746.                  blue for the status information.
  747.  
  748.               *  The Hot Key for the resident version of HELP is
  749.                  Alt-H.
  750.  
  751.          To change the defaults, the environment variables are used.
  752.          The environment variables can be entered at any DOS command
  753.          line or placed in the system initialization batch file,
  754.          "autoexec.bat".  The environment variables required by help
  755.          are as follows:
  756.  
  757.               *  helpfile -- changes the default help filename
  758.  
  759.               *  helppath -- changes default directory for the help
  760.                              text files
  761.  
  762.               *  helpcolo -- changes the default colors for the help
  763.                              text and status information
  764.  
  765.               *  helphkey -- changes the Hot Key for the resident
  766.                              version
  767.  
  768.          Each of these variables are initialized within the
  769.          "autoexec.bat" file using the DOS "set" command as follows:
  770.  
  771.               set helpfile=[filename.ext]
  772.  
  773.                   where : filename.ext is the filename you wish to use
  774.                           for the main information file.  Note that
  775.                           you will have rename the file
  776.                           "commands.hlp", and that the file can not be
  777.                           modified without affecting the operation of
  778.                           HELP.
  779.  
  780.               set helppath=[d:][path]
  781.  
  782.                   where : d is the drive letter, and
  783.                           path is a full DOS directory path where the
  784.                           HELP information files will be located.
  785.  
  786.  
  787.  
  788.  
  789.          Copyright (C) 1987 Focused Magic Software, Inc.
  790.  
  791.  
  792.  
  793.  
  794.  
  795.                                                         HELP Version B
  796.                                                                 - 13 -
  797.  
  798.  
  799.          set helpcolo=TF,TB,SF,SB
  800.  
  801.                   where : TF is the text foreground color,
  802.                           TB is the text background color,
  803.                           SF is the status line foreground color, and
  804.                           SB is the status line background color.
  805.  
  806.                   The following codes are used for the colors :
  807.  
  808.                           00 - Black
  809.                           01 - Blue
  810.                           02 - Green
  811.                           03 - Cyan
  812.                           04 - Red
  813.                           05 - Magenta
  814.                           06 - Brown
  815.                           07 - Grey
  816.                           08 - High Intensity Black
  817.                           09 - High Intensity Blue
  818.                           10 - High Intensity Green
  819.                           11 - High Intensity Cyan
  820.                           12 - High Intensity Red
  821.                           13 - High Intensity Magenta
  822.                           14 - Yellow
  823.                           15 - White
  824.  
  825.               Please note that leading zeros are expected.
  826.  
  827.          set helphkey=alt-<key>
  828.  
  829.               where : key can be any alphabetic key (a-z),
  830.                       any numeric key (0-9), or
  831.                       any function key (F1-F10)
  832.  
  833.               The key specified will be the hot key used for HELP.
  834.               For example, the command "set helphkey=alt-F7" will make
  835.               the keystroke "alt-F7" the hot key for bringing up HELP.
  836.  
  837.  
  838.          Notes :
  839.  
  840.          * Both helpcolo and helphkey must be specified before
  841.            installing TSRHELP.  TSRHELP will look for these
  842.            specifications at installation time, and will not look for
  843.            them again.
  844.  
  845.          * When using the environment variables, you may run out of
  846.            environment space.  Later versions of DOS allow you to
  847.            increase the size of the environment by including the
  848.            command "shell=command.com /e:xxxxx" in your "config.sys"
  849.            file, where xxxxx is the number of bytes to use for the
  850.            environment.  Please see your DOS manual for more
  851.            information.
  852.  
  853.  
  854.  
  855.          Copyright (C) 1987 Focused Magic Software, Inc.
  856.  
  857.  
  858.  
  859.