summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorgahr <gahr@gahr.ch>2016-02-17 11:03:48 (GMT)
committergahr <gahr@gahr.ch>2016-02-17 11:03:48 (GMT)
commit03dd6c13603af9d6792030412f52d942fc2eaefd (patch)
tree36dc308e5e2879fff93be3333f2225732a0387fd /doc
parentf7ea5b6cc57fafcbcb3377e83fdbc4d999d123d4 (diff)
downloadtcl-03dd6c13603af9d6792030412f52d942fc2eaefd.zip
tcl-03dd6c13603af9d6792030412f52d942fc2eaefd.tar.gz
tcl-03dd6c13603af9d6792030412f52d942fc2eaefd.tar.bz2
[5f71353740] Support the "weekdays" unit in [clock add]
Diffstat (limited to 'doc')
-rw-r--r--doc/clock.n13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/clock.n b/doc/clock.n
index 889a5da..53db33e 100644
--- a/doc/clock.n
+++ b/doc/clock.n
@@ -89,10 +89,9 @@ have 59 or 61 seconds.
.TP
\fIunit\fR
One of the words, \fBseconds\fR, \fBminutes\fR, \fBhours\fR,
-\fBdays\fR, \fBweeks\fR, \fBmonths\fR, or \fByears\fR, or
-any unique prefix of such a word. Used in conjunction with \fIcount\fR
-to identify an interval of time, for example, \fI3 seconds\fR or
-\fI1 year\fR.
+\fBdays\fR, \fBweekdays\fR, \fBweeks\fR, \fBmonths\fR, or \fByears\fR.
+Used in conjunction with \fIcount\fR to identify an interval of time,
+for example, \fI3 seconds\fR or \fI1 year\fR.
.SS "OPTIONS"
.TP
\fB\-base\fR time
@@ -175,8 +174,7 @@ given as its first argument. The remaining arguments (other than the
possible \fB\-timezone\fR, \fB\-locale\fR and \fB\-gmt\fR options)
are integers and keywords in alternation, where the keywords are chosen
from \fBseconds\fR, \fBminutes\fR, \fBhours\fR,
-\fBdays\fR, \fBweeks\fR, \fBmonths\fR, or \fByears\fR, or
-any unique prefix of such a word.
+\fBdays\fR, \fBweekdays\fR, \fBweeks\fR, \fBmonths\fR, or \fByears\fR.
.PP
Addition of seconds, minutes and hours is fairly straightforward;
the given time increment (times sixty for minutes, or 3600 for hours)
@@ -213,7 +211,8 @@ the given time to a calendar day and time of day in the appropriate
time zone and locale. The requisite number of days (weeks are converted
to days by multiplying by seven) is added to the calendar day, and
the date and time are then converted back to a count of seconds from
-the epoch time.
+the epoch time. The \fBweekdays\fR keyword is similar to \fBdays\fR,
+with the only difference that weekends are skipped.
.PP
Adding and subtracting a given number of days across the point that
the time changes at the start or end of summer time (Daylight Saving Time)