summary refs log tree commit diff
path: root/Doc/Zsh
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2006-08-17 15:28:11 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2006-08-17 15:28:11 +0000
commitd0b9eddd9a320bed6d87c07d26048bbf6816115c (patch)
tree10759c39d2a13bd1d4749e6fd5da87c3eb94c643 /Doc/Zsh
parent1a42aadd81240fdb7f0acc38ddeef38898b705ab (diff)
downloadzsh-d0b9eddd9a320bed6d87c07d26048bbf6816115c.tar.gz
zsh-d0b9eddd9a320bed6d87c07d26048bbf6816115c.tar.xz
zsh-d0b9eddd9a320bed6d87c07d26048bbf6816115c.zip
22613: add strftime -r to use strptime() if available
Diffstat (limited to 'Doc/Zsh')
-rw-r--r--Doc/Zsh/mod_datetime.yo21
1 files changed, 18 insertions, 3 deletions
diff --git a/Doc/Zsh/mod_datetime.yo b/Doc/Zsh/mod_datetime.yo
index b006baf89..145d4a181 100644
--- a/Doc/Zsh/mod_datetime.yo
+++ b/Doc/Zsh/mod_datetime.yo
@@ -6,12 +6,27 @@ The tt(zsh/datetime) module makes available one builtin command:
 startitem()
 findex(strftime)
 cindex(date string, printing)
-item(tt(strftime) [ tt(-s) var(scalar) ] var(format) var(epochtime) )(
+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.
 
-If tt(-s) var(scalar) is given, assign the date to var(scalar) instead
-of printing it.
+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()