The 'summary' field of a timer definition has been renamed to 'aux'

1 files changed, 11 insertions, 8 deletions

diff --git a/vdr.5 b/vdr.5
index 8468ee4c..c360f161 100644
--- a/vdr.5
+++ b/vdr.5
@@ -8,7 +8,7 @@
 .\" License as specified in the file COPYING that comes with the
 .\" vdr distribution.
 .\"
-.\" $Id: vdr.5 1.49 2006/02/18 15:59:00 kls Exp $
+.\" $Id: vdr.5 1.50 2006/02/25 11:16:02 kls Exp $
 .\"
 .TH vdr 5 "19 Feb 2006" "1.3.43" "Video Disk Recorder Files"
 .SH NAME
@@ -321,11 +321,11 @@ recording (if that data is available). If at the time of recording either
 of these cannot be determined, \fBTITLE\fR will default to the channel name, and
 \fBEPISODE\fR will default to a blank.
 .TP
-.B Summary
-Arbitrary text that describes the recording made by this timer.
-Any newline characters in the summary have to be replaced by '|', and
-the summary may contain ':' characters. If this field is not empty, its
-contents will be written into the \fIinfo.vdr\fR file of the recording.
+.B Auxiliary data
+An arbitrary string that can be used by external applications to store any
+kind of data related to this timer. The string must not contain any newline
+characters. If this field is not empty, its contents will be written into the
+\fIinfo.vdr\fR file of the recording with the '@' tag.
 .SS SOURCES
 The file \fIsources.conf\fR defines the codes to be used in the \fBSource\fR field
 of channels in \fIchannels.conf\fR and assigns descriptive texts to them.
@@ -567,8 +567,9 @@ actual contents of this file.
 .SS INFO
 The file \fIinfo.vdr\fR (if present in a recording directory) contains
 a description of the recording, derived from the EPG data at recording time
-(if such data was available) or the \fBSummary\fR field of the corresponding
-timer. This is a plain ASCII file and contains tagged lines like the \fBEPG DATA\fR
+(if such data was available). The \fBAux\fR field of the corresponding
+timer (if given) is copied into this file, using the '@' tag.
+This is a plain ASCII file and contains tagged lines like the \fBEPG DATA\fR
 file (see the description of the \fIepg.data\fR file). Note that the tags
 c, E, e and V will not appear in an \fIinfo.vdr\fR file.
 .SS RESUME
@@ -626,6 +627,8 @@ All other tags are optional (although every event
 should at least have a \fBT\fR entry).
 There may be several \fBX\fR tags, depending on the number of tracks (video, audio etc.)
 the event provides.
+The special tag character \fB@\fR is used to mark the \fBauxiliary data\fR from
+a timer definition in the \fIinfo.vdr\fR file.
 
 .TS
 tab (@);