diff scripts/startup/__finish__.m @ 7388:0e1ccfe1bf91

[project @ 2008-01-16 06:31:23 by jwe]
author jwe
date Wed, 16 Jan 2008 06:31:23 +0000
parents
children 17f2cdb5232e
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/scripts/startup/__finish__.m
@@ -0,0 +1,39 @@
+## Copyright (C) 2008 Ben Abbott
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {} __finish__ ()
+## Checks for the existence of the function/script, @file{finish}, in the 
+## path or current working directory and executes it. This function is
+## intended to be excecuted upon a clean exit form Octave.
+##
+## This functin is intended to be called upon a clean exit from Octave.
+## This is accomplished in the system script @file{startup/octaverc} by 
+## use of the built in function @code{onexit}.
+## @seealso{octaverc, onexit}
+## @end deftypefn
+
+function __finish__ ()
+
+  if exist ('finish','file')
+    ## No arg list here since finish might be a script.
+    finish;
+  endif
+
+endfunction
+