summary refs log tree commit diff
path: root/Doc/Zsh/mod_datetime.yo
blob: 619067698b275811ed46d39db91f0066f7d763cb (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
COMMENT(!MOD!zsh/datetime
Some date/time commands and parameters.
!MOD!)
The tt(zsh/datetime) module makes available one builtin command:

startitem()
findex(strftime)
cindex(date string, printing)
xitem(tt(strftime) [ tt(-s) var(scalar) ] var(format) var(epochtime) )
item(tt(strftime) tt(-r) [ tt(-q) ] [ tt(-s) var(scalar) ] var(format) var(timestring) )(
Output the date denoted by var(epochtime) in the var(format)
specified.

With the option tt(-r) (reverse), use the format var(format) to parse the
input string var(timestring) and output the number of seconds since the
epoch at which the time occurred.  If no timezone is parsed, the current
timezone is used; other parameters are set to zero if not present.  If
var(timestring) does not match var(format) the command returns status 1; it
will additionally print an error message unless the option tt(-q) (quiet)
is given.  If var(timestring) matches var(format) but not all characters in
var(timestring) were used, the conversion succeeds; however, a warning is
issued unless the option tt(-q) is given.  The matching is implemented by
the system function tt(strptime); see manref(strptime)(3).  This means that
zsh format extensions are not available, however for reverse lookup they
are not required.  If the function is not implemented, the command returns
status 2 and (unless tt(-q) is given) prints a message.

If tt(-s) var(scalar) is given, assign the date string (or epoch time
in seconds if tt(-r) is given) to var(scalar) instead of printing it.
)
enditem()

The tt(zsh/datetime) module makes available several parameters;
all are readonly:

startitem()
vindex(EPOCHREALTIME)
item(tt(EPOCHREALTIME))(
A floating point value representing the number of seconds since
the epoch.  The notional accuracy is to nanoseconds if the
tt(clock_gettime) call is available and to microseconds otherwise,
but in practice the range of double precision floating point and
shell scheduling latencies may be significant effects.
)
vindex(EPOCHSECONDS)
item(tt(EPOCHSECONDS))(
An integer value representing the number of seconds since the
epoch.
)
vindex(epochtime)
item(tt(epochtime))(
An array value containing the number of seconds since the epoch
in the first element and the remainder of the time since the epoch
in nanoseconds in the second element.  To ensure the two elements
are consistent the array should be copied or otherwise referenced
as a single substitution before the values are used.  The following
idiom may be used:

example(for secs nsecs in $epochtime; do
  ...
done)

)
enditem()