annotate scripts/time/ctime.m @ 5307:4c8a2e4e0717

[project @ 2005-04-26 19:24:27 by jwe]
author jwe
date Tue, 26 Apr 2005 19:24:47 +0000
parents 54babc5054eb
children 34f96dd5441b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2314
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4003
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 4003
diff changeset
18 ## 02110-1301, USA.
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
19
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
20 ## -*- texinfo -*-
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
21 ## @deftypefn {Function File} {} ctime (@var{t})
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
22 ## Convert a value returned from @code{time} (or any other nonnegative
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
23 ## integer), to the local time and return a string of the same form as
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
24 ## @code{asctime}. The function @code{ctime (time)} is equivalent to
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
25 ## @code{asctime (localtime (time))}. For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3295
diff changeset
26 ##
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
27 ## @example
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
28 ## @group
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
29 ## ctime (time ())
4003
54babc5054eb [project @ 2002-07-25 01:19:17 by jwe]
jwe
parents: 3426
diff changeset
30 ## @result{} "Mon Feb 17 01:15:06 1997\n"
3295
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
31 ## @end group
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
32 ## @end example
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe]
jwe
parents: 2847
diff changeset
33 ## @end deftypefn
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
34
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
35 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
36
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
37 function retval = ctime (t)
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
38
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
39 if (nargin == 1)
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
40 retval = asctime (localtime (t));
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
41 else
1382
000325177d87 [project @ 1995-09-12 07:20:43 by jwe]
jwe
parents: 1315
diff changeset
42 usage ("ctime (TIME)");
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
43 endif
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
44
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
45 endfunction