(Timers): Fix description of run-at-time TIME formats.

This commit is contained in:
Glenn Morris 2007-03-31 23:29:38 +00:00
parent 192453e4c6
commit e42b9a3362

View file

@ -1421,20 +1421,12 @@ the timer runs only once.
@var{time} may specify an absolute or a relative time.
Absolute times may be specified in a wide variety of formats; this
function tries to accept all the commonly used date formats. The most
convenient formats are strings. Valid such formats include these two,
@example
@var{year}-@var{month}-@var{day} @var{hour}:@var{min}:@var{sec} @var{timezone}
@var{hour}:@var{min}:@var{sec} @var{timezone} @var{month}/@var{day}/@var{year}
@end example
@noindent
where in both examples all fields are numbers; the format that
@code{current-time-string} returns is also allowed, and many others
as well.
Absolute times may be specified using a string with a limited variety of
formats, and are taken to be times @emph{today}, even if already in the
past. The recognized forms are XXXX, X:XX, or XX:XX (military time),
and XXam, XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM. A
period can be used instead of a colon to separate the hour and minute
parts.
To specify a relative time as a string, use numbers followed by units.
For example:
@ -1452,8 +1444,9 @@ For relative time values, Emacs considers a month to be exactly thirty
days, and a year to be exactly 365.25 days.
Not all convenient formats are strings. If @var{time} is a number
(integer or floating point), that specifies a relative time measured
in seconds.
(integer or floating point), that specifies a relative time measured in
seconds. The result of @code{encode-time} can also be used to specify
an absolute value for @var{time}.
In most cases, @var{repeat} has no effect on when @emph{first} call
takes place---@var{time} alone specifies that. There is one exception: