summaryrefslogtreecommitdiff
path: root/html/en/epgsearchmenu.conf.5.html
blob: 01944fcc56780649c06324a138075eea4d488c4f (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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Epgsearch Version 0.9.24.beta9</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>

<body style="background-color: white">

<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#example">EXAMPLE</a></li>
	<li><a href="#syntax">SYNTAX</a></li>
	<li><a href="#see_also">SEE ALSO</a></li>
	<li><a href="#author__man_pages_">AUTHOR (man pages)</a></li>
	<li><a href="#report_bugs">REPORT BUGS</a></li>
	<li><a href="#copyright_and_license">COPYRIGHT and LICENSE</a></li>
</ul>
<!-- INDEX END -->

<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p><em>epgsearchmenu.conf</em> - Customizing the EPG menus</p>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>The file <em>epgsearchmenu.conf</em> in your plugins config directory is used to store
the entries for customizing the EPG menus. You specify the look of each menu
(What's on now, What's on next, What's on at ..., Schedule, Search results,
Favorites) with a separate line.</p>
<p>
</p>
<hr />
<h1><a name="example">EXAMPLE</a></h1>
<pre>
 MenuWhatsOnNow=%chnr%:3|%progrt2s%:5| %time% %t_status%:8|%category%:6| %title% ~ %subtitle%:35
 MenuWhatsOnNext=%chnr%:3|%time% %t_status%:8|%category%:8| %title% ~ %subtitle%:35
 MenuWhatsOnElse=%chnr%:3|%time% %t_status%:8|%category%:8| %title% ~ %subtitle%:35
 MenuSchedule=%time% %t_status%:8|%genre%:14| %title% ~ %subtitle%:35
 MenuSearchResults=%chnr%:3|%datesh% %time% %t_status%:14|%genre%:8| %title%%colon% %subtitle%:35
 MenuFavorites=%chnr%:3|%datesh% %time% %t_status%:14|%genre%:8| %title%%colon%%subtitle%:35</pre>
<p>
</p>
<hr />
<h1><a name="syntax">SYNTAX</a></h1>
<p>E.g. the entry 'MenuWhatsOnNow' tells epgsearch how you would like to build a 
line for the menu 'What's on now'. This would create a menu line starting with
the channel number, followed by a progress bar in text2skin style, a space of
one char, the start time, the timer status, the EPG category (like ``movie'')
and finally the title and subtitle.</p>
<p>The values for MenuWhatsOnNext, MenuWhatsOnElse, MenuSchedule,
MenuSearchResults, MenuFavorites specify the menu 'What's on next', 'What's on
at ...', 'Schedule', 'Search results' and 'Favorites' respectively. If you do
not specify one entry, epgsearch uses it's default menu look.</p>
<p>'MenuSearchResults' has something special: If you want to have different
layouts for your search results depending on the search, you can use more then
one menu template. Simply define e.g. an additional</p>
<pre>
 MenuSearchResultsTip of the Day=%chnr%:3|%time_w%:4|%t_status%:3|%genre%:10|%title%%colon% %subtitle%:35</pre>
<p>This will produce an additional menu item ``Result menu layout'' in the edit
menu of a search where you can choose between the default menu template and your
own templates. In the example above you will get ``Tip of the Day'' as selection
entry, since epgsearch simply cuts the leading ``MenuSearchResults''. When you
display the search results the chosen template will be used instead of the
default one.</p>
<p>The following variables exist:</p>
<pre>
 %time%           - start time in format HH:MM   
 %date%           - start date in format TT.MM.YY
 %datesh%         - start date in format TT.MM.
 %time_w%         - weekday name
 %time_d%         - start day in format TT
 %time_lng%       - start time in seconds since 1970-01-01 00:00
 %title%          - title   
 %subtitle%       - subtitle
 %t_status%       - timer status ('T', 't', 'R')
 %v_status%       - VPS status
 %r_status%       - running status
 %status%         - complete status, the same as
                    '%t_status%%v_status%%r_status%'
 %colon%          - the sign ':'
 %&lt;epg-category&gt;% - a value from the extended EPG categories, specified in
                    epgsearchcats.conf, like %genre% or %category%</pre>
<p>for the 'Whats on...' and 'Search results' menu there is also:</p>
<pre>
 %chnr%           - channel number
 %chsh%           - the short channel name (&gt;=vdr-1.3.15)
 %chlng%          - the 'normal' channel name
 %chdata%         - VDR's internal channel representation (e.g. 'S19.2E-1-1101-28106')
 %progr%          - graphical progress bar (not for menu 'Search results')
 %progrT2S%       - progress bar in text2skin style (not for menu 'Search results')</pre>
<p>the variables are not case sensitive.</p>
<p>An entry consists of up to 6 tables separated with '|'. The last entry of
each table should declare the table width in chars, separated with ':'.</p>
<p>If you use a separator like '~', '-' or '#' to separate items like title or   
subtitle, e.g. %title% ~ %subtitle%, and the subtitle is empty, then epgsearch 
will try to fix this automatically to avoid a trailing separator.</p>
<p>You should vary the tab width values to fit your needs, since the look often
depends on the selected skin. epgsearchmenu.conf is not reloaded with every
plugin call, since this is only useful when testing the conf file. To activate
the permanent reload for testing your conf, pass the new start parameter '-r'
or '--reloadmenuconf' in your runvdr.</p>
<p>There's a sample <em>epgsearchmenu.conf</em> in the subdirectory ``conf''. For a quick try
copy it to your plugins config directory (e.g. /etc/vdr/plugins).</p>
<p>To enable icons from WarEagleIcon-Patch simply put the line</p>
<pre>
 WarEagleIcons=1</pre>
<p>to <em>epgsearchmenu.conf</em>.</p>
<p>NOTE: As long as there is a file epgsearchmenu.conf with an entry for a special
menu, all setup settings regarding the look of this menu are ignored.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><code>epgsearch(1)</code></p>
<p>
</p>
<hr />
<h1><a name="author__man_pages_">AUTHOR (man pages)</a></h1>
<p>Mike Constabel &lt;epgsearch (at) constabel (dot) net&gt;</p>
<p>
</p>
<hr />
<h1><a name="report_bugs">REPORT BUGS</a></h1>
<p>Bug reports (german):</p>
<p><a href="http://www.vdr-developer.org/mantisbt/">http://www.vdr-developer.org/mantisbt/</a></p>
<p>Mailing list:</p>
<p><a href="http://www.vdr-developer.org/mailman/listinfo/epgsearch">http://www.vdr-developer.org/mailman/listinfo/epgsearch</a></p>
<p>
</p>
<hr />
<h1><a name="copyright_and_license">COPYRIGHT and LICENSE</a></h1>
<p>Copyright (C) 2004-2007 Christian Wieninger</p>
<p>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.</p>
<p>This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Or, point your browser to <a href="http://www.gnu.org/licenses/old-licenses/gpl-2.0.html">http://www.gnu.org/licenses/old-licenses/gpl-2.0.html</a></p>
<p>The author can be reached at <a href="mailto:cwieninger@gmx.de">cwieninger@gmx.de</a></p>
<p>The project's page is at <a href="http://winni.vdr-developer.org/epgsearch">http://winni.vdr-developer.org/epgsearch</a></p>
<p>The MD5 code is derived from the RSA Data Security, Inc. MD5 Message-Digest Algorithm.</p>

</body>

</html>