1epgsearchuservars.conf(5)   Epgsearch Version 2.4.1  epgsearchuservars.conf(5)
2
3
4

NAME

6       epgsearchuservars.conf - User defined variables
7

DESCRIPTION

9       In this file you can defines variables which then can be used in
10       epgsearch in any play where variables are possible.
11

SYNTAX

13       Variables looks like %Variablename%.
14
15       "Variablename" can be consist of any alphanumerical character. Space
16       and special characters are not allowed.
17
18       The variable names are case-insensitive.
19
20       Examples for possible names:
21
22        %Series% %DocuVar1% %ThemesSubtitleDate1%
23
24   Assignment
25        %Series%=New series~Thriller
26
27       The variable %Series% will be assigned with the string "New
28       series~Thriller".
29
30       Assignments are always strings. Spaces stay spaces.
31
32        %Path%=%Series%
33
34       The variable %Path% gets the content of the variable %Series%.
35
36       You can do nearly everything:
37
38        %Path%=%Serie%~Lost
39
40       The variable %Path% contains now the string "New series~Thriller~Lost".
41
42   Control structures
43       You can use simple "if then else" constructions.
44
45       These constructions cannot contain strings, only variables.  Spaces are
46       ignored.
47
48        %Foo%=Other
49
50        %Variable%=%Path% ? %Path% : %Foo%
51
52       If %Path% is not empty, assign the content of %Path% to %Variable%,
53       otherwise the content of %Foo%.
54
55       "%Path% ?" means "not empty?". You can use other checks.
56
57        %Variable%=%Path%!=5 ? %Path% : %Foo%
58
59       "%Path%!=5 ?" means "is %Path% equal 5?"
60
61       You can also compare variables.
62
63        %Five%=5
64
65        %Variable%=%Path%!=%Five% ? %Path% : %Foo%
66
67       Other possible checks:
68
69        ==   equal
70        !=   not equal
71
72   Calling a system command
73       You can call external commands. The returned string will be assigned to
74       a variable
75
76        %Result%=system(scriptname,%Variable1% %Variable2% -f %Variable3% --dir=%Variable4% --dummy)
77
78       Calls the script "scriptname" with the parameters "%Variable1%",
79       "%Variable2%", etc. The result will be stored in %Result%.
80
81       You can use as many variables as you want.
82
83       If needed, epgsearch will quote the variable.
84
85       The script must return a string without line break!
86
87       If the script returns nothing, an empty string will be assigned to the
88       Variable %Result%.
89
90   Possible variables
91       The following variables exist:
92
93        %time%           - start time in format HH:MM
94        %timeend%        - end time in format HH:MM
95        %date%           - start date in format TT.MM.YY
96        %datesh%         - start date in format TT.MM.
97        %time_w%         - weekday name
98        %time_d%         - start day in format TT
99        %time_lng%       - start time in seconds since 1970-01-01 00:00
100        %title%          - title
101        %subtitle%       - subtitle
102        %summary%        - summary
103        %htmlsummary%    - summary, where all CR are replaced with '<br />'
104        %eventid%        - numeric event ID
105
106        %<epg-category>% - a value from the extended EPG categories, specified in
107                           F<epgsearchcats.conf>, like %genre% or %category%
108
109        %chnr%           - channel number
110        %chsh%           - the short channel name
111        %chlng%          - the 'normal' channel name
112        %chdata%         - VDR's internal channel representation (e.g. 'S19.2E-1-1101-28106')
113
114        %colon%          - the sign ':'
115        %datenow%        - current date in format TT.MM.YY
116        %dateshnow%      - current date in format TT.MM.
117        %timenow%        - current time in format HH:MM
118        %videodir%       - VDR video directory (e.g. /video)
119        %plugconfdir%    - VDR plugin config directory (e.g. /etc/vdr/plugins)
120        %epgsearchdir%   - epgsearch config directory (e.g. /etc/vdr/plugins/epgsearch)
121
122       See also "epgsearchcats.conf(5)".
123

EXAMPLES

125        # Weekday, Date, Time
126        %DateStr%=%time_w% %date% %time%
127
128        # Themes or Subtitle or Date
129        %ThemesSubtitleDate1%=%Subtitle% ? %Subtitle% : %DateStr%
130        %ThemesSubtitleDate%=%Themes% ? %Themes% : %ThemesSubtitleDate1%
131
132        # Calls this script to get a recording path
133        %DocuScript%=system(doku.pl,%Title%,%Subtitle%,%Episode%,%Themes%,%Category%,%Genre%)
134        %Docu%=%DocuScript%
135

SEE ALSO

137       epgsearch(1), "epgsearchcats.conf(5)"
138

AUTHOR (man pages)

140       Mike Constabel <epgsearch (at) constabel (dot) net>
141

REPORT BUGS

143       Bug reports (german):
144
145       <http://projects.vdr-developer.org/projects/plg-epgsearch>
146
147       Mailing list:
148
149       <http://www.vdr-developer.org/mailman/listinfo/epgsearch>
150

152       Copyright (C) 2004-2010 Christian Wieninger
153
154       This program is free software; you can redistribute it and/or modify it
155       under the terms of the GNU General Public License as published by the
156       Free Software Foundation; either version 2 of the License, or (at your
157       option) any later version.
158
159       This program is distributed in the hope that it will be useful, but
160       WITHOUT ANY WARRANTY; without even the implied warranty of
161       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
162       General Public License for more details.
163
164       You should have received a copy of the GNU General Public License along
165       with this program; if not, write to the Free Software Foundation, Inc.,
166       51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Or, point
167       your browser to http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
168
169       The author can be reached at cwieninger@gmx.de
170
171       The project's page is at http://winni.vdr-developer.org/epgsearch
172
173       The MD5 code is derived from the RSA Data Security, Inc. MD5 Message-
174       Digest Algorithm.
175
176
177
178perl v5.34.0                      2021-07-23         epgsearchuservars.conf(5)
Impressum