summaryrefslogtreecommitdiff
path: root/doc-src
diff options
context:
space:
mode:
authorChristian Wieninger <cwieninger (at) gmx (dot) de>2009-09-20 12:45:32 +0200
committerChristian Wieninger <cwieninger (at) gmx (dot) de>2009-09-20 12:45:32 +0200
commitdf09c23571eee2d45b856aed17b38deca44b0bbb (patch)
tree99c0f827137d8535884562893fb5a92893e0dbd7 /doc-src
parent5b4c9ee0bf713fc36709563733059426458ab485 (diff)
downloadvdr-plugin-epgsearch-df09c23571eee2d45b856aed17b38deca44b0bbb.tar.gz
vdr-plugin-epgsearch-df09c23571eee2d45b856aed17b38deca44b0bbb.tar.bz2
announcement of new events by mail
Diffstat (limited to 'doc-src')
-rw-r--r--doc-src/en/epgsearch.4.txt34
-rw-r--r--doc-src/en/epgsearch.conf.5.txt2
2 files changed, 29 insertions, 7 deletions
diff --git a/doc-src/en/epgsearch.4.txt b/doc-src/en/epgsearch.4.txt
index e70b396..758dbc2 100644
--- a/doc-src/en/epgsearch.4.txt
+++ b/doc-src/en/epgsearch.4.txt
@@ -771,13 +771,18 @@ mail you have to define the following sections:
- "subject" to be used as mail subject
- "mailbody" the body of the mail:
- put '%update.newtimers%' in the place where the list of new timers should
- appear. The same for %update.modtimers% and %update.deltimers% for the
- list of changed or deleted timers.
- - "timer" the description of one timer. This section is used to display one
- timer within a timer list, e.g. in %update.newtimers%
-
-each section is enclosed in a pseudo XML tag.
+ put %update.newtimers% in the place where the list of new timers should
+ appear. The same for %update.modtimers%, %update.deltimers% and
+ %update.newevents& for the list of changed or deleted timers and event
+ announcements.
+ - "timer" the description of one timer and "event" with the description of
+ one event. This section is used to display one timer within a timer list,
+ e.g. in %update.newtimers%. The same for "event".
+
+All sections are optional, e.g. if you don't use event announcements you
+can drop "%update.newevents%" in the mailbody and the "event" section. But
+of course you should have at least a mailbody ;-)
+Each section is enclosed in a pseudo XML tag.
The following variables can be used in the section <mailbody>:
@@ -794,6 +799,12 @@ The following variables can be used in the section <mailbody>:
within the timer section will be substituted to
an empty string.)
- %update.countdeltimers% - the number of deleted timers
+ - %update.newevents% - will be replaced with the list of events to
+ announce. These events are the search result of
+ search timers with the action "announce by mail".
+ The events are displayed as defined in the section
+ '<event>'
+ - %update.countnewevents% - the number of new events
- %colon% - the sign ':'
- %datenow% - current date in format TT.MM.YY
- %dateshnow% - current date in format TT.MM.
@@ -815,6 +826,15 @@ The following variables can be used in the section <timer>:
- any extended EPG variable as defined in epgsearchcats.conf
- any user variable (as in '12. User defined variables')
+The following variables can be used in the section <event>:
+
+ - any event variable (as in '10. Customizing the EPG menus')
+ - %search% - the name of the search timer that triggered
+ this event
+ - %searchid% - the ID of the corresponding search timer
+ - any extended EPG variable as defined in epgsearchcats.conf
+ - any user variable (as in '12. User defined variables')
+
For a conflict notification mail the following sections exist:
- "subject" to be used as mail subject
diff --git a/doc-src/en/epgsearch.conf.5.txt b/doc-src/en/epgsearch.conf.5.txt
index 265bc24..17040cc 100644
--- a/doc-src/en/epgsearch.conf.5.txt
+++ b/doc-src/en/epgsearch.conf.5.txt
@@ -53,6 +53,8 @@ is B<':'>:
0 = create a timer
1 = announce only via OSD (no timer)
2 = switch only (no timer)
+ 3 = announce via OSD and switch (no timer)
+ 4 = announce via mail
27 - use extended EPG info? 0/1
28 - extended EPG info values. This entry has the following format
(delimiter is '|' for each category, '#' separates id and value):