octave_packages/m/time/date.m

   1 ## Copyright (C) 1995-2012 John W. Eaton
   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} {} date ()
  21 ## Return the current date as a character string in the form DD-MMM-YYYY@.
  22 ##
  23 ## For example:
  24 ##
  25 ## @example
  26 ## @group
  27 ## date ()
  28 ##   @result{} "20-Aug-1993"
  29 ## @end group
  30 ## @end example
  31 ## @seealso{now, clock, datestr, localtime}
  32 ## @end deftypefn
  33
  34 ## Author: jwe
  35
  36 function retval = date ()
  37
  38   retval = strftime ("%d-%b-%Y", localtime (time ()));
  39
  40 endfunction
  41
  42 %!assert(strcmp (date (), strftime ("%d-%b-%Y", localtime (time ()))));
  43