home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / DOS_HELP / HELP30.ZIP / HELP.DOC < prev    next >
Encoding:
Text File  |  1990-10-24  |  14.6 KB  |  397 lines
  1.  
  2.  
  3.  
  4.      HELP(1)                  MS-DOS utilities                  HELP(1)
  5.  
  6.  
  7.  
  8.      NAME
  9.           HELP - obtain help on DOS commands
  10.  
  11.      SYNOPSIS
  12.           help [ -1facpbqh ] [ -i[n] ] [ -k|K keyword ...] [keyword
  13.           ... ]
  14.  
  15.      DESCRIPTION
  16.           Help is a program to retrieve and display entries from a
  17.           help file. It can operate in a full screen interactive
  18.           browsing mode, or a command line mode which writes only to
  19.           standard output and should work on generic MSDOS computers.
  20.           The helpfiles are pure ascii and can easily be edited and
  21.           extended for local variations in commands.
  22.  
  23.      INTERACTIVE HELP
  24.           If help is entered without any commands specified, it enters
  25.           a full screen interactive help browsing mode.  A window is
  26.           placed on the screen with a sorted list of all available
  27.           help entries.  There is always one entry highlighted, and
  28.           pressing <return> will retrieve help entry for this item.
  29.           If environment variable PAGER is defined, it is assumed to
  30.           be a program to be used for displaying the help entry,
  31.           otherwise the entry is copied directly to the screen.
  32.           Options allow the action to be customised for you favourite
  33.           pager.  A program used for the PAGER must be able to read
  34.           from a pipe.  Selection from the list continues until <ESC>
  35.           is pressed.
  36.  
  37.           NOTE:  use of a PAGER variable may slow the response
  38.           noticeably, unless the PAGER program is placed in RAM disk,
  39.           and the path set to include this. The command processor
  40.           (COMMAND.COM or other) is not used for this (PAGER is
  41.           executed directly) When interactive mode is used, the screen
  42.           will be saved and restored after use.  In addition, the
  43.           temporary file necessary for this operation may be placed in
  44.           a RAM disk by setting variable TMPDIR or TMP to a suitable
  45.           location.
  46.  
  47.           The following keys are recognised in interactive mode:
  48.  
  49.           <return>
  50.                select the current item <space>
  51.  
  52.           <up>
  53.                move current line up or down, scrolling as needed
  54.                <down>
  55.  
  56.           <home>
  57.                jump to beginning and end of list, respectively <end>
  58.  
  59.           <pageup> <pagedown>
  60.                scroll the list one window at a time
  61.  
  62.  
  63.      Page 1                                           (printed 9/23/90)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      HELP(1)                  MS-DOS utilities                  HELP(1)
  71.  
  72.  
  73.           A-Z
  74.                alphabetic keys will scroll the list to the first entry
  75.                beginning with the letter you type, or the following
  76.                entry if none matches
  77.  
  78.           F1
  79.                pop up a help window describing key actions
  80.  
  81.           F2
  82.                toggle between displaying name, or full synopsis line
  83.  
  84.           F3
  85.                toggle synopsis line on current item only
  86.  
  87.           F4
  88.                extract a list of cross references from the current
  89.                item, and open a new selection window.  This can be
  90.                used recursively
  91.  
  92.           F10
  93.                window goes into move/resize mode.  Use arrow keys to
  94.                move it, shift-arrows to resize left and bottom edges,
  95.                <esc> or F10 to continue (see below)
  96.  
  97.           <ESC>
  98.                Exit the program and restore screen
  99.  
  100.           Moving/Resizing the Window:
  101.           The window containing the list of keywords can be moved or
  102.           resized by pressing F10.  This ability is for the benefit of
  103.           other programs that call help as a child process, with a
  104.           custom help file.  The window can be moved and resized with
  105.           the following keys:
  106.  
  107.           arrow keys:
  108.                move window 1 space at a time in the appropriate
  109.                direction
  110.  
  111.           control-arrow keys:
  112.                move window to extreme edge of screen in the
  113.                appropriate direction
  114.  
  115.           shift-arrow keys
  116.                resize by dragging right and bottom edges of the window
  117.  
  118.           control-shift-arrow keys
  119.                resize by moving right and bottom edges maximum
  120.                possible distance
  121.  
  122.           <ESC>
  123.                redraw window in the current position and continue with
  124.                program
  125.  
  126.           F10
  127.  
  128.  
  129.      Page 2                                           (printed 9/23/90)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      HELP(1)                  MS-DOS utilities                  HELP(1)
  137.  
  138.  
  139.                redraw window in the current position and continue with
  140.                program, but attempt to "lock" window position so that
  141.                a subsequent call to this program will use the new
  142.                window position.  This function uses the
  143.                "Interapplication Communication Area" (ICA) in the BIOS
  144.                data block. If any other program is also using the ICA,
  145.                help will NOT overwrite it's contents.  The ICA may
  146.                contain garbage when the machine is first booted, so a
  147.                small program (clearica.com) is provided to fill the
  148.                ICA with zeroes.  The ICA is not documented in the PS/2
  149.                BIOS and this function may not work.  Using F10 should
  150.                not cause problems with the PS/2, but clearica may
  151.                cause problems.  The sub-windows use with the F4 (cross
  152.                reference) command may be moved but not locked.
  153.  
  154.      OPTIONS (apply to interactive mode only)
  155.  
  156.           -c
  157.                screen clear between each display.  Use this if you
  158.                specify a pager which does not clear the screen before
  159.                starting.
  160.  
  161.           -K key key ...
  162.                apropos keyword (see below) with interactive browsing.
  163.                The list displayed for selection contains only those
  164.                items which contain one of the keywords in the
  165.                synopsis.
  166.  
  167.           -p
  168.                pauses after each display. Use this if you specify a
  169.                pager that does not pause at the end of the file (e.g.
  170.                DOS MORE)
  171.  
  172.           -q
  173.                quiet mode - flash instead of beeping
  174.  
  175.           -b
  176.                bios used for screen output instead of directvideo (use
  177.                if compatiblity problems arise with default action)
  178.  
  179.      COMMAND LINE HELP
  180.           If the format help command is used, then the helpfile is
  181.           searched for "command", and if found, it is printed to
  182.           standard output. Multiple commands may be listed and they
  183.           will be searched for in order.
  184.  
  185.           If the format help -k keyword is used, the 1-line synopses
  186.           for each help entry are searched for "keyword" and all those
  187.           that match are copied to standard output.
  188.  
  189.           The command line help uses pure DOS i/o and should work on
  190.           any generic MS-DOS machine, including non-IBM compatibles.
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 9/23/90)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      HELP(1)                  MS-DOS utilities                  HELP(1)
  203.  
  204.  
  205.      OPTIONS (apply to non-interactive mode)
  206.  
  207.           -i
  208.                Print index of entries in help file.  If followed by a
  209.                number <n>, print <n> keywords per line (default 5).
  210.  
  211.           -1
  212.                Print single file index of entries in help file, with
  213.                no header
  214.  
  215.           -k key key ...
  216.                Print synopsis of all entries related to <keyword>. All
  217.                command line arguments after -k are taken to be
  218.                keywords for synopsis search rather than entries to
  219.                display full text for.  The synopsis search is
  220.                simpleminded, no regular expressions or boolean
  221.                combinations of keywords.
  222.  
  223.           -f
  224.                Force rebuild of index files
  225.  
  226.           -h
  227.                Print 1 page summary of program
  228.  
  229.           -a
  230.                Ansi_mode.  Do NOT enter interactive mode if no
  231.                commands are listed (for use on machines for which this
  232.                causes trouble).  If no commands are listed, then
  233.                "HELP" is looked up instead.
  234.  
  235.      DESCRIPTION of HELPFILES
  236.           The helpfile consists of one or more ascii files, with the
  237.           index words (and aliases) marked as explaied below.  The
  238.           files are treated effectively as though concatenated.  An
  239.           index is built and stored in a separate file whenever help
  240.           detects that the index is out of date with respect to the
  241.           helpfile.  The helpfile may be edited with any text editor.
  242.           The file supplied has brief descriptions of most of the
  243.           MSDOS 4.01 and earlier commands.  A 1-line description of
  244.           every help entry is also stored in the index file. This may
  245.           be searched for keywords by using the "apropos" command:
  246.           help -k keyword
  247.  
  248.           The commands and keywords are not case sensitive.  All
  249.           output is to standard output which may be redirected to a
  250.           file or printer.  Some of the longer entries exceed one
  251.           screen and may be piped through "more" or any other pager.
  252.  
  253.           The default directory for the help file is "/lib".  This may
  254.           be overridden by setting the environment variable HELPDIR
  255.  
  256.           The default name for the help file is "helpfile".  This may
  257.           be overridden by setting the environment variable HELPFILE.
  258.           HELPFILE may contain a list of file names separated by ";"
  259.  
  260.  
  261.      Page 4                                           (printed 9/23/90)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      HELP(1)                  MS-DOS utilities                  HELP(1)
  269.  
  270.  
  271.           and HELP will cycle through each in turn. This allows help
  272.           files for different types of programs to be maintained in
  273.           logical groupings, but searched as if they were a single
  274.           file.  They must all reside in the same directory.  If any
  275.           files are not present, a diagnostic will be displayed but
  276.           the others will be processed.
  277.  
  278.           The index file for each help file is created by appending
  279.           .idx to the data file name.  The data file should therefore
  280.           have no extension.
  281.  
  282.           The format for the help files is:
  283.           keyword [,alias ,alias ...] [#xref #xref ...]
  284.           keyword - 1 line description to be used by the -k option
  285.           ...
  286.           any number of lines of text, up to EOF or next # at start of
  287.           line ...
  288.  
  289.  
  290.           keyword
  291.                - primary index for this help entry
  292.  
  293.           alias
  294.                - alternate index terms for this help entry
  295.  
  296.           #xref
  297.                - keywords prepended by "#" are cross-references used
  298.                by the F4 command in interactive mode. All items on the
  299.                index line are space or comma delimited, and the line
  300.                may be up to 134 characters.
  301.  
  302.           In all of the descriptions of command usage:
  303.  
  304.           [brackets]
  305.                indicates optional items.
  306.  
  307.                indicates that the previous parameter may be repeated.
  308.  
  309.           d:
  310.                represents a valid drive letter (with colon)
  311.  
  312.           path
  313.                represents a directory path
  314.  
  315.           filename
  316.                is a DOS filename (with extension)
  317.  
  318.           filespec
  319.                is a DOS filename optionally with "*" and "?" wildcards
  320.  
  321.           nnn
  322.                is generally a numeric parameter to be supplied
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                           (printed 9/23/90)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      HELP(1)                  MS-DOS utilities                  HELP(1)
  335.  
  336.  
  337.           The help files use the format in the MKS toolkit help, of
  338.           which this was originally a clone.  See the documentation
  339.           file for more information
  340.  
  341.      FILES
  342.           /lib/helpfile default datafile containing help info
  343.           /lib/helpfile.idx default index file
  344.           HELPDIR Environment variable - directory for helpfile
  345.           HELPFILE Environment variable - alternate name(s) for
  346.           helpfile
  347.           PAGER Program to use for displaying help entries
  348.           HELP If set, is parsed as a command line argument before the
  349.           other arguments.
  350.           COLOR Environment variable - if set, is parsed as for the
  351.           4DOS COLOR command and used to set the screen colours for
  352.           the interactive selection windows.  The syntax is "fg ON bg"
  353.           where fg and bg are foreground and background colours taken
  354.           from the from the list "BLACK BLUE GREEN CYAN RED MAGENTA
  355.           YELLOW GRAY"
  356.  
  357.      BUGS
  358.           It would be useful if the last help entry viewed were to
  359.           remain on the screen at exit.  Since the help program has no
  360.           control over which pager is used, this is not always
  361.           possible.  It is also not possible to preserve the screen
  362.           when recursive calls are made to the cross-reference
  363.           feature.  In general, for any given pager, the best
  364.           combination of -c and -p options will need to be determined
  365.           empirically.
  366.  
  367.      AUTHORS
  368.           Original Author:  uwmacc!harvard!killer!wnp (Wolf Paul)
  369.           Environment variable handling by:  plocher@uwspan.uucp (John
  370.           Plocher)
  371.           Addition of all -options, interactive mode, multiple
  372.           helpfiles and pretty much rewrote everything.
  373.           richard@calvin.spp.cornell.edu
  374.  
  375.           (Richard Brittain) School of Electrical Engineering, Upson
  376.           Hall Cornell University, Ithaca NY 14853
  377.  
  378.           Code for the popen/pclose routines was taken from a BBS and
  379.           it bears no author name.
  380.  
  381.           Permission is granted to copy and use the compiled program
  382.           and documentation for any non-commercial use, provided all
  383.           copyright information is retained.
  384.                        Copyright 1990 by Richard Brittain
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.