summaryrefslogtreecommitdiff
path: root/README
blob: ff4cde73122a2c6d8f4f4bd5a6f40a21c38e228b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
This is a "plugin" for the Video Disk Recorder (VDR).

Written by:           Matti Lehtimäki <matti.lehtimaki@gmail.com>

Project's homepage:   http://projects.vdr-developer.org/projects/plg-epgfixer

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
See the file COPYING for more information.

Requirements:
 - VDR 1.7.26 or later
 - PCRE library

Description:

Epgfixer is a VDR plugin for doing extra fixing of EPG data.

Features:

- Modifying EPG data using regular expressions. Correctly named back references
  are placed to the named EPG field.
- Character set conversions for channel using incorrect encoding.
- Blacklists for ignoring EPG data from stream.
- Regular expressions, character set conversions and blacklists can be applied to 
  either all channels or only to selected channels.
- Cloning EPG data from one channel to another.
- Removing HTML tags and replacing HTML characters with matching regular
  characters in EPG data.
- Editing all settings through setup menu.
- EPG bug fixes included in VDR individually selectable from
  setup menu.

Installation:

cd /put/your/path/here/VDR/PLUGINS/src
tar -xzf /put/your/path/here/vdr-epgfixer-X.Y.Z.tgz
ln -s epgfixer-X.Y.Z epgfixer
cd /put/your/path/here/VDR
cp -R PLUGINS/src/epgfixer/epgfixer /path/to/vdrconf/plugins/
make
make plugins
./vdr -P epgfixer

Configuration:

Regular expressions, character set conversions, blacklists and EPG clonings
are defined in regexp.conf, charset.conf, blacklist.conf and epgclone.conf,
respectively, located in "epgfixer" subdirectory of VDR's configuration 
directory for plugins. Check the example configuration files under "epgfixer"
subdirectory for further information.

General syntax of configuration files:
- Lines beginning with # are regarded as comments.
- Lines beginning with ! are regarded as disabled lines.
- Channel_list is optional comma separated list of channels for which the line
  is used. If no list of channels is given the line is used for all channels.
- Channel_list can contain either channel IDs (e.g. S19.2E-1-1089-12003-0) or
  numbers but not both.

Syntax of regexp.conf line is "Channel_list:Parsed_epg_field=Regexp" with:
- Parsed_epg_field is the EPG field for which the regular expression is applied
  with available field names title, shorttext and description.
- Regular expressions use named backreferences with either title, shorttext,
  description or rating (parental rating).
- By prepending "a" or "p" to backreference name (except rating field) the
  back referenced string is either appended or prepended to the original
  content of the target EPG field, respectively.
- Several regular expressions may be applied to same field.

Syntax of charset.conf line is "Channel_list:BroadcastCharset=OriginalCharSet"
with:
- OriginalCharSet and BroadcastCharset are names of a character set
  (e.g. iso8859-1).
- OriginalCharSet is the real character set of EPG data.
- BroadcastCharset is the optional incorrect character set received in data
  stream.
- If no BroadcastCharset is defined ISO6937 is assumed.

Syntax of blacklist.conf line is "Channel_list" with:
- Only comma separated list of channel to be ignored.

Syntax of epgclone.conf line is "FromChannel=ToChannel" with:
- Copy EPG data of FromChannel into ToChannel.