epgsearchcmds.conf(5)

NAME
epgsearchcmds.conf – EPG commands

DESCRIPTION
This file contains commands that – like for the VDR's commands.conf or reccmds.conf – can be applied to the selected event in one of the EPG menus. However, nested commands, as introduced by VDR 1.7.12, are not supported.

EPGSearch has eight preset commands. If a file epgsearchcmds.conf exists, its commands will be appended to the list of the internal commands and start at position 9.

  Localization
If you like to have a language-dependent list of commands, simply translate your present epgsearchcmds.conf to your preferred OSD language and store it with the filename epgsearchcmds-<LOC>.conf, where <LOC> is the locale's code from i18n.c:

    { "eng,dos",
      "deu,ger",
      "slv",
      "ita",
      "dut,nla,nld",
      "por",
      "fra,fre",
      "nor",
      "fin,smi",
      "pol",
      "esl,spa",
      "ell,gre",
      "sve,swe",
      "rom,rum",
      "hun",
      "cat,cln",
      "rus",
      "hrv",
      "est",
      "dan"
      // see the source file
      // for the complete list
    }

If more codes are listed for a language (e.g., 'eng,dos'), choose one of them.

If a file corresponding to the VDR's OSD language is available, it will be loaded. If no such file exists, the system will attempt to load the epgsearchcmds.conf file instead.

  Command parameters
When a command is executed, the following parameters will be provided:

$1  Title of the EPG entry.

$2  Start time of the EPG entry in Epoch encoding (i.e., seconds since 1970-01-01 00:00 UTC), like in the shutdown script.

$3  Stop time of the EPG entry in Epoch encoding (i.e., seconds since 1970-01-01 00:00 UTC).

$4  Channel number of the EPG entry.

$5  Long channel name of the EPG entry.

$6  Subtitle of the EPG entry, or an empty string if not present.

Strings are enclosed in single quotes (apostrophes) when the command is called.

SYNTAX
Every line within the file represents a user-defined command, comprising the following fields:

Menu entry
    Term under which the command shall appear in the command list. The term must not contain ':' characters. If the term ends with a '?' character, confirmation will be requested before the command is executed.

Command
    Program or script to be executed when the command is invoked. The use of full pathnames is recommended.

The fields are separated by a ':' character. if contained in the command's invocation, a ':' character does not need to be treated specially, that is, be replaced with a specific substitute.

Lines beginning with a '#' character represent comments and are ignored.

EXAMPLES
 Remember event?               : /usr/local/bin/rememberevent.sh 0
 Remember and switch to event? : /usr/local/bin/rememberevent.sh 1
 Show EPG                      : /usr/local/bin/epg2taste.sh

The above scripts, amongst others, can be found in the directory scripts of the EPGSearch sources.

AUTHORS (man pages)
Originally provided by Mike Constabel <epgsearch (at) constabel (dot) net>.

Revised and adapted to recent plugin features by the current maintainers.

PROJECT SITE
The plugin is maintained as GitHub project:

<https://github.com/vdr-projects/vdr-plugin-epgsearch/>

REPORTING BUGS
Issues can be reported, and features be suggested, through the project's bug tracker:

<https://github.com/vdr-projects/vdr-plugin-epgsearch/issues/>

COPYRIGHT and LICENSE
Copyright (C) 2004-2010 Christian Wieninger

Copyright © 2011-2025 TomJoad (VDR-Portal), et al.

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 MERCHANTABILITY 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0.html>

The original author can be reached via cwieninger@gmx.de.

Current maintainers can be reached via the project's GitHub site (see above).

The MD5 code has been derived from the MD5 Message-Digest Algorithm of RSA Data Security, Inc.

SEE ALSO
epgsearch(1)