path: root/Doc/Zsh/calsys.yo

texinode(Calendar Function System)(TCP Function System)(Zsh Modules)(Top)
chapter(Calendar Function System)
cindex(calendar function system)
cindex(zsh/datetime, function system based on)
sect(Description)

The shell is supplied with a series of functions to replace and enhance the
traditional Unix tt(calendar) programme, which warns the user of imminent
or future events, details of which are stored in a text file (typically
tt(calendar) in the user's home directory).  The version provided here
includes a mechanism for alerting the user when an event is due.

In addition a function tt(age) is provided that can be used in a glob
qualifier; it allows files to be selected based on their modification
times.

The format of the tt(calendar) file and the dates used there in and in
the tt(age) function are described first, then the functions that can
be called to examine and modify the tt(calendar) file.

The functions here depend on the availability of the tt(zsh/datetime)
module which is usually installed with the shell.  The library function
tt(strptime+LPAR()RPAR()) must be available; it is present on most recent
operating systems.

startmenu()
menu(Calendar File and Date Formats)
menu(Calendar System User Functions)
menu(Calendar Styles)
menu(Calendar Utility Functions)
menu(Calendar Bugs)
endmenu()


texinode(Calendar File and Date Formats)(Calendar System User Functions)()(Calendar Function System)
sect(File and Date Formats)

subsect(Calendar File Format)

The calendar file is by default tt(~/calendar).  This can be configured
by the tt(calendar-file) style, see
ifzman(the section STYLES below)\
ifnzman(noderef(Calendar Styles)).  The basic format consists
of a series of separate lines, with no indentation, each including
a date and time specification followed by a description of the event.

Various enhancements to this format are supported, based on the syntax
of Emacs calendar mode.  An indented line indicates a continuation line
that continues the description of the event from the preceding line
(note the date may not be continued in this way).  An initial ampersand
(tt(&)) is ignored for compatibility.

An indented line on which the first non-whitespace character is tt(#)
is not displayed with the calendar entry, but is still scanned for
information.  This can be used to hide information useful to the
calendar system but not to the user, such as the unique identifier
used by tt(calendar_add).

The Emacs extension that a date with no description may refer to a number
of succeeding events at different times is not supported.

Unless the tt(done-file) style has been altered, any events which
have been processed are appended to the file with the same name as the
calendar file with the suffix tt(.done), hence tt(~/calendar.done) by
default.

An example is shown below.

subsect(Date Format)

The format of the date and time is designed to allow flexibility without
admitting ambiguity.  (The words `date' and `time' are both used in the
documentation below; except where specifically noted this implies a string
that may include both a date and a time specification.)  Note that there is
no localization support; month and day names must be in English and
separator characters are fixed.  Matching is case insensitive, and only the
first three letters of the names are significant, although as a special
case a form beginning "month" does not match "Monday".  Furthermore, time
zones are not handled; all times are assumed to be local.

It is recommended that, rather than exploring the intricacies of the
system, users find a date format that is natural to them and stick to it.
This will avoid unexpected effects.  Various key facts should be noted.

startitemize()
itemiz(In particular, note the confusion between
var(month)tt(/)var(day)tt(/)var(year) and
var(day)tt(/)var(month)tt(/)var(year) when the month is numeric; these
formats should be avoided if at all possible.  Many alternatives are
available.)
itemiz(The year must be given in full to avoid confusion, and only years
from 1900 to 2099 inclusive are matched.)
enditemize()

The following give some obvious examples; users finding here
a format they like and not subject to vagaries of style may skip
the full description.  As dates and times are matched separately
(even though the time may be embedded in the date), any date format
may be mixed with any format for the time of day provide the
separators are clear (whitespace, colons, commas).

example(2007/04/03 13:13
2007/04/03:13:13
2007/04/03 1:13 pm
3rd April 2007, 13:13
April 3rd 2007 1:13 p.m.
Apr 3, 2007 13:13
Tue Apr 03 13:13:00 2007
13:13 2007/apr/3)

More detailed rules follow.

Times are parsed and extracted before dates.  They must use colons
to separate hours and minutes, though a dot is allowed before seconds
if they are present.  This limits time formats to the following:

startitemize()
itemiz(var(HH)tt(:)var(MM)[tt(:)var(SS)[tt(.)var(FFFFF)]] [tt(am)|tt(pm)|tt(a.m.)|tt(p.m.)])
itemiz(var(HH)tt(:)var(MM)tt(.)var(SS)[tt(.)var(FFFFF)] [tt(am)|tt(pm)|tt(a.m.)|tt(p.m.)])
enditemize()

Here, square brackets indicate optional elements, possibly with
alternatives.  Fractions of a second are recognised but ignored.  For
absolute times (the normal format require by the tt(calendar) file and the
tt(age) function) a date is mandatory but a time of day is not; the time
returned is at the start of the date.  One variation is allowed: if
tt(a.m.) or tt(p.m.) or one of their variants is present, an hour without a
minute is allowed, e.g. tt(3 p.m.).

Time zones are not handled, though if one is matched following a time
specification it will be removed to allow a surrounding date to be
parsed.  This only happens if the format of the timezone is not too
unusual.  The following are examples of forms that are understood:

example(+0100
GMT
GMT-7
CET+1CDT)

Any part of the timezone that is not numeric must have exactly three
capital letters in the name.

Dates suffer from the ambiguity between var(DD)tt(/)var(MM)tt(/)var(YYYY)
and var(MM)tt(/)var(DD)tt(/)var(YYYY).  It is recommended this form is
avoided with purely numeric dates, but use of ordinals,
eg. tt(3rd/04/2007), will resolve the ambiguity as the ordinal is always
parsed as the day of the month.  Years must be four digits (and the first
two must be tt(19) or tt(20)); tt(03/04/08) is not recognised.  Other
numbers may have leading zeroes, but they are not required.  The following
are handled:

startitemize()
itemiz(var(YYYY)tt(/)var(MM)tt(/)var(DD))
itemiz(var(YYYY)tt(-)var(MM)tt(-)var(DD))
itemiz(var(YYYY)tt(/)var(MNM)tt(/)var(DD))
itemiz(var(YYYY)tt(-)var(MNM)tt(-)var(DD))
itemiz(var(DD)[tt(th)|tt(st)|tt(rd)] var(MNM)[tt(,)] [ var(YYYY) ])
itemiz(var(MNM) var(DD)[tt(th)|tt(st)|tt(rd)][tt(,)] [ var(YYYY) ])
itemiz(var(DD)[tt(th)|tt(st)|tt(rd)]tt(/)var(MM)[tt(,)] var(YYYY))
itemiz(var(DD)[tt(th)|tt(st)|tt(rd)]tt(/)var(MM)tt(/)var(YYYY))
itemiz(var(MM)tt(/)var(DD)[tt(th)|tt(st)|tt(rd)][tt(,)] var(YYYY))
itemiz(var(MM)tt(/)var(DD)[tt(th)|tt(st)|tt(rd)]tt(/)var(YYYY))
enditemize()

Here, var(MNM) is at least the first three letters of a month name,
matched case-insensitively.  The remainder of the month name may appear but
its contents are irrelevant, so janissary, febrile, martial, apricot,
maybe, junta, etc. are happily handled.

Where the year is shown as optional, the current year is assumed.  There
are only two such cases, the form tt(Jun 20) or tt(14 September) (the only
two commonly occurring forms, apart from a "the" in some forms of English,
which isn't currently supported).  Such dates will of course become
ambiguous in the future, so should ideally be avoided.

Times may follow dates with a colon, e.g. tt(1965/07/12:09:45); this is in
order to provide a format with no whitespace.  A comma and whitespace are
allowed, e.g. tt(1965/07/12, 09:45).  Currently the order of these
separators is not checked, so illogical formats such as tt(1965/07/12, :
,09:45) will also be matched.  For simplicity such variations are not shown
in the list above.  Otherwise, a time is only recognised as being
associated with a date if there is only whitespace in between, or if the
time was embedded in the date.

Days of the week are not normally scanned, but will be ignored if they
occur at the start of the date pattern only.  However, in contexts where it
is useful to specify dates relative to today, days of the week with no
other date specification may be given.  The day is assumed to be either
today or within the past week.  Likewise, the words tt(yesterday),
tt(today) and tt(tomorrow) are handled.  All matches are case-insensitive.
Hence if today is Monday, then tt(Sunday) is equivalent to tt(yesterday),
tt(Monday) is equivalent to tt(today), but tt(Tuesday) gives a date six
days ago.  This is not generally useful within the calendar file.
Dates in this format may be combined with a time specification; for
example tt(Tomorrow, 8 p.m.).

For example, the standard date format:

example(Fri Aug 18 17:00:48 BST 2006)

is handled by matching var(HH)tt(:)var(MM)tt(:)var(SS) and removing it
together with the matched (but unused) time zone.  This leaves the following:

example(Fri Aug 18 2006)

tt(Fri) is ignored and the rest is matched according to the standard rules.

subsect(Relative Time Format)

In certain places relative times are handled.  Here, a date is not allowed;
instead a combination of various supported periods are allowed, together
with an optional time.  The periods must be in order from most to
least significant.

In some cases, a more accurate calculation is possible when there is an
anchor date:  offsets of months or years pick the correct day, rather than
being rounded, and it is possible to pick a particular day in a month as
`(1st Friday)', etc., as described in more detail below.

Anchors are available in the following cases.  If one or two times are
passed to the function tt(calendar), the start time acts an anchor for the
end time when the end time is relative (even if the start time is
implicit).  When examining calendar files, the scheduled event being
examined anchors the warning time when it is given explicitly by means of
the tt(WARN) keyword; likewise, the scheduled event anchors a repetition
period when given by the tt(RPT) keyword, so that specifications such as
tt(RPT 2 months, 3rd Thursday) are handled properly.  Finally, the tt(-R)
argument to tt(calendar_scandate) directly provides an anchor for relative
calculations.

The periods handled, with possible abbreviations are:

startitem()
item(Years)(
tt(years), tt(yrs), tt(ys), tt(year), tt(yr), tt(y), tt(yearly).
A year is 365.25 days unless there is an anchor.
)
item(Months)(
tt(months), tt(mons), tt(mnths), tt(mths), tt(month), tt(mon),
tt(mnth), tt(mth), tt(monthly).  Note that tt(m), tt(ms), tt(mn), tt(mns)
are ambiguous and are em(not) handled.  A month is a period
of 30 days rather than a calendar month unless there is an anchor.
)
item(Weeks)(
tt(weeks), tt(wks), tt(ws), tt(week), tt(wk), tt(w), tt(weekly)
)
item(Days)(
tt(days), tt(dys), tt(ds), tt(day), tt(dy), tt(d), tt(daily)
)
item(Hours)(
tt(hours), tt(hrs), tt(hs), tt(hour), tt(hr), tt(h), tt(hourly)
)
item(Minutes)(
tt(minutes), tt(mins), tt(minute), tt(min), but em(not) tt(m),
tt(ms), tt(mn) or tt(mns)
)
item(Seconds)(
tt(seconds), tt(secs), tt(ss), tt(second), tt(sec), tt(s)
)
enditem()

Spaces between the numbers are optional, but are required between items,
although a comma may be used (with or without spaces).

The forms tt(yearly) to tt(hourly) allow the number to be omitted; it is
assumed to be 1.  For example, tt(1 d) and tt(daily) are equivalent.  Note
that using those forms with plurals is confusing; tt(2 yearly) is the same
as tt(2 years), em(not) twice yearly, so it is recommended they only
be used without numbers.

When an anchor time is present, there is an extension to handle regular
events in the form of the var(n)th var(some)day of the month.  Such a
specification must occur immediately after any year and month
specification, but before any time of day, and must be in the form
var(n)tt(LPAR()th|st|rd+RPAR()) var(day), for example tt(1st Tuesday) or
tt(3rd Monday).  As in other places, days are matched case insensitively,
must be in English, and only the first three letters are significant except
that a form beginning `month' does not match `Monday'.  No attempt is made
to sanitize the resulting date; attempts to squeeze too many occurrences
into a month will push the day into the next month (but in the obvious
fashion, retaining the correct day of the week).

Here are some examples:

example(30 years 3 months 4 days 3:42:41
14 days 5 hours
Monthly, 3rd Thursday
4d,10hr)

subsect(Example)

Here is an example calendar file.  It uses a consistent date format,
as recommended above.

example(Feb 1, 2006 14:30 Pointless bureaucratic meeting
Mar 27, 2006 11:00 Mutual recrimination and finger pointing
  Bring water pistol and waterproofs
Mar 31, 2006 14:00 Very serious managerial pontification
  # UID 12C7878A9A50
Apr 10, 2006 13:30 Even more pointless blame assignment exercise WARN 30 mins
May 18, 2006 16:00 Regular moaning session RPT monthly, 3rd Thursday)

The second entry has a continuation line.  The third entry has a
continuation line that will not be shown when the entry is displayed, but
the unique identifier will be used by the tt(calendar_add) function when
updating the event.  The fourth entry will produce a warning 30 minutes
before the event (to allow you to equip yourself appropriately).  The fifth
entry repeats after a month on the 3rd Thursday, i.e. June 15, 2006, at the
same time.

texinode(Calendar System User Functions)(Calendar Styles)(Calendar File and Date Formats)(Calendar Function System)
sect(User Functions)

This section describes functions that are designed to be called
directly by the user.  The first part describes those functions
associated with the user's calendar; the second part describes
the use in glob qualifiers.

subsect(Calendar system functions)

startitem()
findex(calendar)
xitem(tt(calendar) [ tt(-abdDsv) ] [ tt(-C) var(calfile) ] [ -n var(num) ] [ tt(-S) var(showprog) ] [ [ var(start) ] var(end) ])(
item(tt(calendar -r) [ tt(-abdDrsv) ] [ tt(-C) var(calfile) ] [ -n var(num) ] [ tt(-S) var(showprog) ] [ var(start) ])(
Show events in the calendar.

With no arguments, show events from the start of today until the end of
the next working day after today.  In other words, if today is Friday,
Saturday, or Sunday, show up to the end of the following Monday, otherwise
show today and tomorrow.

If var(end) is given, show events from the start of today up to the time
and date given, which is in the format described in the previous section.
Note that if this is a date the time is assumed to be midnight at the
start of the date, so that effectively this shows all events before
the given date.

var(end) may start with a tt(+), in which case the remainder of the
specification is a relative time format as described in the previous
section indicating the range of time from the start time that is to
be included.

If var(start) is also given, show events starting from that time and date.
The word tt(now) can be used to indicate the current time.

To implement an alert when events are due, include tt(calendar -s) in your
tt(~/.zshrc) file.

Options:

startitem()
item(tt(-a))(
Show all items in the calendar, regardless of the tt(start) and
tt(end).
)
item(tt(-b))(
Brief:  don't display continuation lines (i.e. indented lines following
the line with the date/time), just the first line.
)
item(tt(-B) var(lines))(
Brief: display at most the first var(lines) lines of the calendar
entry.  `tt(-B 1)' is equivalent to `tt(-b)'.
)
item(tt(-C) var(calfile))(
Explicitly specify a calendar file instead of the value of
the tt(calendar-file) style or the the default tt(~/calendar).
)
item(tt(-d))(
Move any events that have passed from the calendar file to the
"done" file, as given by the tt(done-file) style or the default
which is the calendar file with tt(.done) appended.  This option
is implied by the tt(-s) option.
)
item(tt(-D))(
Turns off the option tt(-d), even if the tt(-s) option is also present.
)
item(tt(-n) var(num), tt(-)var(num))(
Show at least var(num) events, if present in the calendar file, regardless
of the tt(start) and tt(end).
)
item(tt(-r))(
Show all the remaining options in the calendar, ignoring the given tt(end)
time.  The tt(start) time is respected; any argument given is treated
as a tt(start) time.
)
item(tt(-s))(
Use the shell's tt(sched) command to schedule a timed event that
will warn the user when an event is due.  Note that the tt(sched) command
only runs if the shell is at an interactive prompt; a foreground task
blocks the scheduled task from running until it is finished.

The timed event usually runs the programme tt(calendar_show) to show
the event, as described in
ifzman(the section UTILITY FUNCTIONS below)\
ifnzman(noderef(Calendar Utility Functions)).

By default, a warning of the event is shown five minutes before it is due.
The warning period can be configured by the style tt(warn-time) or
for a single calendar entry by including tt(WARN) var(reltime) in the first
line of the entry, where var(reltime) is one of the usual relative time
formats.

A repeated event may be indicated by including tt(RPT) var(reldate) in the
first line of the entry.  After the scheduled event has been displayed
it will be re-entered into the calendar file at a time var(reldate)
after the existing event.  Note that this is currently the only use
made of the repeat count, so that it is not possible to query the schedule
for a recurrence of an event in the calendar until the previous event
has passed.

It is safe to run tt(calendar -s) to reschedule an existing event
(if the calendar file has changed, for example), and also to have it
running in multiples instances of the shell since the calendar file
is locked when in use.

By default, expired events are moved to the "done" file; see the tt(-d)
option.  Use tt(-D) to prevent this.
)
item(tt(-S) var(showprog))(
Explicitly specify a programme to be used for showing events instead
of the value of the tt(show-prog) style or the default tt(calendar_show).
)
item(tt(-v))(
Verbose:  show more information about stages of processing.  This
is useful for confirming that the function has successfully parsed
the dates in the calendar file.
)
enditem()
)
findex(calendar_add)
item(tt(calendar_add) [ tt(-BL) ] var(event ...))(
Adds a single event to the calendar in the appropriate location.
The event can contain multiple lines, as described in
ifnzman(noderef(Calendar File and Date Formats))\
ifzman(the section Calendar File Format above).
Using this function ensures that the calendar file is sorted in date
and time order.  It also makes special arrangements for locking
the file while it is altered.  The old calendar is left in a file
with the suffix tt(.old).

The option tt(-B) indicates that backing up the calendar file will be
handled by the caller and should not be performed by tt(calendar_add).  The
option tt(-L) indicates that tt(calendar_add) does not need to lock the
calendar file as it is already locked.  These options will not usually be
needed by users.

If the style tt(reformat-date) is true, the date and time of the
new entry will be rewritten into the standard date format:  see
the descriptions of this style and the style tt(date-format).

The function can use a unique identifier stored with each event to ensure
that updates to existing events are treated correctly.  The entry
should contain the word tt(UID), followed by whitespace, followed by
a word consisting entirely of hexadecimal digits of arbitrary length
(all digits are significant, including leading zeroes).  As the UID
is not directly useful to the user, it is convenient to hide it on
an indented continuation line starting with a tt(#), for example:

example(Aug 31, 2007 09:30  Celebrate the end of the holidays
  # UID 045B78A0)

The second line will not be shown by the tt(calendar) function.
)
findex(calendar_edit)
item(tt(calendar_edit))(
This calls the user's editor to edit the calendar file.  If
there are arguments, they are taken as the editor to use (the file name
is appended to the commands); otherwise, the editor is given by the
variable tt(VISUAL), if set, else the variable tt(EDITOR).

If the calendar scheduler was running, then after editing the file
tt(calendar -s) is called to update it.

This function locks out the calendar system during the edit.
Hence it should be used to edit the calendar file if there is any
possibility of a calendar event occurring meanwhile.  Note this
can lead to another shell with calendar functions enabled hanging waiting
for a lock, so it is necessary to quit the editor as soon as possible.
)
findex(calendar_parse)
item(tt(calendar_parse) var(calendar-entry))(
This is the internal function that analyses the parts of a calendar
entry, which is passed as the only argument.  The function returns
status 1 if the argument could not be parsed as a calendar entry
and status 2 if the wrong number of arguments were passed; it also sets the
parameter tt(reply) to an empty associative array.  Otherwise,
it returns status 0 and sets elements of the associative
array tt(reply) as follows:
startsitem()
sitem(time)(The time as a string of digits in the same units as
tt($EPOCHSECONDS))
sitem(text1)(The text from the line not including the date and time of the
event, but including any tt(WARN) or tt(RPT) keywords and values.)
sitem(warntime)(Any warning time given by the tt(WARN) keyword as a string
of digits containing the time at which to warn in the same units as
tt($EPOCHSECONDS).  (Note this is an absolute time, not the relative time
passed down.)  Not set no tt(WARN) keyword and value were
matched.)
sitem(warnstr)(The raw string matched after the tt(WARN) keyword, else unset.)
sitem(rpttime)(Any recurrence time given by the tt(RPT) keyword as a string
of digits containing the time of the recurrence in the same units
as tt($EPOCHSECONDS).  (Note this is an absolute time.)  Not set if
no tt(RPT) keyword and value were matched.)
sitem(rptstr)(The raw string matched after the tt(RPT) keyword, else unset.)
sitem(text2)(The text from the line after removal of the date and any
keywords and values.)
)
endsitem()
)
findex(calendar_showdate)
item(tt(calendar_showdate) [ tt(-r) ] [ tt(-f) var(fmt) ] var(date-spec ...))(
The given var(date-spec) is interpreted and the corresponding date and
time printed.  If the initial var(date-spec) begins with a tt(PLUS()) or
tt(-) it is treated as relative to the current time; var(date-spec)s after
the first are treated as relative to the date calculated so far and
a leading tt(PLUS()) is optional in that case.  This allows one to
use the system as a date calculator.  For example, tt(calendar_showdate '+1
month, 1st Friday') shows the date of the first Friday of next month.

With the option tt(-r) nothing is printed but the value of the date and
time in seconds since the epoch is stored in the parameter tt(REPLY).

With the option tt(-f) var(fmt) the given date/time conversion format
is passed to tt(strftime); see notes on the tt(date-format) style below.

In order to avoid ambiguity with negative relative date specifications,
options must occur in separate words; in other words, tt(-r) and tt(-f)
should not be combined in the same word.
)
findex(calendar_sort)
item(tt(calendar_sort))(
Sorts the calendar file into date and time order.    The old calendar is
left in a file with the suffix tt(.old).
)
enditem()

subsect(Glob qualifiers)
findex(age)

The function tt(age) can be autoloaded and use separately from
the calendar system, although it uses the function tt(calendar_scandate)
for date formatting.  It requires the tt(zsh/stat) builtin, which
makes available the builtin tt(stat).  This may conflict with an
external programme of the same name; if it does, the builtin may be
disabled for normal operation by including the following code in
an initialization file:

example(zmodload -i zsh/stat
disable stat)

tt(age) selects files having a given modification time for use
as a glob qualifier.  The format of the date is the same as that
understood by the calendar system, described in
ifzman(the section FILE AND DATE FORMATS above)\
ifnzman(noderef(Calendar File and Date Formats)).

The function can take one or two arguments, which can be supplied either
directly as command or arguments, or separately as shell parameters.

example(print *+LPAR()e:age 2006/10/04 2006/10/09:+RPAR())

The example above matches all files modified between the start of those
dates.  The second argument may alternatively be a relative time
introduced by a tt(PLUS()):

example(print *+LPAR()e:age 2006/10/04 +5d:+RPAR())

The example above is equivalent to the previous example.

In addition to the special use of days of the week, tt(today) and
tt(yesterday), times with no date may be specified; these apply to today.
Obviously such uses become problematic around midnight.

example(print *+LPAR()e-age 12:00 13:30-+RPAR())

The example above shows files modified between 12:00 and 13:00 today.

example(print *+LPAR()e:age 2006/10/04:+RPAR())

The example above matches all files modified on that date.  If the second
argument is omitted it is taken to be exactly 24 hours after the first
argument (even if the first argument contains a time).

example(print *+LPAR()e-age 2006/10/04:10:15 2006/10/04:10:45-RPAR())

The example above supplies times.  Note that whitespace within the time and
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
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)
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.


texinode(Calendar Styles)(Calendar Utility Functions)(Calendar System User Functions)(Calendar Function System)
sect(Styles)

The zsh style mechanism using the tt(zstyle) command is describe in
ifzman(zmanref(zshmodules))\
ifnzman(noderef(The zsh/zutil Module)).  This is the same mechanism
used in the completion system.

The styles below are all examined in the context
tt(:datetime:)var(function)tt(:), for example tt(:datetime:calendar:).

startitem()
kindex(calendar-file)
item(tt(calendar-file))(
The location of the main calendar.  The default is tt(~/calendar).
)
kindex(date-format)
item(tt(date-format))(
A tt(strftime) format string (see manref(strftime)(3)) with the zsh
extensions providing various numbers with no leading zero or space
if the number is a single digit as described for the
tt(%D{)var(string)tt(}) prompt format in
ifzman(the section EXPANSION OF PROMPT SEQUENCES in zmanref(zshmisc))\
ifnzman(noderef(Prompt Expansion)).

This is used for outputting dates in tt(calendar), both to support
the tt(-v) option and when adding recurring events back to the calendar
file, and in tt(calendar_showdate) as the final output format.

If the style is not set, the default used is similar the standard system
format as output by the tt(date) command (also known as `ctime format'):
`tt(%a %b %d %H:%M:%S %Z %Y)'.
)
kindex(done-file)
item(tt(done-file))(
The location of the file to which events which have passed are appended.
The default is the calendar file location with the suffix tt(.done).
The style may be set to an empty string in which case a "done" file
will not be maintained.
)
kindex(reformat-date)
item(tt(reformat-date))(
Boolean, used by tt(calendar_add).  If it is true, the date and time
of new entries added to the calendar will be reformatted to the format
given by the style tt(date-format) or its default.  Only the date and
time of the event itself is reformatted; any subsidiary dates and times
such as those associated with repeat and warning times are left alone.
)
kindex(show-prog)
item(tt(show-prog))(
The programme run by tt(calendar) for showing events.  It will
be passed the start time and stop time of the events requested in seconds
since the epoch followed by the event text.  Note that tt(calendar -s) uses
a start time and stop time equal to one another to indicate alerts
for specific events.

The default is the function tt(calendar_show).
)
kindex(warn-time)
item(tt(warn-time))(
The time before an event at which a warning will be displayed, if the
first line of the event does not include the text tt(EVENT) var(reltime).
The default is 5 minutes.
)
enditem()


texinode(Calendar Utility Functions)(Calendar Bugs)(Calendar Styles)(Calendar Function System)
sect(Utility functions)

startitem()
findex(calendar_lockfiles)
item(tt(calendar_lockfiles))(
Attempt to lock the files given in the argument.  To prevent
problems with network file locking this is done in an ad hoc fashion
by attempting to create a symbolic link to the file with the name
var(file)tt(.lockfile).  No other system level functions are used
for locking, i.e. the file can be accessed and modified by any
utility that does not use this mechanism.  In particular, the user is not
prevented from editing the calendar file at the same time unless
tt(calendar_edit) is used.

Three attempts are made to lock the file before giving up.  If the module
tt(zsh/zselect) is available, the times of the attempts are jittered so that
multiple instances of the calling function are unlikely to retry at the
same time.

The files locked are appended to the array tt(lockfiles), which should
be local to the caller.

If all files were successfully locked, status zero is returned, else status one.

This function may be used as a general file locking function, although
this will only work if only this mechanism is used to lock files.
)
findex(calendar_read)
item(tt(calendar_read))(
This is a backend used by various other functions to parse the
calendar file, which is passed as the only argument.  The array
tt(calendar_entries) is set to the list of events in the file; no
pruning is done except that ampersands are removed from the start of
the line.  Each entry may contain multiple lines.
)
findex(calendar_scandate)
item(tt(calendar_scandate))(
This is a generic function to parse dates and times that may be
used separately from the calendar system.  The argument is a date
or time specification as described in
ifzman(the section FILE AND DATE FORMATS above)\
ifnzman(noderef(Calendar File and Date Formats)).  The parameter tt(REPLY)
is set to the number of seconds since the epoch corresponding to that date
or time.  By default, the date and time may occur anywhere within the given
argument.

Returns status zero if the date and time were successfully parsed,
else one.

Options:
startitem()
item(tt(-a))(
The date and time are anchored to the start of the argument; they
will not be matched if there is preceding text.
)
item(tt(-A))(
The date and time are anchored to both the start and end of the argument;
they will not be matched if the is any other text in the argument.
)
item(tt(-d))(
Enable additional debugging output.
)
item(tt(-m))(
Minus.  When tt(-R) var(anchor_time) is also given the relative time is
calculated backwards from var(anchor_time).
)
item(tt(-r))(
The argument passed is to be parsed as a relative time.
)
item(tt(-R) var(anchor_time))(
The argument passed is to be parsed as a relative time.  The time is
relative to var(anchor_time), a time in seconds since the epoch,
and the returned value is the absolute time corresponding to advancing
var(anchor_time) by the relative time given.
This allows lengths of months to be correctly taken into account.  If
the final day does not exist in the given month, the last day of the
final month is given.  For example, if the anchor time is during 31st
January 2007 and the relative time is 1 month, the final time is the
same time of day during 28th February 2007.
)
item(tt(-s))(
In addition to setting tt(REPLY), set tt(REPLY2) to the remainder of
the argument after the date and time have been stripped.  This is
empty if the option tt(-A) was given.
)
item(tt(-t))(
Allow a time with no date specification.  The date is assumed to be
today.  The behaviour is unspecified if the iron tongue of midnight
is tolling twelve.
)
enditem()
)
findex(calendar_show)
item(tt(calendar_show))(
The function used by default to display events.  It accepts a start time
and end time for events, both in epoch seconds, and an event description.

The event is always printed to standard output.  If the command line editor
is active (which will usually be the case) the command line will be
redisplayed after the output.

If the parameter tt(DISPLAY) is set and the start and end times are
the same (indicating a scheduled event), the function uses the
command tt(xmessage) to display a window with the event details.
)
enditem()

texinode(Calendar Bugs)()(Calendar Utility Functions)(Calendar Function System)
sect(Bugs)

As the system is based entirely on shell functions (with a little support
from the tt(zsh/datetime) module) the mechanisms used are not as robust as
those provided by a dedicated calendar utility.  Consequently the user
should not rely on the shell for vital alerts.

There is no tt(calendar_delete) function.

There is no localization support for dates and times, nor any support
for the use of time zones.

Relative periods of months and years do not take into account the variable
number of days.

The tt(calendar_show) function is currently hardwired to use tt(xmessage)
for displaying alerts on X Window System displays.  This should be
configurable and ideally integrate better with the desktop.

tt(calendar_lockfiles) hangs the shell while waiting for a lock on a file.
If called from a scheduled task, it should instead reschedule the event
that caused it.