octave_packages/m/path/matlabroot.m

   1 ## Copyright (C) 2008-2012 Ben Abbott
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} matlabroot ()
  21 ## Return the name of the top-level Octave installation directory.
  22 ##
  23 ## This is an alias for the function @w{@code{OCTAVE_HOME}} provided
  24 ## for compatibility.
  25 ## @seealso{OCTAVE_HOME}
  26 ## @end deftypefn
  27
  28 function val = matlabroot ()
  29
  30   val = OCTAVE_HOME;
  31
  32 endfunction
  33
  34 %!assert (matlabroot(), OCTAVE_HOME())
  35