From 8cbd5100022d651054b9edbbb79b38c8a442ec51 Mon Sep 17 00:00:00 2001
From: Peter Stephenson <pws@users.sourceforge.net>
Date: Thu, 11 Aug 2011 18:45:04 +0000
Subject: 29674: add $epochtime to datetime

---
 Doc/Zsh/mod_datetime.yo | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'Doc/Zsh/mod_datetime.yo')

diff --git a/Doc/Zsh/mod_datetime.yo b/Doc/Zsh/mod_datetime.yo
index 514c43037..619067698 100644
--- a/Doc/Zsh/mod_datetime.yo
+++ b/Doc/Zsh/mod_datetime.yo
@@ -30,7 +30,8 @@ in seconds if tt(-r) is given) to var(scalar) instead of printing it.
 )
 enditem()
 
-The tt(zsh/datetime) module makes available several parameters:
+The tt(zsh/datetime) module makes available several parameters;
+all are readonly:
 
 startitem()
 vindex(EPOCHREALTIME)
@@ -45,5 +46,19 @@ 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()
-- 
cgit 1.4.1