client: Unbreak standalone build
[empserver] / doc / schedule
1 This file documents how to configure update schedules.  The server
2 reads its update schedule from the file schedule in the same directory
3 as its econfig.
4
5 Comments start with # and extend to the end of the line.
6
7 Each non-blank line contains a directive.  Directives are:
8
9 * Single update: a time.
10
11   Time can be specified in a number of formats:
12
13   - ISO 8601: 2007-05-28 16:13
14
15   - Like ctime: Dec 22 15:35 2006
16
17   - Like RFC 2822: 22 Dec 2006 15:35
18
19   - Relative to anchor: next Fri 15:35
20
21     The time of day is optional.  The anchor is the last update
22     defined by single update directives.  It defaults to the current
23     time rounded up to the next minute.
24
25 * Repeating updates after anchor: every 24 hours, every 10 minutes
26
27   Does not change the anchor.
28
29   Optionally followed by a limit: until T, where T specifies a time.
30   An update precisely at T is within the limit.
31
32 * Skip update: skip T, where T specifies a time.
33
34 A blitz schedule can be defined with a single line:
35
36     every 10 minutes
37
38 Here's how to schedule updates Monday, Wednesday and Friday at 20:00,
39 starting June 1st 2007, skipping July 4th:
40
41     2007-06-01 20:00    # a Friday
42     every 168 hours
43     next mon
44     every 168 hours
45     next wed
46     every 168 hours
47     skip 2007-07-04 20:00
48
49 The server reads the schedule file on startup, after an update, on the
50 reload command, and on catching SIGHUP.  You can use the utility
51 program empsched to test a schedule before you install it.