home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume2 / help / README < prev   
Text File  |  1991-08-07  |  2KB  |  55 lines
  1. Subject: 286 Source: A Help Command for systems with limited disk space
  2. Message-Id: <8712221357.AA29111@killer.UUCP>
  3. Date: 22 Dec 87 13:57:22 CST (Tue)
  4.  
  5. RCSINFO: $Header: README,v 1.0 87/12/18 18:22:29 wnp Posted $
  6.  
  7. The enclosed is a "help" command, patterned after the help command
  8. distributed with MKS Toolkit -- in fact, if you have the Toolkit,
  9. you could use their helpfile as a starting point for a UNIX SysV
  10. helpfile.
  11.  
  12. If you don't have the Toolkit, you can construct a helpfile by
  13. gleaning short command descriptions from your manual, and adding
  14. them to "/usr/lib/helpfile", according the the pattern of the partial
  15. helpfile shown below.
  16.  
  17. I find this help command more useful than the help system distributed with
  18. System V, especially on machines with limited disk space, where it is not
  19. practical to keep the manuals on-line.
  20.  
  21. The program uses an indexfile, /usr/lib/helpindex, to speed up access;
  22. if the indexfile does not exist, or is older than /usr/lib/helpfile (indicating
  23. that the helpfile has been updated), the program will build a new indexfile.
  24.  
  25. Compile normally, (small model on Uport V/286), then invoke as "help". The
  26. program should be owned by root and suid, so it can write in /usr/lib (to
  27. recreate the index file as needed.).
  28.  
  29. The helpfile below consists of those help entries which I have added to
  30. the MKS Toolkit file to use with my UNIX system. I do not feel free to
  31. post the MKS helpfile, since it is no doubt (c) by MKS.
  32.  
  33. Put the helpfile into /usr/lib/helpfile, or change the references thereto in
  34. help.c.
  35.  
  36. I hope this is helpful. Civil and constructive comments are invited to
  37. ihnp4!killer!dcs!wnp, flames should be directed to /dev/null.
  38.  
  39. Wolf N. Paul
  40. ihnp4!killer!dcs!wnp
  41.  
  42.  
  43. P.S. Since first posting this to comp.unix.microport, another application
  44. has been suggested for this command - an online, free-form notebook.
  45.  
  46. Actually, any kind of information can be kept in a "helpfile" for this
  47. command, as long as each item of info starts with a line containing
  48. '#' and a number of keywords separated by commas (currently each keyword
  49. must be less than 14 characters long and cannot contain white space).
  50. John Plocher's addition of looking at $HELPDIR and $HELPFILE permits one
  51. to put info into a file $HOME/.notebook, and to access it using the enclosed
  52. "info" shellscript.
  53.  
  54. Again, i hope this i helpful.
  55.