git.maemo.org Git - gnuplot/blob - lisp/README

   1
   2 This directory contains files for running Gnuplot from within emacs.
   3 This package was assembled by Bruce Ravel <ravel@phys.washington.edu>.
   4 See http://feff.phys.washington.edu/~ravel/gnuplot/ for the latest.
   5
   6
   7                                Contents
   8                                ========
   9
  10 README               this file
  11 INSTALL              thorough installation instructions
  12 ChangeLog            a log of changes by version number
  13 gnuplot.el           gnuplot mode for emacs
  14 gnuplot-gui.el       a GUI for setting command arguments interactively
  15 info-look.20.2.el    programmer's interface to info files, old version
  16 info-look.20.3.el    programmer's interface to info files, new version
  17 dot.el               a short lisp file used by the Makefile
  18 gnuplot.info         info version of gnuplot 3.6 help
  19 gpelcard.tex         quick reference card for gnuplot mode (latex)
  20 gpelcard.ps
  21 dotemacs             example .emacs lines for enabling gnuplot mode
  22 Makefile.in     \
  23 Makefile.dst     \
  24 aclocal.m4        \     files inherited from the gnuplot distribution
  25 configure          }    for making gnuplot-mode
  26 configure.in      /
  27 install-sh       /
  28 mkinstalldirs   /
  29 Win9x/INSTALL.Win9x  Extra installation instructions for Windows 95/98
  30 Win9x/pgnuplot.c     Program required to run gnuplot from Emacs
  31
  32 Soon gnuplot-mode will be included with the gnuplot 3.7 distribution.
  33 The installation instructions for the free-standing distribution have
  34 been modified to be consistent with that.
  35
  36
  37                              Installation
  38                              ============
  39
  40 1.  Unpack the gnuplot.tar.gz and cd to the gnuplot directory.
  41
  42 2.  Type "configure".  If configure doesn't work for you, see note 7
  43     below.
  44
  45 3.  Run "make".  If you use XEmacs, run "make EMACS=xemacs" (or change
  46     the EMACS variable to "xemacs" in the Makefile, the run "make").
  47
  48 4.  Move the lisp files to the system site_lisp directory if you are
  49     installing as root.  If you are installing as a normal user move
  50     the .elc files to a place where emacs, i.e. your personal emacs
  51     directory.
  52
  53 5.  Insert the contents of the `dotemacs' file into your .emacs file
  54     or into the system's emacs start-up file to enable gnuplot mode.
  55
  56 6.  The function `gnuplot-info-lookup-symbol' looks at the Gnuplot
  57     info file that comes with this package or that can be made from
  58     the Gnuplot distribution.  For that function to work, the file
  59     gnuplot.info must be placed somewhere where info can find it, for
  60     example /usr/info.  A line like this in your .emacs allows you to
  61     put gnuplot.info any place convenient:
  62        (add-to-list 'Info-default-directory-list "/path/to/file")
  63
  64
  65 Wouldn't it be //great// if Emacs had some kind of systematized package
  66 installing facility?  I think so, too!  Oh well....
  67
  68
  69
  70                                 NOTES
  71                                 =====
  72
  73 1. gnuplot-mode is designed for use with version 3.7 of gnuplot.  It
  74    should work very well with any of the 3.6 beta versions.  Only some
  75    of the specialized features will not work with version 3.5 -- the
  76    GUI interface to setting command arguments is an example.
  77
  78 2. To use gnuplot-mode with Emacs on Windows 95 or 98 see the
  79    instructions in the directory Win9x.
  80
  81 3. The installation materials used by gnuplot-mode come from the
  82    gnuplot distribution.
  83
  84 4. If "configure" doesn't work for you, the file "Makefile.dst" can be
  85    used.  In that case do, "make -f Makefile.dst" and carry on from
  86    there.
  87
  88 5. If you do not have the custom library installed, you will get
  89    several harmless warnings when compiling gnuplot.el.  Most of
  90    gnuplot-mode will work even without the custom library installed.
  91
  92 6. The file info-look.el provides the on-line help functionality.
  93    Without it, things like on-line help and keyword completion will
  94    not work.  Using a tool that is a standard part of Emacs is a good
  95    idea, but this one gets complicated.  This file became part of
  96    Emacs with version 20.  It changed between 20.2 and 20.3.  And it
  97    does not come with XEmacs.  What's more, the version from 20.2 has
  98    a bug and the newer version does not work with Emacs 19.  So, this
  99    distribution comes with two versions of info-look.el, the version
 100    from Emacs 20.2 patched to work correctly and the version from
 101    Emacs 20.3.  Here's what happens when you run make:
 102
 103    a.  If you use Emacs 19 or XEmacs 19, then the Makefile will
 104        compile the 20.2 version.
 105    b.  If you use Emacs 20.2 or lower, the Makefile will compile the
 106        20.2 version.
 107    c.  If you use XEmacs 20 or higher, the Makefile will compile the
 108        20.3 version.
 109    d.  If you use Emacs 20.3 or higher, the Makefile won't compile any
 110        version.
 111
 112 7. The gnuplot-mode distribution comes with the version of the gnuplot
 113    info file that gets made by gnuplot 3.7.  Use it rather than the
 114    old one.  If you really must use the older info file, see the
 115    document string for the variable `gnuplot-info-hook'.  If you
 116    already have the info file installed on your computer, you will not
 117    need the one that comes with gnuplot-mode.
 118
 119 8. The interactive graphical graphical interface to setting command
 120    arguments contained in gnuplot-gui.el is experimental.  It is
 121    incomplete and may make mistakes.  Hopefully, you will find it
 122    useful.  It *requires* that you are using a version of emacs with
 123    the widget library installed or that you have installed it
 124    yourself.  Version numbers in the 20's of Emacs and XEmacs ship
 125    with the widget library.  For version numbers in the 19's, it can
 126    be obtained at http://www.dina.kvl.dk/~abraham/custom/
 127