summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README164
1 files changed, 110 insertions, 54 deletions
diff --git a/README b/README
index da47e15..0572f4c 100644
--- a/README
+++ b/README
@@ -37,9 +37,14 @@ SKINENIGMA_NO_MENULOGO = 1
This turns usage of logos in the main menu complete. This might also
improve the performance of the menus. EXPERIMENTAL!!!
-SKINENIGMA_FULL_CHANNELINFO_TITLE = 1
-If set the top and bottom borders are drawn around the channel logo
-in the channel info. TEMPORARY OPTION?!?
+HAVE_IMAGEMAGICK = 1
+If you have installed ImageMagick and want to use images in event's
+and recording's details.
+
+SKINENIGMA_USE_PLUGIN_MAILBOX = 1
+If you use the mailbox plugin this will include support for it.
+NOTE: this can also be defined if you don't know if the mailbox
+plugin will be used because it has no compile time requirements.
Patches
@@ -86,8 +91,11 @@ some things before:
Options
-------
- -l path, --logodir=path
- Path to the logos.
+ -l path, --logodir=path
+ Path to the logos (Default: <vdrconfdir>/skinenigmang).
+
+ -i path, --epgimages=path
+ Path to the epgimages (Default: <logodir>/epgimages).
Usage
@@ -101,38 +109,56 @@ Setup Options
- One area (if possible)
If you don't want to use a single 8bpp area for the OSD you can disable
- it here. If this option is enabled this will not ensure that a single
- area is used, but EnigmaNG will try to use it. If your output deviice
- can handle that area (e.g. softdevice) it will be used. Otherwise multiple
- areas are used.
- This option might be useful for 4MB modded DVB cards because they say they
- can handle the 8bpp single area but the OSD will be slower. If you own such
- a card you may want to play with that option and see if you can increase
- OSD speed.
- NOTE: after commit the settings you have to fully close and re-open the OSD
- to make the change affect.
+ it here. If this option is enabled this will not ensure that a single
+ area is used, but EnigmaNG will try to use it. If your output deviice
+ can handle that area (e.g. softdevice) it will be used. Otherwise multiple
+ areas are used.
+ This option might be useful for 4MB modded DVB cards because they say they
+ can handle the 8bpp single area but the OSD will be slower. If you own such
+ a card you may want to play with that option and see if you can increase
+ OSD speed.
+ NOTE: after commit the settings you have to fully close and re-open the OSD
+ to make the change affect.
- Bpp in single area (4/8)
The number of bpp (bit per pixel) to use for the single area.
- 4bpp means upto 16 colors, 8bpp means upto 256 colors.
- NOTE: if this is set to 4bpp you should also disable "Show symbols" because
- otherwise a palette overflow is very likely.
+ 4bpp means upto 16 colors, 8bpp means upto 256 colors.
+ NOTE: if this is set to 4bpp this will disable all symbols/logos/images/flags.
- Show info area in main menu
This info area is shown in the main menu and it will show the current/next
- timers and the number of timer conflicts (if SKINENIGMA_HAVE_EPGSEARCH has been defined).
+ timers and the number of timer conflicts (if SKINENIGMA_HAVE_EPGSEARCH has
+ been defined).
- Show auxiliary information (top/bottom)
Here you can set where you want to have the auxiliary information
- when you open an event's or recording's info screen. This information
- includes for a recording its channel, size, priority, lifetime, audio
- languages and some values that selected plugins (epgsearch, VDRAdmin-AM,
- pin) have set. For an event the audio languages are shown.
+ when you open an event's or recording's info screen. This information
+ includes for a recording its channel, size, priority, lifetime, audio
+ languages and some values that selected plugins (epgsearch, VDRAdmin-AM,
+ pin) have set. For an event the audio languages are shown.
+
+- Show recording's size (never/use size.vdr only/always)
+ This setting controls if a recording's size is shown in the recording's
+ details.
+ never - never show the size
+ use size.vdr only - only show the size if size.vdr exists in the
+ recording's directory. The first line of size.vdr is
+ read and has to be the recording's size in megabytes
+ (MB). You can create size.vdr by adding a line like
+ du -sm | cut -f1 >"$2/size.vdr"
+ to your VDR's recording script's "after" and "edited"
+ sections.
+ always - This will also use size.vdr if available. Otherwise
+ it will calculate the size itself.
+
+- Full title width
+ If enabled the titlebar in the channel info will be drawn above the channel
+ logo. This has no effect if channel logos are disabled.
- Show remaining/elapsed time (elapsed/remaining/percent)
Here you can set if you want to read the number of minutes an event is
- already running (preceded by "+") or the number of minutes an event will
- run (preceded by "-") or the percent the event has been running in the
+ already running (preceded by "+") or the number of minutes an event will
+ run (preceded by "-") or the percent the event has been running in the
channel info.
- Show VPS
@@ -140,14 +166,14 @@ Setup Options
- Show progressbar
This replaces progressbars shown with pipes (e.g. [|| ]) by a graphical
- progressbar.
+ progressbar.
* Logos & Symbols
- Show symbols (never/always/not in menu/only in menu)
Here you can enable or disable the large symbols shown in top right corner
- of the main menu, the recordings info and the event info and the "background"
- symbol of the mode symbol when replaying recordings.
+ of the main menu, the recordings info and the event info and the "background"
+ symbol of the mode symbol when replaying recordings.
Possible options:
never - don't show them anywhere
always - show them everywhere
@@ -163,38 +189,66 @@ Setup Options
- Show flags
If enabled graphical flags are drawn for the audio channel languages if the
requested flag file exists. Else language's abbreviation is drawn.
-
+
+- Show mail icon (never/only if new mail present/always)
+ Enables mail icon in channel info.
+
+- Show event/recording images
+ Enable or disable images in the right top corner in an event's or recording's
+ info. The recording's image must be named "Cover-Enigma.xpm" in the recording's
+ directory. An event's image must be named "<eventid>.xpm" and must be stored in
+ the directory given with the "--epgimages" option.
+ If imagemagick support is compiled in you can use different image extensions,
+ see below.
+
+- Resize images (pixel algo/ratio algo/zoom image)
+ (NOTE: only visible if Imagemagick support is compiled in!)
+ The algorithm to use for resizing. Please ask the Imagemagick documentation if
+ you want to know how the algorithms work.
+
+- Image width (80 - 180)
+ (NOTE: only visible if Imagemagick support is compiled in!)
+ The width for event/recording images.
+
+- Image height (80 - 144)
+ (NOTE: only visible if Imagemagick support is compiled in!)
+ The height for event/recording images.
+
+- Image format (xpm/jpg/png)
+ (NOTE: only visible if Imagemagick support is compiled in!)
+ The extension to use for event/recording images.
+
- Show channel logos
Hide or show channel logos in channel info.
- Identify channel by (name/data)
Here you can choose if the channel logo should be searched by the channel's
- name (e.g. "YLETV2" -> "YLETV2.xpm") or by the channel's unique id (e.g.
- "T-8438-4097-33.xpm").
- NOTE: the available logo packs are named by channel name only!
+ name (e.g. "YLETV2" -> "YLETV2.xpm") or by the channel's unique id (e.g.
+ "T-8438-4097-33.xpm").
+ NOTE: the available logo packs are named by channel name only!
- Channel logo cache size
The number of logos/symbols to keep in the cache.
-* EPGSearch
+* EPGSearch (NOTE: only visible if epgsearch support is compiled in)
- Number of Reruns (0 - 10)
The number of reruns to show in an event's info.
- Use Subtitle for reruns (never/if exists/always)
If set to "never" all events will match that _contain_ the current event's
- title in their title, e.g. if title is "Brisant" it will also find
- "Brisant Classix".
- If set to "if exists" it will use the subtitle to find reruns if the
- current event contains a subtitle. This will also require a full title match,
- e.g. if title is "Brisant" and subtitle is "Boulevard Magazin" it will find
- only events with title and subtitle beeing exactly "Brisant" and "Boulevard
- Magazin". It won't find events named "Brisant Classix" or "Brisant" without
- subtitle.
- If set to "always" it will always use the subtitle even if it's empty. As a
- sideeffect also the event titles must match exactly, e.g. if title is
- "Tagesschau" it will only find events named "Tagesschau" and not "Tagesschau
- vor 30 Jahren".
+ title in their title, e.g. if title is "Brisant" it will also find
+ "Brisant Classix".
+ If set to "if exists" it will use the subtitle to find reruns if the
+ current event contains a subtitle. This will also require a full title match,
+ e.g. if title is "Brisant" and subtitle is "Boulevard Magazin" it will find
+ only events with title and subtitle beeing exactly "Brisant" and "Boulevard
+ Magazin". It won't find events named "Brisant Classix" or "Brisant" without
+ subtitle.
+ If set to "always" it will always use the subtitle even if it's empty. As a
+ sideeffect also the event titles must match exactly, e.g. if title is
+ "Tagesschau" it will only find events named "Tagesschau" and not "Tagesschau
+ vor 30 Jahren".
- Show timer conflicts
Enable or disable showing the number of timer conflicts in the main menu's
@@ -215,11 +269,12 @@ Credits
-------
- Rolf Ahrenberg for the Soppalusikka skin where I've lent some code.
- http://www.saunalahti.fi/~rahrenbe/vdr/soppalusikka/
+ http://www.saunalahti.fi/~rahrenbe/vdr/soppalusikka/
- Andreas Burger for the original "Enigma" for Text2Skin and his Text2Skin patches.
http://brougs78.vdr-developer.org/
- http://www.vdr-portal.de/board/thread.php?threadid=28730
+ http://www.vdr-portal.de/board/thread.php?threadid=28730
+ http://www.vdr-wiki.de/wiki/index.php/Entwicklung_-_Tipps_und_Tricks
- Sascha Volkenandt for Text2Skin where I've lent some code.
http://linux.kompiliert.net/
@@ -228,20 +283,21 @@ Credits
http://www.speedbomb.de/hobby/myhtpc/index.php?view=logos
- zulu @vdr-portal.de for some symbols.
- http://www.vdr-portal.de/board/thread.php?postid=514251#post514251
+ http://www.vdr-portal.de/board/thread.php?postid=514251#post514251
- Thomas @vdr-portal.de for some logos.
- http://senderlogos.vdr-developer.org/
+ http://senderlogos.vdr-developer.org/
- FrankJepsen @vdr-portal.de for some logos.
- http://www.vdr-portal.de/board/thread.php?postid=531412#post531412
+ http://www.vdr-portal.de/board/thread.php?postid=531412#post531412
- chrisz @vdr-portal.de for some radio logos and original Enigma themes.
- WomensLike: http://www.vdr-portal.de/board/thread.php?threadid=59651
- WineRed: http://www.vdr-portal.de/board/thread.php?threadid=59416
- AppleGreen: http://www.vdr-portal.de/board/thread.php?threadid=59427
- YellowSun: http://www.vdr-portal.de/board/thread.php?postid=581117
+ WomensLike: http://www.vdr-portal.de/board/thread.php?threadid=59651
+ WineRed: http://www.vdr-portal.de/board/thread.php?threadid=59416
+ AppleGreen: http://www.vdr-portal.de/board/thread.php?threadid=59427
+ YellowSun: http://www.vdr-portal.de/board/thread.php?postid=581117
- skiller2k1 @vdr-portal.de for Comedy Central logo.
http://www.vdr-portal.de/board/thread.php?postid=567887#post567887
+// vim:et:sw=2:ts=2: