diff options
Diffstat (limited to 'doc-src/en')
| -rw-r--r-- | doc-src/en/createcats.1.txt | 6 | ||||
| -rw-r--r-- | doc-src/en/epgsearch.1.txt | 96 | ||||
| -rw-r--r-- | doc-src/en/epgsearch.4.txt | 108 | ||||
| -rw-r--r-- | doc-src/en/epgsearch.conf.5.txt | 24 | ||||
| -rw-r--r-- | doc-src/en/epgsearchblacklists.conf.5.txt | 4 | ||||
| -rw-r--r-- | doc-src/en/epgsearchcats.conf.5.txt | 14 | ||||
| -rw-r--r-- | doc-src/en/epgsearchchangrps.conf.5.txt | 2 | ||||
| -rw-r--r-- | doc-src/en/epgsearchdirs.conf.5.txt | 4 | ||||
| -rw-r--r-- | doc-src/en/epgsearchmenu.conf.5.txt | 12 | ||||
| -rw-r--r-- | doc-src/en/epgsearchswitchtimers.conf.5.txt | 2 | ||||
| -rw-r--r-- | doc-src/en/epgsearchtemplates.conf.5.txt | 2 | ||||
| -rw-r--r-- | doc-src/en/epgsearchuservars.conf.5.txt | 6 | ||||
| -rw-r--r-- | doc-src/en/noannounce.conf.5.txt | 2 |
13 files changed, 141 insertions, 141 deletions
diff --git a/doc-src/en/createcats.1.txt b/doc-src/en/createcats.1.txt index dea416e..58497d5 100644 --- a/doc-src/en/createcats.1.txt +++ b/doc-src/en/createcats.1.txt @@ -46,7 +46,7 @@ Some notes: =over 4 -=item -m N, --minappearance=N +=item -m N, --minappearance=N createcats counts how often a category is used in your current epg.data. If this is less than N, then this category will not be part @@ -63,13 +63,13 @@ from a list of values. =item -l N, --maxlength=N if the text length of a value is more than N, this value is not part -of the value list. +of the value list. =back B<Hint:> Results are best, if your current EPG is as big as possible. So update it, if you are using an external EPG provider, before calling -createcats. +createcats. Please edit this file now, since it will contain also things not suitable. diff --git a/doc-src/en/epgsearch.1.txt b/doc-src/en/epgsearch.1.txt index ff00f39..fbb716b 100644 --- a/doc-src/en/epgsearch.1.txt +++ b/doc-src/en/epgsearch.1.txt @@ -13,7 +13,7 @@ additional functions: VDRAdmin auto-timer. - Add up to 4 user-defined times to 'now' and 'next' and an optional - favorites menu + favorites menu - Searching the EPG: Create reusable queries, which can also be used as 'search timers'. @@ -56,7 +56,7 @@ Parts of the sources are based on the repeating-ECG patch from Gerhard Steiner, =over 4 -=item -f file, --svdrpsendcmd=file +=item -f file, --svdrpsendcmd=file the path to svdrpsend.pl for external SVDRP communication (default is internal communication, so this is usually not needed anymore) @@ -71,13 +71,13 @@ is '<plugins configuration directory>/epgsearch' to specify a specific log file for epgsearch (default log file is epgsearch.log in the epgsearch config directory) -=item -v n, --verbose=n +=item -v n, --verbose=n verbose level for log file. Value 0 means no logging. Other values are 1 (general messages), 2 (detailed messages), 3 (planned for extra detailed info for debugging purposes) -=item -r, --reloadmenuconf +=item -r, --reloadmenuconf reload epgsearchmenu.conf with plugin call. This can be useful when testing customized menu layouts. @@ -138,7 +138,7 @@ item. There are 8 built-in commands: This puts the selected event in the file epgsearchdone.data and instructs epgsearch to avoid recording this event if an according search timer is set to "avoid repeats". An already created timer will be automatically removed - with the next search timer update. + with the next search timer update. - Add/Remove to/from switch list?: Controls the switch list. If there is an event in the switch list, epgsearch @@ -159,12 +159,12 @@ reccmds.conf. When a command is executed the following parameters are passed to it: $1: the title of the EPG entry - $2: the start time of the EPG entry as time_t value (like in the + $2: the start time of the EPG entry as time_t value (like in the shutdown script) $3: the end time $4: the channel number of the EPG entry $5: the long channel name of the EPG entry - $6: the subtitle of the EPG entry, "" if not present + $6: the subtitle of the EPG entry, "" if not present To execute a command from the main menu you can also press its associated number without opening the commands menu. @@ -173,7 +173,7 @@ associated number without opening the commands menu. Here you can add, edit, delete and execute your own queries on the EPG. The usage and behavior of this menu is similar to VDR's timer -menu. +menu. =head3 1.2.1 Menu edit search @@ -214,7 +214,7 @@ See also C<epgsearch(4)> 'Description of the search process'. =item - B<Use content descriptor> -Some providers deliver content descriptors in their EPG, like "Movie/Drama", +Some providers deliver content descriptors in their EPG, like "Movie/Drama", "Documentation",...(available with vdr-1.7.11) Select here the descriptors to search for. Multiple choice is possible, that must match with all given descriptors (AND operator). @@ -225,8 +225,8 @@ Only available if configured, see below 'Using extended EPG info'. =item - B<Ignore missing categories:> -If set to 'Yes' this tells epgsearch that a missing EPG category -should not exclude an event from the results. Caution: Using this without +If set to 'Yes' this tells epgsearch that a missing EPG category +should not exclude an event from the results. Caution: Using this without any other criterions could flood your timers. =item - B<Use channel:> @@ -250,14 +250,14 @@ You'll find the user-defined selection in the list after Friday. =item - B<Use blacklists:> Blacklists are a way to exclude unwanted events. Select only global, one, more -or all blacklists here. If any search result is also contained in one of +or all blacklists here. If any search result is also contained in one of the selected blacklists it will be skipped. =item - B<Use in favorites menu:> Only available if turned on in setup. With this option you can mark a search to be used in the favorites menu. The search results of all these searches are -listed in the favorites menu. +listed in the favorites menu. =item - B<Result menu layout:> @@ -277,8 +277,8 @@ or not. Default action is creating a timer for the search results. But you can also choose to simply announce the found event via OSD as soon as it is found -or to automatically switch to the event before it starts. It's also possible to -get an announcement via OSD before the event starts and to switch to its channel +or to automatically switch to the event before it starts. It's also possible to +get an announcement via OSD before the event starts and to switch to its channel with 'Ok'. =item - B<Serial recording:> @@ -313,13 +313,13 @@ after ... days. If the given numbers of recordings currently exists, then epgsearch will not create further timers. After deleting one or more -recordings it will go on generating new timers. +recordings it will go on generating new timers. =item - B<Avoid repeats:> If you don't want to record repeats, this feature tries to check if an event was already recorded/programmed and skips it. Please refer -to the section 'Avoid repeats - internals' below before using it. +to the section 'Avoid repeats - internals' below before using it. =item - B<Allowed repeats:> @@ -339,27 +339,27 @@ compared. =item - B<Compare subtitle:> When comparing to events then specify here if the subtitle should be -compared. With 'if present' epgsearch will classify two events only as equal if -their episode names match and are not empty. +compared. With 'if present' epgsearch will classify two events only as equal if +their episode names match and are not empty. =item - B<Compare description:> When comparing to events then specify here if the description should -be compared. +be compared. For comparison all parts of the description, that look like a category value, are removed first. The remaining text will be -compared. If this is similar at the value of the next option +compared. If this is similar at the value of the next option (regarding the Levinshtein-Distance algorithm) then it will be accepted as equal. =item - C<Min. match in %:> -The needed minimum match of descriptions in percent. +The needed minimum match of descriptions in percent. =item - B<Compare date:> -Sometimes an event is repeated many times within some period (day, week, month,...), but one -cannot distinguish the repeats based on the EPG contents. So the only information is its time. +Sometimes an event is repeated many times within some period (day, week, month,...), but one +cannot distinguish the repeats based on the EPG contents. So the only information is its time. To use this for comparison select the appropriate period. =item - B<Compare categories:> @@ -522,7 +522,7 @@ A favorites menu can display a list of your favorite broadcasts. Enable this if you want an additional menu besides 'Now' and 'Next'. You can choose between displaying this menu before or after the menus with user-defined times. Any search can be used as a favorite. You only have to set the option -'Use in favorites menu' when editing a search. +'Use in favorites menu' when editing a search. =item - B<for the next ... hours:> @@ -667,7 +667,7 @@ search. Here you can manage blacklists which can be used to suppress unwanted events within a search. -A blacklist can also be marked as global. Since the default setting of a search timer +A blacklist can also be marked as global. Since the default setting of a search timer for 'use blacklists' is 'only global', this is a simple way to exclude unwanted events form all search timers, except: If the search timer has the option 'use blacklists: none' no blacklists are taken into account. Also the search for repeats within the OSD ignores @@ -713,18 +713,18 @@ in the conflicts overview. =item - B<Only check within next ... days:> Here you can specify the day range that should be used for the conflict -check. +check. =item - B<After each timer programming:> This performs a conflict check after each manual timer programming and - if the new/modified timer is involved in a conflict - pops up an OSD message -about it. +about it. =item - B<"When a recording starts:> -Set this to 'yes' if the conflict check should be performed when a recording starts. -In the case of a conlfict you get immediately a message that informs you about it. +Set this to 'yes' if the conflict check should be performed when a recording starts. +In the case of a conlfict you get immediately a message that informs you about it. The message is only displayed if the conflict is within the next 2 hours. =item - B<After each search timer update:> @@ -750,7 +750,7 @@ conflict appears within the given time, use this feature. =item - B<Avoid notification when replaying:> -Set this to 'yes' if the don't want to get OSD messages about conflicts if +Set this to 'yes' if the don't want to get OSD messages about conflicts if you currently replay something. Nevertheless messages will be displayed if the first upcoming conflict is within the next 2 hours. @@ -796,7 +796,7 @@ conflict check setup to be activated.) =item - B<Send to:> -The mail adress of the recipient. Note: Some providers (like Arcor) don't +The mail adress of the recipient. Note: Some providers (like Arcor) don't allow the same adresse for sender and recipient. =item - B<Mail method:> @@ -810,7 +810,7 @@ You can choose between: =item - B<Email address:> -Your full(!) email account address to be used for sending the mail. +Your full(!) email account address to be used for sending the mail. =item - B<SMTP server:> @@ -848,7 +848,7 @@ it as search timer. Now the plugin scans EPG entries in certain update intervals (->setup) in the background and creates timers if there are matching entries. If you don't like to get a new timer, but only want to be informed about the event set 'Announce only (no timer)' to -yes. +yes. Since these search timers are quite useful for serials, you can set the option 'serial recording' in a search, which creates timers whose recordings are stored in a folder with the serials name and @@ -865,8 +865,8 @@ touch /etc/vdr/plugins/epgsearch/.epgsearchupdate This can also be part of your shutdown script. (Add here a sleep afterwards to give the plugin the time to finish the scan.) -For more info about searchtimers please refer to C<epgsearch(4)>, -'Description of the search process' and 'How do Search Timers work?' +For more info about searchtimers please refer to C<epgsearch(4)>, +'Description of the search process' and 'How do Search Timers work?' =head2 2.1 'Avoid repeats' - internals @@ -887,14 +887,14 @@ extended EPG categories within the description of an event to be compared with the elements of another event. This comparison is always done case-sensitive and for the whole -term. But the description of an event makes an exception of this. +term. But the description of an event makes an exception of this. First all text within the description will be truncated that looks like an extended category entry, e.g. 'Rating: tip'. An extended category entry is a line of text beginning with max. 40 signs, followed by ':' and ending with max. 60 further signs. The reason for this cutting is that some categories like the rating of an event are not part of the description of the repeat of the same -event. +event. The remaining text will now be compared by length. If the difference is bigger then 90%, then we rate the description of the two events as @@ -913,7 +913,7 @@ timer for the same event. To remember past recordings epgsearch stores their info in the file epgsearchdone.data. You can have a look at the contents of this file -calling 'show recordings done' in the 'actions' of the searches menu. +calling 'show recordings done' in the 'actions' of the searches menu. This file only stores info about recordings that are complete, i.e. that started and stopped just in time. So a broken recording will not be stored in this file and epgsearch will automatically try to @@ -926,7 +926,7 @@ After creating such a search timer, you should first check if it does what is intended. Therefore the menu of search results has an additional mode for the key 'blue' named 'Timer preview'. Here you can see, what timers the next update would create. Existing timers are -labeled with 'T', future timers with 'P'. +labeled with 'T', future timers with 'P'. Hint: If the programming results in a conflict simply disable the conflicting timer in the timers menu. The next search timer update, @@ -950,10 +950,10 @@ See C<epgsearch(4)>. Some EPG providers deliver additional EPG information like the type of event, the video and audio format, cast,... in the content summary. -Note: This is different from the content descriptors introduced in vdr-1.7.11, +Note: This is different from the content descriptors introduced in vdr-1.7.11, that are delivered as extra data with a common standard. Unfortunately not all providers deliver this data, or the set wrong descriptors. So you can -use the approach of 'extended EPG info' here, which is a way to extract that +use the approach of 'extended EPG info' here, which is a way to extract that info from the content summary. Using tvm2vdr or epg4vdr you can import this into vdr. @@ -971,9 +971,9 @@ format of the file is as follows: - 'search mode' specifies the search mode: text comparison: 0 - the whole term must appear as substring - 1 - all single terms (delimiters are ',', ';', '|' or '~') + 1 - all single terms (delimiters are ',', ';', '|' or '~') must exist as substrings. This is the default search mode. - 2 - at least one term (delimiters are ',', ';', '|' or '~') + 2 - at least one term (delimiters are ',', ';', '|' or '~') must exist as substring. 3 - matches exactly 4 - regular expression @@ -1006,16 +1006,16 @@ the category name as also the value. =head1 5. Replacing the standard schedule menu -To use this plugin as a replacement for the default green key, simply +To use this plugin as a replacement for the default green key, simply put the line Green @epgsearch in your keymacros.conf. If you don't like to get another plugin entry in your main menu, first hide it by setup. Then you could use my -launcher-plugin and put the line +launcher-plugin and put the line - Green @launcher x + Green @launcher x in your keymacros.conf, where x is the position of the Epgsearch plugin within launchers menu listing. @@ -1028,7 +1028,7 @@ this patch the entry should look like Green Schedule This patch is already included in some patch collections, like the -Bigpatch. +Bigpatch. =head1 6. Add-ons diff --git a/doc-src/en/epgsearch.4.txt b/doc-src/en/epgsearch.4.txt index 5fc60a5..d6fc4cf 100644 --- a/doc-src/en/epgsearch.4.txt +++ b/doc-src/en/epgsearch.4.txt @@ -31,8 +31,8 @@ If you are using extended EPG information, you can use variables as part of a directory entry of a search timer. These variables always have the form '%variable%'. The name of a variable corresponds with the internal name of an extended EPG info, as specified in the file -epgsearchcats.conf (samples can be found in subdirectory 'conf'). -Example: +epgsearchcats.conf (samples can be found in subdirectory 'conf'). +Example: 1|Category|Kategorie|Information,Kinder,Musik,Serie,Show,Spielfilm,Sport|3 @@ -52,7 +52,7 @@ subtitle will be automatically appended. So the directory entry %Category%~%Genre%~%Title%~%Subtitle% -is the same as +is the same as %Category%~%Genre% (with 'serial recording' set to 'yes'). @@ -81,18 +81,18 @@ is B<':'>: 1 - unique search timer id 2 - the search term 3 - use time? 0/1 - 4 - start time in HHMM - 5 - stop time in HHMM + 4 - start time in HHMM + 5 - stop time in HHMM 6 - use channel? 0 = no, 1 = Interval, 2 = Channel group, 3 = FTA only 7 - if 'use channel' = 1 then channel id[|channel id] in vdr format, one entry or min/max entry separated with |, if 'use channel' = 2 - then the channel group name - 8 - match case? 0/1 + then the channel group name + 8 - match case? 0/1 9 - search mode: 0 - the whole term must appear as substring - 1 - all single terms (delimiters are blank,',', ';', '|' or '~') + 1 - all single terms (delimiters are blank,',', ';', '|' or '~') must exist as substrings. - 2 - at least one term (delimiters are blank, ',', ';', '|' or '~') + 2 - at least one term (delimiters are blank, ',', ';', '|' or '~') must exist as substring. 3 - matches exactly 4 - regular expression @@ -104,10 +104,10 @@ is B<':'>: 13 - use duration? 0/1 14 - min duration in minutes 15 - max duration in minutes - 16 - use as search timer? 0/1/2 (with 2 one can specify time margins in + 16 - use as search timer? 0/1/2 (with 2 one can specify time margins in parameter 48/49 where the search timer is active) 17 - use day of week? 0/1 - 18 - day of week (0 = Sunday, 1 = Monday...; + 18 - day of week (0 = Sunday, 1 = Monday...; -1 Sunday, -2 Monday, -4 Tuesday, ...; -7 Sun, Mon, Tue) 19 - use series recording? 0/1 20 - directory for recording @@ -129,9 +129,9 @@ is B<':'>: (a ':' will be translated to "!^colon^!", e.g. in "16:9") 29 - avoid repeats? 0/1 30 - allowed repeats - 31 - compare title when testing for a repeat? 0/1 - 32 - compare subtitle when testing for a repeat? 0=no/1=yes/2=yes-if present - 33 - compare description when testing for a repeat? 0/1 + 31 - compare title when testing for a repeat? 0/1 + 32 - compare subtitle when testing for a repeat? 0=no/1=yes/2=yes-if present + 33 - compare description when testing for a repeat? 0/1 34 - compare extended EPG info when testing for a repeat? This entry is a bit field of the category IDs. 35 - accepts repeats only within x days @@ -166,7 +166,7 @@ See also C<epgsearch.conf(5)>. First, for each broadcasting a search text divided by '~' is created, depending on the settings of 'Use title', 'Use subtitle' and 'Use -description': +description': title~subtitle~description @@ -184,7 +184,7 @@ if the search term is found anywhere in the search text. =item - 'at least one word', 'all words' first the search term will be split in single words. Delimiters are a -blank and the characters ',' ';' '|' '~'. +blank and the characters ',' ';' '|' '~'. Then we check if at least one or all words appear in the search text. @@ -217,10 +217,10 @@ but replaces this one later if the subtitle is present. Start and end times of a broadcasting often vary a little bit. To avoid getting many different timers for the same event, the plugin checks before adding a new timer, if there is one, that has start and -end times which only differ by a maximum of 10 minutes (or the events -duration if this is less then 10 minutes). If so, the present timer is -modified, else a new timer is created. If the timer was set to inactive -there will be no update. Also manually corrected priority or lifetime +end times which only differ by a maximum of 10 minutes (or the events +duration if this is less then 10 minutes). If so, the present timer is +modified, else a new timer is created. If the timer was set to inactive +there will be no update. Also manually corrected priority or lifetime will not be changed when updating. If you have set 'Announce only (no timer)' to yes, no timer is @@ -268,7 +268,7 @@ OSD when the update has finished This menu displays directories, that can be used for search timers or ordinary timers. The items displayed are read from the following -sources: +sources: * current recording directories * current timer directories @@ -389,13 +389,13 @@ the following commands are available: * 'UPDD' to reload the file epgsearchdone.data, e.g. after an external tool has modified it. * 'SETS <ON|OFF>' to temporarily activate or cancel the search timer background - thread. + thread. * 'FIND <settings>' for searching the EPG input is the same as with 'NEWS'. output is a list of found events formatted as 'NEWT' lines. So they can be immediately used to create a new timer for an event. * 'QRYS < ID(s) >' to get the results for a search with the given - ID. Multiple IDs can also be passed and have to be separated with '|'. + ID. Multiple IDs can also be passed and have to be separated with '|'. The results are formatted like this: search ID : // the ID of the corresponding search timer @@ -410,10 +410,10 @@ the following commands are available: timer file : // timer file (only valid if timer flag is > 0) timer flag : // 0 = no timer needed, 1 = has timer, 2 timer planned for next update) * 'QRYS <settings>' to get the results for a search with the given search - settings. + settings. * 'QRYF [hours]' to get the results for the favorites menu, see QRYS for result format. The optional parameter specifies the number of hours to - evaluate and defaults to 24h. + evaluate and defaults to 24h. * 'MENU [PRG|NOW|SUM]' calls one of the main menus of epgsearch or the summary of the current event. * 'UPDT' reloads the search timers from epgsearch.conf @@ -469,12 +469,12 @@ the following commands are available: =head2 timer conflicts: * 'LSCC [REL]' returns the current timer conflicts. With the option 'REL' only - relevant conflicts are listed. The result list looks like this for example + relevant conflicts are listed. The result list looks like this for example when we have 2 timer conflicts at one time: 1190232780:152|30|50#152#45:45|10|50#152#45 - '1190232780' is the time of the conflict in seconds since 1970-01-01. It's + '1190232780' is the time of the conflict in seconds since 1970-01-01. It's followed by list of timers that have a conflict at this time: '152|30|50#152#45' is the description of the first conflicting timer. Here: @@ -491,7 +491,7 @@ the following commands are available: The file F<epgsearchmenu.conf> in your epgsearch 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. Here's a sample: +Favorites) with a separate line. Here's a sample: 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 @@ -509,7 +509,7 @@ and finally the title and subtitle. 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. +not specify one entry, epgsearch uses it's default menu look. 'MenuSearchResults' has something special: If you want to have different layouts for your search results depending on the search, you can use more then @@ -539,7 +539,7 @@ The following variables exist: %time_d% - start day in format TT %time_lng% - start time in seconds since 1970-01-01 00:00 %timespan% - timespan from now to the beginning of an event, e.g. 'in 15m' - or the time an event is already running, e.g. '10m'. + or the time an event is already running, e.g. '10m'. %length% - length in seconds %title% - title %subtitle% - subtitle @@ -562,7 +562,7 @@ for the 'Whats on...' and 'Search results' menu there are also: %chsh% - the short channel name %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'), + %progr% - graphical progress bar (not for menu 'Search results'), requires VDRSymbols font %progrT2S% - progress bar in text2skin style (not for menu 'Search results') @@ -624,7 +624,7 @@ title always displays the number of relevant conflicts and the total number. The list displays first the time when a conflict appears and then all timers that will fail here. A timer entry consists of the channel number and its name followed by the timer priority and the percentage value that shows how much of -the timer will be recorded. Finally the timer's file entry is displayed. +the timer will be recorded. Finally the timer's file entry is displayed. When you select a timer entry and press 'Ok' or 'Details' you get a new menu which displays all concurrent timers. This menu allows you to resolve the @@ -640,16 +640,16 @@ An entry of this menu consists of the sign '>' to indicate an active timer, the channel number, the start and stop time, the priority, the number of the device that will do the recording (or 'C' for conflict) and the timer's file entry. Pressing 'Ok' on a timer entry will show you its event description if -present. +present. If one returns from this menu to the conflict overview menu there will be an automatic update to see if a conflict was really resolved. Some changes to a timer (like modifying start/stop or deleting a timer) in the conflict details menu also cause an immediate return to the overview menu and produce an -update. +update. Note: -There's a 'hidden' setup option epgsearch.ConflCheckCmd, that allows executing a +There's a 'hidden' setup option epgsearch.ConflCheckCmd, that allows executing a command for each timer causing a conflict. You have to set this directly in VDRs setup.conf like this: @@ -733,16 +733,16 @@ Other possible checks: You can call external commands. The returned string will be assigned to a variable - %uservar%=system(scriptname[, parameters]) + %uservar%=system(scriptname[, parameters]) Calls the script "scriptname" with the parameters defined in the optional list of 'parameters'. This can be an arbitrary expression containing other user variables, but not again a system call or a conditional expression. -Sample: +Sample: + + %myVar%=system(/usr/local/bin/myscript.sh, -t %title% -s %subtitle% -u %myOtherVar%) - %myVar%=system(/usr/local/bin/myscript.sh, -t %title% -s %subtitle% -u %myOtherVar%) - The script must return a string B<without> line break! If the script returns nothing, an empty string will be assigned to the @@ -752,18 +752,18 @@ Variable %Result%. You can call a TCP service with the following syntax: - %uservar%=connect(<addr>, <port>, [<data>]) + %uservar%=connect(<addr>, <port>, [<data>]) This will connect to <addr> through the given port and pass the optional given -data. <addr> can be an IP address or the domain name of the TCP service. The result -returned by the service must be terminated with a line feed. +data. <addr> can be an IP address or the domain name of the TCP service. The result +returned by the service must be terminated with a line feed. =head2 Get the length of an argument -When passing any values to the connect or system command it can be helpful to have +When passing any values to the connect or system command it can be helpful to have the length of an argument for simple parsing. This can be done with - %uservar%=length(<any arguments>) + %uservar%=length(<any arguments>) Sample: @@ -778,7 +778,7 @@ See C<epgsearchcats.conf(5)>. =head2 EXAMPLES - # Weekday, Date, Time + # Weekday, Date, Time %DateStr%=%time_w% %date% %time% # Themes or Subtitle or Date @@ -814,11 +814,11 @@ mail you have to define the following sections: - "subject" to be used as mail subject - "mailbody" the body of the mail: put %update.newtimers% in the place where the list of new timers should - appear. The same for %update.modtimers%, %update.deltimers% and + appear. The same for %update.modtimers%, %update.deltimers% and %update.newevents% for the list of changed or deleted timers and event announcements. - "timer" the description of one timer and "event" with the description of - one event. This section is used to display one timer within a timer list, + one event. This section is used to display one timer within a timer list, e.g. in %update.newtimers%. The same for "event". All sections are optional, e.g. if you don't use event announcements you @@ -833,7 +833,7 @@ The following variables can be used in the section <mailbody>: displayed as defined in the section '<timer>' - %update.countnewtimers% - the number of new timers - %update.modtimers% - same as %update.newtimers% but for modified - timers. + timers. - %update.countmodtimers% - the number of modified timers - %update.deltimers% - same as %update.newtimers% but for deleted timers. (Note: a deleted timer has eventually @@ -841,7 +841,7 @@ The following variables can be used in the section <mailbody>: within the timer section will be substituted to an empty string.) - %update.countdeltimers% - the number of deleted timers - - %update.newevents% - will be replaced with the list of events to + - %update.newevents% - will be replaced with the list of events to announce. These events are the search result of search timers with the action "announce by mail". The events are displayed as defined in the section @@ -858,7 +858,7 @@ The following variables can be used in the section <timer>: - %timer.start% - start time of the timer - %timer.stop% - stop time of the timer - %timer.file% - recording directory of the timer - - %timer.chnr% - channel number + - %timer.chnr% - channel number - %timer.chsh% - short channel name - %timer.chlng% - channel name - %timer.search% - name of the search timer, that created the timer @@ -913,7 +913,7 @@ epgsearch supports a configuration mechanism well-known in linux. The settings o - epgsearchmenu.conf - epgsearchcats.conf -can also be given in a file with arbitrary name in the subdirectory conf.d in +can also be given in a file with arbitrary name in the subdirectory conf.d in <plugin-configuration-directory>/epgsearch. This allows one to quickly test different setups only by exchanging files instead of editing them. The format of these files is @@ -934,8 +934,8 @@ where <section_name> is one of the following: The <settings> format follows the one in the corresponding configuration file. Comments beginning with # are allowed, also blank lines. -At startup epgsearch first reads its 'regular' configuration files and then the conf.d subdirectory. -It's allowed to overwrite variables already defined in other files (although this is signaled with a warning in +At startup epgsearch first reads its 'regular' configuration files and then the conf.d subdirectory. +It's allowed to overwrite variables already defined in other files (although this is signaled with a warning in epgsearch's log file.). @@ -949,7 +949,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearch.conf.5.txt b/doc-src/en/epgsearch.conf.5.txt index 71dac43..7099860 100644 --- a/doc-src/en/epgsearch.conf.5.txt +++ b/doc-src/en/epgsearch.conf.5.txt @@ -20,7 +20,7 @@ is B<':'>: 4 - start time in HHMM 5 - stop time in HHMM 6 - use channel? 0 = no, 1 = Interval, 2 = Channel group, 3 = FTA only - 7 - if 'use channel' = 1 then channel id[|channel id] in VDR format, + 7 - if 'use channel' = 1 then channel id[|channel id] in VDR format, one entry or min/max entry separated with |, if 'use channel' = 2 then the channel group name 8 - match case? 0/1 @@ -30,17 +30,17 @@ is B<':'>: must exist as substrings. 2 - at least one term (delimiters are blank, ',', ';', '|' or '~') must exist as substring. - 3 - matches exactly + 3 - matches exactly 4 - regular expression - 10 - use title? 0/1 - 11 - use subtitle? 0/1 + 10 - use title? 0/1 + 11 - use subtitle? 0/1 12 - use description? 0/1 13 - use duration? 0/1 - 14 - min duration in hhmm - 15 - max duration in hhmm + 14 - min duration in hhmm + 15 - max duration in hhmm 16 - use as search timer? 0/1 17 - use day of week? 0/1 - 18 - day of week (0 = Sunday, 1 = Monday...; + 18 - day of week (0 = Sunday, 1 = Monday...; -1 Sunday, -2 Monday, -4 Tuesday, ...; -7 Sun, Mon, Tue) 19 - use series recording? 0/1 20 - directory for recording @@ -64,12 +64,12 @@ is B<':'>: (a ':' will be translated to "!^colon^!", e.g. in "16:9") 29 - avoid repeats? 0/1 30 - allowed repeats - 31 - compare title when testing for a repeat? 0/1 + 31 - compare title when testing for a repeat? 0/1 32 - compare subtitle when testing for a repeat? 0/1/2 0 - no 1 - yes - 2 - yes, if present - 33 - compare description when testing for a repeat? 0/1 + 2 - yes, if present + 33 - compare description when testing for a repeat? 0/1 34 - compare extended EPG info when testing for a repeat? This entry is a bit field of the category IDs. 35 - accepts repeats only within x days @@ -94,7 +94,7 @@ is B<':'>: 52 - percentage of match when comparing the summary of two events (with 'avoid repeats') 53 - HEX representation of the content descriptors, each descriptor ID is represented with 2 chars 54 - compare date when testing for a repeat? (0=no, 1=same day, 2=same week, 3=same month) - + A ':' in the search term or the directory entry will be translated in a '|'. If a '|' exists in the search term, e.g. when using regular expressions, it will be translated to "!^pipe^!" (I know it's ugly ;-)) @@ -118,7 +118,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchblacklists.conf.5.txt b/doc-src/en/epgsearchblacklists.conf.5.txt index 859918b..9127378 100644 --- a/doc-src/en/epgsearchblacklists.conf.5.txt +++ b/doc-src/en/epgsearchblacklists.conf.5.txt @@ -24,7 +24,7 @@ against "Damme". If so, the result will be dismissed. =head1 SYNTAX -This file uses the same syntax as F<epgsearch.conf> except that theres no <use as searchtimer> field. +This file uses the same syntax as F<epgsearch.conf> except that theres no <use as searchtimer> field. So there's a shift by one field from this position. Because that, see C<epgsearch.conf(5)>. =head1 SEE ALSO @@ -37,7 +37,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchcats.conf.5.txt b/doc-src/en/epgsearchcats.conf.5.txt index 3877e12..5b4f2f5 100644 --- a/doc-src/en/epgsearchcats.conf.5.txt +++ b/doc-src/en/epgsearchcats.conf.5.txt @@ -19,14 +19,14 @@ filename epgsearchcats.conf and then have a look to the search timers edit menu (after a restart of VDR). Since setting up a new F<epgsearchcats.conf> is a lot of work, I've added -a small tool 'createcats', that makes the biggest part of the job. It -should have been compiled with the plugin and exists in the sources +a small tool 'createcats', that makes the biggest part of the job. It +should have been compiled with the plugin and exists in the sources directory. See C<createcats(1)> for information about how to use it. B<Internals:> epgsearch scans the summary of an event for the category -name followed by ': ' for all categories that have a corresponding +name followed by ': ' for all categories that have a corresponding value set in the search timer. The search is case sensitive regarding the category name as also the value. @@ -38,13 +38,13 @@ the category name as also the value. (changing the id later on will force you to re-edit your search timers!) - 'category name' is the name as delivered by the EPG provider, e.g. 'Genre' - 'name in menu' is the name displayed in epgsearch. - - 'values' is an optional list of possible values + - 'values' is an optional list of possible values - 'searchmode' specifies the search mode: text comparison: 0 - the whole term must appear as substring 1 - all single terms (delimiters are ',', ';', '|' or '~') must exist as substrings. This is the default search mode. - 2 - at least one term (delimiters are ',', ';', '|' or '~') + 2 - at least one term (delimiters are ',', ';', '|' or '~') must exist as substring. 3 - matches exactly 4 - regular expression @@ -54,7 +54,7 @@ the category name as also the value. 12 - greater 13 - greater or equal 14 - equal - 15 - not equal + 15 - not equal =head1 EXAMPLE @@ -98,7 +98,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchchangrps.conf.5.txt b/doc-src/en/epgsearchchangrps.conf.5.txt index cf3ae25..b314dee 100644 --- a/doc-src/en/epgsearchchangrps.conf.5.txt +++ b/doc-src/en/epgsearchchangrps.conf.5.txt @@ -31,7 +31,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchdirs.conf.5.txt b/doc-src/en/epgsearchdirs.conf.5.txt index 6cf79af..5ce296d 100644 --- a/doc-src/en/epgsearchdirs.conf.5.txt +++ b/doc-src/en/epgsearchdirs.conf.5.txt @@ -23,7 +23,7 @@ like '%genre%', these entries are always shown before any other directories. They are also not level dependent, but are always shown with their full directory. -If this menu is called from the timer edit menu and an item is +If this menu is called from the timer edit menu and an item is selected that contains the variables "%title%" or "%subtitle" then the 'file' item of the timer gets cleared, since title or subtitle already exist in the 'directory' item. @@ -69,7 +69,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchmenu.conf.5.txt b/doc-src/en/epgsearchmenu.conf.5.txt index f200c6a..fb0170c 100644 --- a/doc-src/en/epgsearchmenu.conf.5.txt +++ b/doc-src/en/epgsearchmenu.conf.5.txt @@ -20,7 +20,7 @@ Favorites) with a separate line. =head1 SYNTAX -E.g. the entry 'MenuWhatsOnNow' tells epgsearch how you would like to build a +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") @@ -46,13 +46,13 @@ default one. The following variables exist: - %time% - start time in format HH:MM + %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 + %title% - title %subtitle% - subtitle %t_status% - timer status ('T', 't', 'R') %v_status% - VPS status @@ -77,8 +77,8 @@ 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 +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 @@ -110,7 +110,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchswitchtimers.conf.5.txt b/doc-src/en/epgsearchswitchtimers.conf.5.txt index bf85de4..8dbe038 100644 --- a/doc-src/en/epgsearchswitchtimers.conf.5.txt +++ b/doc-src/en/epgsearchswitchtimers.conf.5.txt @@ -38,7 +38,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchtemplates.conf.5.txt b/doc-src/en/epgsearchtemplates.conf.5.txt index b796abc..189e3b2 100644 --- a/doc-src/en/epgsearchtemplates.conf.5.txt +++ b/doc-src/en/epgsearchtemplates.conf.5.txt @@ -25,7 +25,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/epgsearchuservars.conf.5.txt b/doc-src/en/epgsearchuservars.conf.5.txt index ce0827d..4ab65eb 100644 --- a/doc-src/en/epgsearchuservars.conf.5.txt +++ b/doc-src/en/epgsearchuservars.conf.5.txt @@ -95,7 +95,7 @@ The following variables exist: %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. + %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 @@ -126,7 +126,7 @@ See also C<epgsearchcats.conf(5)>. =head1 EXAMPLES - # Weekday, Date, Time + # Weekday, Date, Time %DateStr%=%time_w% %date% %time% # Themes or Subtitle or Date @@ -147,7 +147,7 @@ Mike Constabel <epgsearch (at) constabel (dot) net> =head1 REPORT BUGS -Bug reports (german): +Bug reports (german): L<http://www.vdr-developer.org/mantisbt/> diff --git a/doc-src/en/noannounce.conf.5.txt b/doc-src/en/noannounce.conf.5.txt index 2df5341..02ace85 100644 --- a/doc-src/en/noannounce.conf.5.txt +++ b/doc-src/en/noannounce.conf.5.txt @@ -12,7 +12,7 @@ If the user presses one of the keys 'Ok', '0', ... '9' while the announcement of an event is displayed, he will be asked if further announcements of this event should be disabled for ever (user hit '0' or 'Ok') or for the next 'x' days (user hit '1' to '9'). After pressing 'Ok' again, this setting will be -stored. +stored. =head1 FORMAT |