summaryrefslogtreecommitdiff
path: root/README
blob: f75fbff0a02ebcec8b77813bd19b21e80891ce1e (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
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.

Description:

Epgfixer is a VDR plugin for doing extra fixing of EPG data. Everything is
done using regular expressions. Correctly named back references are placed
to the named EPG field.

Plugin also has EPG bug fixes included in VDR individually selectable from
setup menu.

Requirements:
 - VDR 1.7.26 or later
 - PCRE

Usage:

All regular expressions are placed to VDRPLUGINCONFDIR/epgfixer/regexp.conf.

Syntax of regexp.conf line is "Channel_list:Parsed_epg_field=Regexp" with:
- Lines beginning with # are regarded as comments.
- Lines beginning with ! are regarded as disabled regular expressions.
- Channel_list is optional comma separated list of channels for which the
  regular expression is used. If no list of channels is given the regular
  expression is used for all channels.
- 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.

Examples of regexp.conf:

# Example of disabled regexp:
!title=^(?:Movie: |Document: )(?<title>.*)$

# Remove "Movie: " or "Document: " from the beginning of title field for 
# channels 1, 3 and 5:
1,3,5:title=^(?:Movie: |Document: )(?<title>.*)$

# Move parental rating from end of title to correct EPG field:
title=^(?<title>.*)[ ][(](?<rating>[0-9S]{1,2})[)][ ]*$