bundles/org.simantics.gnuplot/src/org/simantics/gnuplot/package-info.java

   1 /**
   2  * Contains simple <code>gnuplot</code> installation detection and
   3  * <code>gnuplot</code> execution facilities.
   4  *
   5  * <p>
   6  * The installation detection logic relies purely on two environment variables.
   7  * Primarily the <code>GNUPLOT</code> variable and secondarily on
   8  * <code>PATH</code>. <code>GNUPLOT</code> can be set to point to one of the
   9  * following:
  10  * <ul>
  11  * <li>the full path to the gnuplot executable directly (including file name
  12  * suffix</li>
  13  * <li>the <code>bin</code> directory of a gnuplot installation</li>
  14  * <li>the root directory of a gnuplot installation</li>
  15  * </ul>
  16  * Secondarily the detection will check whether the <code>PATH</code> variable
  17  * contains any files system path that corresponds to a gnuplot installation
  18  * <code>bin</code> directory, i.e. the directory contains a
  19  * <code>gnuplot</code> excutable.
  20  *
  21  * <p>
  22  * In both cases the detection will also ensure that the discovered gnuplot
  23  * executable responds to the <code>-V</code> (version) argument as expected,
  24  * i.e. returns a line starting with "gnuplot ".
  25  *
  26  * @author Tuukka Lehtonen
  27  * @since 1.24
  28  */
  29 package org.simantics.gnuplot;