home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / DOS_HELP / HELP30.ZIP / READ.ME < prev   
Encoding:
Text File  |  1990-10-24  |  2.9 KB  |  65 lines
  1. Help: Version 3.0 2/11/90
  2.  
  3. This is an online help program combining features of a command line
  4. interface, using only standard output, and an interactive browsing
  5. facility using full screen item selection.  An "apropos" facility
  6. providing matches to 1-line item summaries, and cross referencing of
  7. items are provided.  The initial version of this program (without the
  8. interactive browsing) was posted to usenet in March 1989.  A help file
  9. covering standard MSDOS commands up through 4.01 is included.  The
  10. help text may easily be modified, or complete new files created for
  11. application-specific help.
  12.  
  13. I have substantially rewritten this program, adding a full screen
  14. interactive help "browsing" facility, using just this program, or any
  15. favourite pager which accepts standard input. If no arguments are
  16. specified to HELP, the program opens a window with a sorted list of
  17. commands. For each command selected on the list, the text is retrieved
  18. and displayed (via PAGER if this is defined in the environment,
  19. otherwise to standard output, after saving and clearing the screen).
  20. The temporary file needed for the PAGER option can be placed in a RAM
  21. disk by setting TMP or TMPDIR.  The 1-line synopsis of each entry can
  22. be viewed when in the interactive mode by pressing F2.
  23.  
  24. Help items can be cross-referenced, and the cross references for any
  25. selected item in interactive mode may be viewed (recursively).
  26. The index and apropos functions work are now sorted.  As before, other
  27. than in interactive mode, all output is to standard output.
  28.  
  29. The supplied helpfile has not changed in content, but cross reference
  30. information has been added.
  31.  
  32. To make the program more versatile, the length of the index keyword
  33. has been increased to 25, and the the synopsis field had been reduced
  34. from 85 to 80 characters - this breaks old index files which MUST be
  35. regenerated with this version.
  36.  
  37. Blurb from previous release:
  38.  
  39. The program HELP was written by Wolf Paul to serve as a concise online
  40. help system for small unix machines where the full on-line manual
  41. system would be too much of a drain on disc space.  It was designed to
  42. be a functional clone of the help program supplied with the MKS
  43. TOOLKIT package.  I have modified his source and added a few new
  44. features:
  45.  
  46.  - ability to print out the index of entries
  47.  - an "apropos" capability - display 1 line descriptions of all commands
  48.    appropriate to the keyword you specify
  49.  - ability to maintain the help text in several separate files, but use them
  50.    as a single file when retrieving help text (e.g. helpfile for MSDOS,
  51.    helpfile for 4DOS, helpfile for locally added utilities)
  52.  
  53. Richard Brittain    4/20/89
  54. richard@calvin.spp.cornell.edu  (internet)
  55.  
  56. These .ZOO files contains the following files:
  57.  
  58. HELPDOS.ZOO  helpfile: file containing help for MS-DOS commands up to 4.01
  59. HELPBIN.ZOO  binary and documentation only
  60.  
  61.  
  62.  
  63.  
  64.  
  65.