about summary refs log tree commit diff
diff options
context:
space:
mode:
authorPeter Stephenson <pws@zsh.org>2013-05-21 17:11:04 +0100
committerPeter Stephenson <pws@zsh.org>2013-05-21 17:11:04 +0100
commit692a15363f1332ad62e3e915a7842fbc343d45b3 (patch)
tree125ffdba0f434c5aaeb8a400347615d736b7a05d
parent06e17f81123a5760d90711ec3b1f54a4c9c58237 (diff)
downloadzsh-692a15363f1332ad62e3e915a7842fbc343d45b3.tar.gz
zsh-692a15363f1332ad62e3e915a7842fbc343d45b3.tar.xz
zsh-692a15363f1332ad62e3e915a7842fbc343d45b3.zip
31418: improve documentation for "age" function
-rw-r--r--ChangeLog4
-rw-r--r--Doc/Zsh/calsys.yo12
-rw-r--r--Functions/Calendar/age2
3 files changed, 15 insertions, 3 deletions
diff --git a/ChangeLog b/ChangeLog
index 904063d14..de7e70309 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
 2013-05-21  Peter Stephenson  <p.stephenson@samsung.com>
 
+	* 31418: Doc/Zsh/calsys.yo, Functions/Calendar/age:
+	in "age" docs correct typo and note the feature that
+	you can supply a file as a timestamp on the command line.
+
 	* Stephane: 31417: Functions/Calendar/age: needs --
 	to protect againts files starting with -.
 
diff --git a/Doc/Zsh/calsys.yo b/Doc/Zsh/calsys.yo
index 259eb23b3..b3eb454a0 100644
--- a/Doc/Zsh/calsys.yo
+++ b/Doc/Zsh/calsys.yo
@@ -651,16 +651,24 @@ date specification must be quoted to ensure tt(age) receives the correct
 arguments, hence the use of the additional colon to separate the date and
 time.
 
-example(AGEREF1=2006/10/04:10:15
+example(AGEREF=2006/10/04:10:15
 AGEREF2=2006/10/04:10:45
 print *+LPAR()PLUS()age+RPAR())
 
 This shows the same example before using another form of argument
-passing.  The dates and times in the parameters tt(AGEREF1) and tt(AGEREF2)
+passing.  The dates and times in the parameters tt(AGEREF) and tt(AGEREF2)
 stay in effect until unset, but will be overridden if any argument is
 passed as an explicit argument to age.  Any explicit argument
 causes both parameters to be ignored.
 
+Instead of an explicit date and time, it's possible to use the
+modification time of a file as the date and time for either argument
+by introducing the file name with a colon:
+
+example(print *+LPAR()e-age :file1 :file2-+RPAR())
+
+This matches all files modified no earlier than tt(file1) and
+no later than tt(file2).
 
 texinode(Calendar Styles)(Calendar Utility Functions)(Calendar System User Functions)(Calendar Function System)
 sect(Styles)
diff --git a/Functions/Calendar/age b/Functions/Calendar/age
index 2348da51a..c636bdfe8 100644
--- a/Functions/Calendar/age
+++ b/Functions/Calendar/age
@@ -18,7 +18,7 @@
 # are allowed, but whitespace must be quoted to ensure age receives
 # the correct arguments.
 #
-#   AGEREF1=2006/10/04:10:15
+#   AGEREF=2006/10/04:10:15
 #   AGEREF2=2006/10/04:10:45
 #   print *(+age)
 #