epgsearchuservars.conf - Man Page

Variables always get assigned strings whose spaces are retained. This is illustrated by the following examples:

    %Series%=New series~Thrillers

The variable %Series% will be assigned the string "New series~Thrillers". This can be used arbitrarily:

    %Path%=%Series%

The variable %Path% gets the content of the variable %Series% assigned.

    %Path%=%Series%~Lost

The variable %Path% contains the string "New series~Thrillers~Lost".

Simple if-then-else constructs for assignments are supported by means of conditional expressions if ? then : else. Conditional expressions cannot contain strings, only variables; spaces are ignored.

    %Foo%=Other
    %Variable%=%Path% ? %Path% : %Foo%

For the ternary operator ?:, the expression %Path% ? means "path not empty?". If this is true, %Variable% gets assigned the content of %Path%, else the content of %Foo%.

Other checks are supported as well:

Thus, for example:

    %Variable%=%Path%!=5 ? %Path% : %Foo%

The condition %Path%!=5 ? means "is %Path% not equal 5?".

Comparing variables is also feasible:

    %Five%=5
    %Variable%=%Path%!=%Five% ? %Path% : %Foo%

External commands can be called during variable evaluation as well. The returned string will be assigned to the respective variable:

    %UserVar%=system(<script-name>[, <parameters>])

Calls the script script-name with the parameters supplied in the optional list parameters. Such a parameter can be an arbitrary expression, optionally containing other variables, but no system call or conditional expression.

Example:

    %Result%=system(/usr/local/bin/my-script.sh, -t %Title% -s %Subtitle% -u %MyOtherVar%)

Variables used as parameters will be enclosed in single quotes (apostrophes), if needed.

The script should return a string without line feeds, since their removal may cause undesired results. If the script does not return anything, an empty string will be assigned to the variable %Result%.

A TCP service can be called with the following syntax:

    %Result%=connect(<address>, <port>, [<data>])

This will connect to address through the given port and pass the optional data. The parameter address can be an IP address or the domain name of a TCP service. The result returned by the service must be terminated with a line feed.

When passing values to the connect or system command, it can be helpful to have the length of an argument for simple parsing. The length can be retrieved by:

    %Result%=length(<any arguments>)

Example:

    %TitleLength%=length(%title%)

Refer to epgsearchmenu.conf(5) for a list of built-in variables. Furthermore, every variable defined in epgsearchcats.conf can be used; see epgsearchcats.conf(5) for details.