home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / DOS_HELP / PC_HELP1.ZIP / HELP.DOC < prev    next >
Encoding:
Text File  |  1986-01-20  |  14.8 KB  |  310 lines
  1.  
  2.  
  3.                      IBM PERSONAL COMPUTER ON-LINE HELP
  4.                          V5.1 by D.N.Ikle' 01/20/85
  5.                          For public domain use only
  6.  
  7.  
  8.        PURPOSE
  9.  
  10.        On-Line HELP is designed to provide an on-line description of all
  11.        the commands and utilities available on an IBM PC/XT or PC
  12.        compatible hard disk system under IBM PC DOS 3.x plus a variety
  13.        of additional utilities.  Since all descriptions are stored in
  14.        text files, On-Line HELP can easily be tailored to describe any
  15.        particular system configuration.  An abbreviated version can also
  16.        be installed on a floppy disk based PC or PC compatible system
  17.        under IBM or MS DOS 2.x.
  18.  
  19.  
  20.        REQUIREMENTS
  21.  
  22.        The minimum requirements are an IBM PC or PC compatible, a color
  23.        or monochrome monitor in 80 column display mode, and version 2.0
  24.        or higher of MS or IBM DOS.  A hard disk significantly improves
  25.        performance but is not required.  The public domain utility
  26.        DPATH, or its equivalent, is required if the HELP text files are
  27.        stored in sub-directories.  Finally, the public domain utility
  28.        ARC is required to extract the individual files from the
  29.        distribution files.
  30.  
  31.  
  32.        INTRODUCTION
  33.  
  34.        HELP accepts 1-8 character keyword input from the user and
  35.        displays the contents of the text file with the same name as the
  36.        keyword with the extension .###.  Since any useful implementation
  37.        of On-Line HELP will use at least 60 *.### files, the tree
  38.        structure feature of DOS 2.0 and higher should be used to
  39.        organize these files on the hard disk.  However, appropriate
  40.        paths must be created so that DOS can find the executable HELP
  41.        file and the *.### HELP text files in whatever directory
  42.        structure the user has created.  Specifically, the DOS PATH
  43.        command is used to allow HELP.COM to be executed from any
  44.        sub-directory, and the public domain utility DPATH, or its
  45.        equivalent, is used to enable HELP.COM to read the requested
  46.        *.### text file.
  47.  
  48.  
  49.        FILES
  50.  
  51.        On-Line HELP is distributed on bulletin boards in the two archive
  52.        files PC-HELP1.ARC and PC-HELP2.ARC.  The public domain utility
  53.        ARC is required to extract the individual files.
  54.  
  55.        PC-HELP1.ARC contains everything needed to install HELP and to
  56.        describe IBM DOS 3.1 commands.  The files included are:
  57.  
  58.          PC-HELP.DOC       Description of the archive files.
  59.          TEMPLATE          Skeleton HELP display file.
  60.          HELP.COM          On-Line HELP program.
  61.          HELP.DOC          Documentation for On-Line HELP.
  62.          DPATH.COM         Public domain path extender utility.
  63.          DPATH.DOC         Documentation for DPATH.
  64.          HELP.###          Detailed HELP for On-Line HELP.
  65.          COMMAND1.###      Annotated list of IBM DOS 3.1 commands.
  66.          HELPDOS3.ARC      HELP files for IBM DOS 3.1 commands.
  67.  
  68.        PC-HELP2.ARC contains additional HELP files that describe the
  69.        Norton Utilities Version 3.1 and 24 common public domain
  70.        utilities, in addition to the Turbo Pascal Version 3.0 source
  71.        code for HELP.  The files included are:
  72.  
  73.          PC-HELP.DOC       Description of the archive files.
  74.          HELP.PAS          Turbo Pascal source code for On-Line HELP.
  75.          COMMAND2.###      Annotated list of all commands/utilities.
  76.          HELPNORT.ARC      HELP files for the Norton Utilities 3.1.
  77.          HELPPUBL.ARC      HELP files for public domain utilities.
  78.  
  79.  
  80.        INSTALLATION
  81.  
  82.        Because of the large number of possibilities for different system
  83.        configurations, the following installation instructions are
  84.        necessarily very general. They should, however, provide enough
  85.        guidance to enable anyone to install On-Line HELP on their
  86.        system.
  87.  
  88.          1.  Extract all HELP files from the archive files using the
  89.          public domain utility ARC.
  90.  
  91.          2.  Copy HELP.COM and DPATH.COM to the sub-directory
  92.          containing your DOS external commands and/or whatever other
  93.          system utilities you may have.  You presumably already have
  94.          the appropriate path set up to allow you to execute these
  95.          commands from any sub-directory on the system.  If not, you
  96.          must use the DOS PATH command to create one.
  97.  
  98.          3.  Copy the *.### HELP files into some directory structure
  99.          that is compatible with that already on your system. Delete
  100.          any *.### files that describe commands not on your system.
  101.          If your system is under IBM DOS 2.x or MS DOS 2.x,  the
  102.          files supplied for IBM DOS 3.1 will have to be edited.
  103.  
  104.          4.  Rename one of the COMMAND?.### files to COMMANDS.### and
  105.          edit it appropriately so that it lists only those commands
  106.          actually described in the *.### files you installed.
  107.  
  108.          5.  Create an extended data file search path to the *.### files
  109.          by inserting appropriate SET DP= and DPATH statements into your
  110.          AUTOEXEC.BAT file.  See DPATH.DOC for detailed instructions on
  111.          how that works.
  112.  
  113.          6.  Re-boot the system and begin using On-Line HELP, provided
  114.          that the screen is set to an 80 column display mode.
  115.  
  116.        Once On-Line HELP is running on your system, you can use your own
  117.        imagination to create other *.### files. For example, I have the
  118.        additional files SYSTEM.### and NORTON.### that describe my
  119.        system configuration and list the Norton Utilities, respectively.
  120.        Note that HELP.COM does not expand tabs, so that any *.### file
  121.        that is edited must be saved without tabs.
  122.  
  123.        Of course much of the preceeding is of little use if you want to
  124.        install HELP on a floppy-disk based system.  In that case, simply
  125.        cram as much as you can on your system diskette and go for it.
  126.        Another possibility is to put all the *.### files on a separate
  127.        diskette and create a data path to it with DPATH.
  128.  
  129.  
  130.        USAGE
  131.  
  132.                            HELP [keyword ... ]
  133.  
  134.        where the optional arguments may be any number of 1 to 8
  135.        character keywords separated by blanks.  For example,
  136.  
  137.          HELP              Displays a menu for entry of a keyword.
  138.  
  139.          HELP ?            Displays a brief summary of On-Line HELP.
  140.  
  141.          HELP HELP         Displays a detailed description of HELP.
  142.  
  143.          HELP command      Displays HELP for the specified command.
  144.  
  145.          HELP feature      Displays HELP for the specified feature.
  146.                            Features supplied with On-Line HELP are:
  147.  
  148.                            AUTOEXEC  Special automatic batch file.
  149.                            BATCH     Batch file sub-commands.
  150.                            CONFIG    Configuration file sub-commands..
  151.                            FILTERS   Processing standard input/output.
  152.                            PIPES     Piping output between programs.
  153.                            REDIRECT  Redirecting standard input/output.
  154.                            COMMANDS  Annotated list of all commands.
  155.  
  156.          HELP keyword ...  Displays the HELP file for each requested
  157.                            command or feature in sequence.
  158.  
  159.        Keywords can be entered in either upper or lower case.  Entry of
  160.        HELP with no keywords displays a keyword entry menu in which
  161.        keywords may be entered into an eight character keyword entry
  162.        field.  In addition to character keys allowed in DOS filenames,
  163.        the following keyboard keys are available:
  164.  
  165.          Left              Moves cursor one character to the left.
  166.          Right             Moves cursor one character to the right.
  167.          Home              Moves cursor to the beginning of the field.
  168.          End               Moves cursor to the end of the entry.
  169.          Insert            Inserts one blank character at the cursor.
  170.          Delete            Deletes the character over the cursor.
  171.          Backspace         Deletes character to the left of the cursor.
  172.          Escape            Erases the current entry.
  173.          Enter             Displays HELP for the current entry or quits.
  174.          ?                 Displays brief instructions in using HELP.
  175.  
  176.        Pressing any other key produces a soft speaker tone.  Press Enter
  177.        to display HELP for the current keyword entry.  Entry of an
  178.        invalid keyword on either the command line or on the keyword
  179.        entry menu produces a loud speaker tone, and the entry menu is
  180.        displayed with the invalid entry to be edited.  By definition, an
  181.        invalid entry is one for which the corresponding file with
  182.        extension .### does not exist in the current data file path.
  183.        Keywords entered on the command line are described in sequence
  184.        with interruptions by the entry menu as invalid entries are
  185.        encountered.  Pressing Enter while the entry field is blank
  186.        either returns to processing of command line entries or, if there
  187.        are no such entries outstanding, to the operating system at the
  188.        point where HELP was invoked.
  189.  
  190.        Following acceptance of a valid keyword, up to 8 pages of text
  191.        (23 lines each) are displayed from the file that describes that
  192.        keyword.  On any HELP screen, the following keyboard keys are
  193.        available:
  194.  
  195.          Up                Scrolls the file up one line.
  196.          Down              Scrolls the file down one line.
  197.          Page Up           Scrolls the file up one page.
  198.          Page Down         Scrolls the file down one page.
  199.          Home              Displays the first page in the file.
  200.          End               Displays the last page in the file.
  201.          Enter             Returns to entry menu or next HELP request.
  202.          Escape            Returns to the operating system.
  203.  
  204.        Pressing any other key produces a soft speaker tone.  The bottom
  205.        line of the display summarizes these functions and indicates when
  206.        the end of the file has been reached.  Pressing Enter returns
  207.        control to the keyword entry menu or returns to processing of
  208.        command line entries if any such entries are outstanding.
  209.        Pressing Escape returns control to the operating system, while
  210.        the last HELP screen remains displayed and the cursor is placed
  211.        on the bottom line of the display.
  212.  
  213.  
  214.        NOTATION
  215.  
  216.        The notation used in the *.### files to describe the correct
  217.        command syntax is compatible with that used in the IBM DOS
  218.        manuals, except that the vertical bar used by IBM to indicate
  219.        "or" is replaced by !.  In particular:
  220.  
  221.          Keywords are given in capital letters, but may be entered in
  222.          either case.  Words in lower case must be substituted for as
  223.          described in the remarks.  Items in square brackets ([]) are
  224.          optional.  Do not enter the brackets.  Items separated by a !
  225.          means that you enter one or the other, but not both.  An
  226.          ellipsis (...) means that the preceeding item may be
  227.          repeated.  Punctuation other than [] and !  must be included
  228.          as shown.
  229.  
  230.          d:       denotes a drive, either fixed or floppy.
  231.          path     denotes a sequence of directory names (<64 characters)
  232.          filename denotes a disk file name of 1-8 characters.
  233.          .ext     denotes an optional file extension of 1-3 characters.
  234.          filespec denotes a file name of the form filename.ext
  235.  
  236.          The global filename characters are ?, which indicates that
  237.          any character can occupy that position, and *, which
  238.          indicates that any character can occupy that and all
  239.          remaining positions in the filename or extension.
  240.  
  241.        Note that beginning with IBM DOS 3.0 all external commands may be
  242.        preceeded by a drive and path specification.
  243.  
  244.  
  245.        MAINTENANCE
  246.  
  247.        The individual *.### HELP displays are ASCII text files that may
  248.        be easily edited using any text editor.  Most displays have been
  249.        kept to one screen for simplicity, but some are longer to
  250.        describe certain commands or features.  The maximum allowable
  251.        length of a *.### file is 184 lines (8 pages of 23 lines each) of
  252.        80 column text.  A skeleton HELP file is provided in the
  253.        distribution archive files to assist in the creation of new HELP
  254.        files.  Note that HELP.COM does not expand tabs, so that any
  255.        *.### file that is edited must be saved without tabs.
  256.  
  257.  
  258.        HISTORY
  259.  
  260.        On-Line HELP started out as a programming exercise in BASIC and
  261.        has evolved into a rewarding educational experience in Turbo
  262.        Pascal. I have also found it invaluable in my efforts to keep the
  263.        clutter around my XT to a minimum.
  264.  
  265.        Version 5.0 incorporates numerous improvements that enhance
  266.        program function and speed its execution.  For example, the
  267.        instruction screen is stored internally as an array, the heap is
  268.        used to save and restore the initial display screen, all writing
  269.        to the screen is done through the screen buffer, and the keyword
  270.        entry field on the main menu has full editing capability.  This
  271.        version has been tested on an IBM PC/XT, an IBM AT, and on
  272.        several PC clones using both color and monochrome monitors.
  273.  
  274.        Version 5.1 blanks the cursor when HELP screens are displayed,
  275.        displays the menu and HELP screens in color on a color monitor,
  276.        and includes minor changes to the documentation.
  277.  
  278.  
  279.        ACKNOWLEDGEMENTS
  280.  
  281.        This program relies on another public domain program DPATH, by
  282.        James A. McGreggor Jr., that allows HELP to function in its
  283.        current design.  It is a very useful utility that fills a major
  284.        void in IBM/MS DOS and it should be a part of any hard disk
  285.        system.
  286.  
  287.        In addition, the following public domain Turbo Pascal procedures
  288.        are used in the program:  FASTWRITE is an inline routine, by
  289.        Marshall Brain, that writes text to the screen very quickly
  290.        through the video memory; a set of procedures by Brenston Worrell
  291.        was adapted to implement the editing capability of the keyword
  292.        entry menu; two procedures that remove and restore the cursor
  293.        were adapted from an article by Mark Brown in TUG Lines, the
  294.        journal of the Turbo User Group.
  295.  
  296.  
  297.        SOURCE
  298.  
  299.        This utility is placed in the public domain by its author and is
  300.        dedicated to the continued growth of public domain software.
  301.        Comments and suggestions are welcomed. Messages may be left on
  302.        the Denver_Fido 104/56 303-973-9338.
  303.  
  304.        Copyright 1985 by David N. Ikle'.  All rights reserved.
  305.  
  306.                                David N. Ikle'
  307.                                1671 Newport St.
  308.                                Denver, CO 80220
  309.                                303-333-9322
  310.