home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume8 / gnuplot1.10A / part07 / help / README < prev    next >
Text File  |  1989-09-09  |  4KB  |  92 lines
  1. Hello,
  2.  
  3. This is the first distribution of any sort out of me.  This program,
  4. I believe, will find genuine use on almost all machines, versions of
  5. UN*X, and environments.  This system implements a VMS-like help facility
  6. for any and all commands, procedures, etc.
  7.  
  8. I hereby release this code into the public domain.  Please don't remove
  9. the file headers that have my name in them, and don't make profit with
  10. this system.  Rather, customize it to your own local uses and
  11.  
  12.         TEACH PEOPLE UN*X WITH THIS SYSTEM!!!
  13.  
  14. This later goal is by FAR more important to me than some stupid copyright
  15. notice that could be deleted by anyone anyway.  Also, I will not be libel
  16. for any damages done to your system, period.  AS IS WHERE IS is the motto.
  17.  
  18. This system is NOT intended to replace "man(1)" but rather to supplement
  19. the information in the manual pages to first time users.  For instance,
  20. here at OSU, we use this system on the undergraduate machine to try and
  21. guide the freshman through the gore of printing, editors, etc. rather
  22. than having a professor do it.  Also, most of the more often used
  23. commands have their manual pages ripped up and stuffed into this format
  24. to aid the student (you must admit that "help" is a more natural thing
  25. to type when in need as a first time UN*X user than is "man").
  26.  
  27. Because we have 43 hosts here in the Computer and Information Sciences
  28. department, all running some flavor of UN*X, a LARGE amount of time
  29. was taken to make this as simple and portable as possible.  Therefore,
  30. "curses(3)" was not used (not all systems support it in the same way
  31. or even have it in a few cases).  Also things like ISAM were not used
  32. (portability problems).  This implies that this package does not have
  33. the 'spiffyness' that some of you may be looking for.
  34.  
  35. In short, this is not going to impress the boss, code-wise.  Rather, the
  36. content of the help directorys (the actual text of the various help
  37. messages) are what should be devoted a fair amount of time.  This is also
  38. where this system shines.  True flexibility is achieved by the "DIR" files
  39. within this system.  They allow you to setup acronyms for traversing the
  40. directory tree of "TEXT" files.  This allows you to have help topics like
  41. "printing a file" or "using the printer in the basement" both point to
  42. the help screen on using the "lp" command.  This file also allows SYS5
  43. sites to use any length 'help file' name and still map it into the small
  44. file name SYS5 allows you (14 characters?).
  45.  
  46. Hidden aliases can also be used.  This allows you to also have such things
  47. as "lp" be a 'help topic' as in the previous paragraph.  This makes the
  48. system less painful for those who really do know UN*X, but have forgotten
  49. one simple flag on "_XXXX_".
  50.  
  51. These are the instructions to compile "help(L)":
  52.  
  53. 1.    Edit the file "global.h" and change the #define's
  54.     for ROOTDIR, HELPFILE, and DIRFILE to be locally
  55.     acceptable.
  56.  
  57. 2.    Edit the file "Makefile" and fix the definitions of BIN, HELPDIR,
  58.     HELPOWN, and HELPGRP so that "make install" will work.
  59.  
  60. 3.    Type "make all".
  61.  
  62. 4.    IF the make completes, play around with it for a while
  63.     and make sure it works...
  64.  
  65. 5.    Type "make install".  This will install a copy of our help
  66.     files, complete with typo's & bad grammar.  Most of the
  67.     files were typed in by various volunteers here within
  68.     the university.  You may want to look at them as an
  69.     example, you may want to delete them, who knows...
  70.  
  71. I bet you think you are done...  HA!  HA!  HA!  That's a computer joke!
  72. You are just barely beginning.  Now comes the fun part. :-)
  73.  
  74. 6.    Type "cd <ROOTDIR>".
  75.  
  76. 7.    Start making your "./TEXT" and "./DIR" files.  The examples
  77.     in this shell archive should prove adequate for examples.
  78.     For a subtopic, type "mkdir <subtopic>" and then
  79.     "cd <subtopic>" and goto step 7.
  80.  
  81. If you have any questions or further enhancements (or help subtrees :-),
  82. please e-mail them to me.  I really would like to hear how this thing
  83. fairs in the big wide world...
  84.  
  85. Roland Stolfa
  86. Computing and Information Sciences Department
  87. Oklahoma State University
  88. 219 Math Sciences Building
  89. Stillwater OK 74078
  90.  
  91. rjs@a.cs.okstate.edu
  92.