diff options
Diffstat (limited to 'doc/en/epgsearchmenu.conf.5.txt')
| -rw-r--r-- | doc/en/epgsearchmenu.conf.5.txt | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/doc/en/epgsearchmenu.conf.5.txt b/doc/en/epgsearchmenu.conf.5.txt new file mode 100644 index 0000000..c3db6a5 --- /dev/null +++ b/doc/en/epgsearchmenu.conf.5.txt @@ -0,0 +1,148 @@ +epgsearchmenu.conf(5) Epgsearch Version 0.9.24.beta9 epgsearchmenu.conf(5) + + + +NAME + epgsearchmenu.conf - Customizing the EPG menus + +DESCRIPTION + The file epgsearchmenu.conf 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 ..., Sched‐ + ule, Search results, Favorites) with a separate line. + +EXAMPLE + 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 + +SYNTAX + 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. + + The values for MenuWhatsOnNext, MenuWhatsOnElse, MenuSchedule, MenuSe‐ + archResults, 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. + + ’MenuSearchResults’ has something special: If you want to have differ‐ + ent layouts for your search results depending on the search, you can + use more then one menu template. Simply define e.g. an additional + + MenuSearchResultsTip of the Day=%chnr%:3|%time_w%:4|%t_status%:3|%genre%:10|%title%%colon% %subtitle%:35 + + 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. + + The following variables exist: + + %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 ’:’ + %<epg-category>% - a value from the extended EPG categories, specified in + epgsearchcats.conf, like %genre% or %category% + + for the ’Whats on...’ and ’Search results’ menu there is also: + + %chnr% - channel number + %chsh% - the short channel name (>=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’) + + the variables are not case sensitive. + + 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 + ’:’. + + 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. + + 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. + + There’s a sample epgsearchmenu.conf in the subdirectory "conf". For a + quick try copy it to your plugins config directory (e.g. /etc/vdr/plug‐ + ins). + + To enable icons from WarEagleIcon-Patch simply put the line + + WarEagleIcons=1 + + to epgsearchmenu.conf. + + 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. + +SEE ALSO + epgsearch(1) + +AUTHOR (man pages) + Mike Constabel <epgsearch (at) constabel (dot) net> + +REPORT BUGS + Bug reports (german): + + <http://www.vdr-developer.org/mantisbt/> + + Mailing list: + + <http://www.vdr-developer.org/mailman/listinfo/epgsearch> + +COPYRIGHT and LICENSE + Copyright (C) 2004-2007 Christian Wieninger + + 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. + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of MER‐ + CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General + Public License for more details. + + 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 http://www.gnu.org/licenses/old-licenses/gpl-2.0.html + + The author can be reached at cwieninger@gmx.de + + The project’s page is at http://winni.vdr-developer.org/epgsearch + + The MD5 code is derived from the RSA Data Security, Inc. MD5 Message- + Digest Algorithm. + + + +perl v5.8.8 2007-11-04 epgsearchmenu.conf(5) |