diff options
Diffstat (limited to 'html/en/epgsearchuservars.conf.5.html')
| -rw-r--r-- | html/en/epgsearchuservars.conf.5.html | 201 |
1 files changed, 201 insertions, 0 deletions
diff --git a/html/en/epgsearchuservars.conf.5.html b/html/en/epgsearchuservars.conf.5.html new file mode 100644 index 0000000..96be465 --- /dev/null +++ b/html/en/epgsearchuservars.conf.5.html @@ -0,0 +1,201 @@ +<?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="#syntax">SYNTAX</a></li> + <ul> + + <li><a href="#assignment">Assignment</a></li> + <li><a href="#control_structures">Control structures</a></li> + <li><a href="#calling_a_system_command">Calling a system command</a></li> + <li><a href="#possible_variables">Possible variables</a></li> + </ul> + + <li><a href="#examples">EXAMPLES</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>epgsearchuservars.conf</em> - User defined variables</p> +<p> +</p> +<hr /> +<h1><a name="description">DESCRIPTION</a></h1> +<p>In this file you can defines variables which then can be used +in epgsearch in any play where variables are possible.</p> +<p> +</p> +<hr /> +<h1><a name="syntax">SYNTAX</a></h1> +<p>Variables looks like %Variablename%.</p> +<p>``Variablename'' can be consist of any alphanumerical character. Space +and special characters are not allowed.</p> +<p>The variable names are case-insensitive.</p> +<p>Examples for possible names:</p> +<pre> + %Series% %DocuVar1% %ThemesSubtitleDate1%</pre> +<p> +</p> +<h2><a name="assignment">Assignment</a></h2> +<pre> + %Series%=New series~Thriller</pre> +<p>The variable %Series% will be assigned with the string ``New series~Thriller''.</p> +<p>Assignments are always strings. Spaces stay spaces.</p> +<pre> + %Path%=%Series%</pre> +<p>The variable %Path% gets the content of the variable %Series%.</p> +<p>You can do nearly everything:</p> +<pre> + %Path%=%Serie%~Lost</pre> +<p>The variable %Path% contains now the string ``New series~Thriller~Lost''.</p> +<p> +</p> +<h2><a name="control_structures">Control structures</a></h2> +<p>You can use simple ``if then else'' constructions.</p> +<p>These constructions cannot contain strings, only variables. +Spaces are ignored.</p> +<pre> + %Foo%=Other</pre> +<pre> + %Variable%=%Path% ? %Path% : %Foo%</pre> +<p>If %Path% is not empty, assign the content of %Path% to %Variable%, +otherwise the content of %Foo%.</p> +<p>``%Path% ?'' means ``not empty?''. You can use other checks.</p> +<pre> + %Variable%=%Path%!=5 ? %Path% : %Foo%</pre> +<p>``%Path%!=5 ?'' means ``is %Path% equal 5?''</p> +<p>You can also compare variables.</p> +<pre> + %Five%=5</pre> +<pre> + %Variable%=%Path%!=%Five% ? %Path% : %Foo%</pre> +<p>Other possible checks:</p> +<pre> + == equal + != not equal</pre> +<p> +</p> +<h2><a name="calling_a_system_command">Calling a system command</a></h2> +<p>You can call external commands. The returned string will be assigned +to a variable</p> +<pre> + %Result%=system(scriptname,%Variable1% %Variable2% -f %Variable3% --dir=%Variable4% --dummy)</pre> +<p>Calls the script ``scriptname'' with the parameters ``%Variable1%'', +``%Variable2%'', etc. The result will be stored in %Result%.</p> +<p>You can use as many variables as you want.</p> +<p>If needed, epgsearch will quote the variable.</p> +<p>The script must return a string <strong>without</strong> line break!</p> +<p>If the script returns nothing, an empty string will be assigned to the +Variable %Result%.</p> +<p> +</p> +<h2><a name="possible_variables">Possible variables</a></h2> +<p>The following variables exist:</p> +<pre> + %time% - start time in format HH:MM + %timeend% - end 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 + %summary% - summary + %htmlsummary% - summary, where all CR are replaced with '<br />' + %eventid% - numeric event ID</pre> +<pre> + %<epg-category>% - a value from the extended EPG categories, specified in + F<epgsearchcats.conf>, like %genre% or %category%</pre> +<pre> + %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')</pre> +<pre> + %colon% - the sign ':' + %datenow% - current date in format TT.MM.YY + %dateshnow% - current date in format TT.MM. + %timenow% - current time in format HH:MM + %videodir% - VDR video directory (e.g. /video) + %plugconfdir% - VDR plugin config directory (e.g. /etc/vdr/plugins) + %epgsearchdir% - epgsearchs config directory (e.g. /etc/vdr/plugins/epgsearch)</pre> +<p>See also <code>epgsearchcats.conf(5)</code>.</p> +<p> +</p> +<hr /> +<h1><a name="examples">EXAMPLES</a></h1> +<pre> + # Weekday, Date, Time + %DateStr%=%time_w% %date% %time%</pre> +<pre> + # Themes or Subtitle or Date + %ThemesSubtitleDate1%=%Subtitle% ? %Subtitle% : %DateStr% + %ThemesSubtitleDate%=%Themes% ? %Themes% : %ThemesSubtitleDate1%</pre> +<pre> + # Calls this script to get a recording path + %DocuScript%=system(doku.pl,%Title%,%Subtitle%,%Episode%,%Themes%,%Category%,%Genre%) + %Docu%=%DocuScript%</pre> +<p> +</p> +<hr /> +<h1><a name="see_also">SEE ALSO</a></h1> +<p><code>epgsearch(1)</code>, <code>epgsearchcats.conf(5)</code></p> +<p> +</p> +<hr /> +<h1><a name="author__man_pages_">AUTHOR (man pages)</a></h1> +<p>Mike Constabel <epgsearch (at) constabel (dot) net></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> |