home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume8 / gnuplot1.10A / part06 / docs / README < prev   
Encoding:
Text File  |  1989-09-09  |  1.8 KB  |  36 lines

  1. ---------Documentation README file------------
  2. For those of you not making documentation changes or installing
  3. the help system just print out gnuplot.doc and ignore the remaining 
  4. information.
  5.  
  6. The documentation for gnuplot is intended to be maintained either
  7. by directly updating help files in the help tree or by updating a
  8. master .hlp file.  (The intent is to leave it up to the individual
  9. to choose how to maintain the documentation.)  The master .hlp file
  10. (gnuplot.hlp) is a representation of the directory help tree.  The
  11. program helptree.c will either convert a help tree into a flat file
  12. or take such a flat file and put it back into a help tree.  The help
  13. tree format is used on unix and MSDOS machines in conjunction with
  14. the standalone ``help'' program to provide the gnuplot help facility.
  15. The flat file gnuplot.hlp is used on VMS machines to provide the
  16. gnuplot help facility (using VMS help routines).
  17.  
  18. Unix and MSDOS machines still need the gnuplot.hlp file, even though 
  19. it is not used directly in the help system.  For one thing, flat 
  20. files are easier to move to another machine.  For another, the file 
  21. gnuplot.doc (a printable manual) can be built out of gnuplot.hlp as 
  22. follows:
  23.  
  24. hlp2ms <gnuplot.hlp >gnuplot.ms 
  25. nroff -ms gnuplot.ms |col -h >gnuplot.doc
  26.  
  27. To build a help system on unix for gnuplot first build Roland Stolfa's
  28. help program and install it in /usr/local/bin.  Gnuplot looks for either
  29. /usr/local/bin/help or the environment symbol GNUHELP--if it is not
  30. possible to install help in /usr/local/bin.  Stolfa's help system assumes
  31. a help tree under /usr/local/help or a directory pointed to by the 
  32. environment symbol HELPDIR.  The gnuplot help tree can be created out of 
  33. gnuplot.hlp using the following command:
  34.  
  35. helptree -t /usr/local/help/gnuplot <gnuplot.hlp
  36.