diff options
Diffstat (limited to 'vdr.5')
| -rw-r--r-- | vdr.5 | 38 |
1 files changed, 22 insertions, 16 deletions
@@ -8,7 +8,7 @@ .\" License as specified in the file COPYING that comes with the .\" vdr distribution. .\" -.\" $Id: vdr.5 1.49 2006/02/19 15:04:21 kls Exp $ +.\" $Id: vdr.5 1.54 2006/02/26 14:10:00 kls Exp $ .\" .TH vdr 5 "19 Feb 2006" "1.3.43" "Video Disk Recorder Files" .SH NAME @@ -217,13 +217,8 @@ l l. \fB4\fR@this timer uses VPS \fB8\fR@this timer is currently recording (may only be up-to-date with SVDRP) .TE -Bits other than these can be used by external programs to mark active timers -and recognize if the user has modified them. When a user modifies an active -timer, the upper 16 bits of this unsigned 32 bit parameter will be explicitly set to 0. -Note: in order to allow future extensibility, external programs using the -\fBstatus\fR parameter should only use the upper 16 bit of this 32 bit parameter -and leave the lower 16 bit untouched. +All other bits are reserved for future use. .TP .B Channel The channel to record from. This is either the channel number as shown in the @@ -321,11 +316,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,10 +562,13 @@ 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 -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. +(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 lowercase +tags ('c' and 'e') will not appear in an \fIinfo.vdr\fR file. +Lines tagged with '#' are ignored and can be used by external tools to +store arbitrary information. .SS RESUME The file \fIresume.vdr\fR (if present in a recording directory) contains the position within the recording where the last replay session left off. @@ -626,12 +624,15 @@ 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 (@); l l. <channel id> @is the "channel ID", made up from the parameters defined in 'channels.conf' <channel name> @is the "name" as in 'channels.conf' (for information only, may be left out) +<event id> @is a 32 bit unsigned int, uniquely identifying this event <start time> @is the time (as a time_t integer) in UTC when this event starts <duration> @is the time (in seconds) that this event will take <table id> @is a hex number that indicates the table this event is contained in (if this is left empty or 0 this event will not be overwritten or modified by data that comes from the DVB stream) @@ -648,6 +649,11 @@ l l. This file will be read at program startup in order to restore the results of previous EPG scans. + +Note that the \fBevent id\fR that comes from the DVB data stream is actually +just 16 bit wide. The internal representation in VDR allows for 32 bit to +be used, so that external tools can generate EPG data that is guaranteed +not to collide with the ids of existing data. .SH SEE ALSO .BR vdr (1) .SH AUTHOR |