home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / DOS_HELP / PC_HELP1.ZIP / HELP.### < prev    next >
Encoding:
Text File  |  1986-01-19  |  6.2 KB  |  113 lines
  1. COMMAND:  HELP                                  DOCUMENTATION : On-line
  2.  
  3. FUNCTION: Provides an on-line description of all the commands and utilities
  4.           available on the system as well as brief descriptions of various
  5.           features of the system.
  6.  
  7. FORMAT:   HELP [keyword ...]
  8.  
  9. TYPE:     Public domain utility, Version 5.1.
  10.  
  11. REMARKS:  The optional arguments may be any number of 1 to 8 character
  12.           keywords separated by blanks.  For example,
  13.  
  14.           HELP              Displays a menu for entry of a keyword.
  15.  
  16.           HELP ?            Displays a brief summary of On-Line HELP.
  17.  
  18.           HELP HELP         Displays a detailed description of On-Line HELP.
  19.  
  20.           HELP command      Displays HELP for the specified command.
  21.  
  22.           HELP feature      Displays HELP for the specified feature.
  23.                             Features supplied with HELP are:
  24.  
  25.                             AUTOEXEC  Special automatic batch file.
  26.                             BATCH     Batch file sub-commands.
  27.                             CONFIG    Configuration file sub-commands..
  28.                             FILTERS   Processing of standard input/output.
  29.                             PIPES     Piping of output between programs.
  30.                             REDIRECT  Redirection of standard input/output.
  31.                             COMMANDS  Annotated list of all commands.
  32.  
  33.           HELP keyword ...  Displays the HELP file for each requested
  34.                             command or feature in sequence.
  35.  
  36.           Keywords can be entered in either upper or lower case.  Entry of HELP
  37.           with no keywords displays a keyword entry menu in which keywords may
  38.           be entered into an eight character keyword entry field. In addition
  39.           to character keys allowed in DOS filenames, the following keyboard
  40.           keys are available:
  41.  
  42.             Left            Moves cursor one character to the left.
  43.             Right           Moves cursor one character to the right.
  44.             Home            Moves cursor to the beginning of the field.
  45.             End             Moves cursor to the end of the entry.
  46.             Insert          Inserts one blank character at the cursor.
  47.             Delete          Deletes the character over the cursor.
  48.             Backspace       Deletes character to the left of the cursor.
  49.             Escape          Erases the current entry.
  50.             Enter           Displays HELP for the current entry or quits.
  51.             ?               Displays brief instructions in using HELP.
  52.  
  53.           Pressing any other key produces a soft speaker tone.  Press Enter to
  54.           display HELP for the current keyword entry.  Entry of an invalid
  55.           keyword on either the command line or on the keyword entry menu
  56.           produces a loud speaker tone, and the entry menu is displayed with
  57.           the invalid entry to be edited.  By definition, an invalid entry is
  58.           one for which the corresponding file with extension .### does not
  59.           exist in the current data file path.  Keywords entered on the command
  60.           line are described in sequence with interruptions by the entry menu
  61.           as invalid entries are encountered.  Pressing Enter while the entry
  62.           field is blank either returns to processing of command line entries
  63.           or, if there are no such entries outstanding, to the operating system
  64.           at the point where HELP was invoked.
  65.  
  66.           Following acceptance of a valid keyword, up to 8 pages of text (23
  67.           lines each) are displayed from the file that describes that keyword.
  68.           On any HELP screen, the following keyboard keys are available:
  69.  
  70.             Up              Scrolls the file up one line.
  71.             Down            Scrolls the file down one line.
  72.             Page Up         Scrolls the file up one page.
  73.             Page Down       Scrolls the file down one page.
  74.             Home            Displays the first page in the file.
  75.             End             Displays the last page in the file.
  76.             Enter           Returns to entry menu or next HELP request.
  77.             Escape          Returns to the operating system.
  78.  
  79.           Pressing any other key produces a soft speaker tone.  The bottom line
  80.           of the display summarizes these functions and indicates when the end
  81.           of the file has been reached.  Pressing Enter returns control to the
  82.           keyword entry menu or returns to processing of command line entries
  83.           if any such entries are outstanding.  Pressing Escape returns control
  84.           to the operating system, while the last HELP screen remains displayed
  85.           and the cursor is placed on the bottom line of the display.
  86.  
  87.           The notation used in HELP files to describe the correct command
  88.           syntax is compatible with that used in the IBM DOS manuals, except
  89.           that the vertical bar used by IBM to indicate "or" is replaced by !.
  90.           In particular:
  91.  
  92.             Keywords are given in capital letters, but may be entered in either
  93.             case.  Words in lower case must be substituted for as described in
  94.             the remarks.  Items in square brackets ([]) are optional.  Do not
  95.             enter the brackets.  Items separated by a !  means that you enter
  96.             one or the other, but not both.  An ellipsis (...) means that the
  97.             preceeding item may be repeated.  Punctuation other than [] and !
  98.             must be included as shown.
  99.  
  100.             d:       denotes a drive, either fixed or floppy.
  101.             path     denotes a sequence of directory names of 1-63 characters.
  102.             filename denotes a disk file name of 1-8 characters.
  103.             .ext     denotes an optional file extension of 1-3 characters.
  104.             filespec denotes a file name of the form filename.ext
  105.  
  106.             The global filename characters are ?, which indicates that any
  107.             character can occupy that position, and *, which indicates that any
  108.             character can occupy that and all remaining positions in the
  109.             filename or extension.
  110.  
  111.           Note that beginning with IBM DOS 3.0 all external commands may be
  112.           preceeded by a drive and path specification.
  113.