Dear Wiki user, You have subscribed to a wiki page or wiki category on "Freevo Wiki" for change notification.
The following page has been changed by 80.141.69.47: http://freevo.sourceforge.net/cgi-bin/moin.cgi/DocumentationPage_2fPluginInfo ------------------------------------------------------------------------------ @@ -1,14 +1,3 @@ - - -[http://www.cebooks.net books] - -____________________________________________ -+++++++++++++++++++++++++++++++++++++++++++++ -____________________________________________ - - - - '''Index'''[[TableOfContents]] = Writing your own plugins = @@ -58,183 +47,7 @@ == Idle Bar == -This plugin puts a bar at the top of the screen where other plugins can be displayed , like weather, cd status or clock. - -To activate the idle bar, put the following in your '''local_conf.py'''. - -For 1.3.4 (And older); -{{{ -plugin.activate( 'idlebar.interface' ) -}}} - -For 1.4.0 just; -{{{ -plugin.activate( 'idlebar' ) -}}} - - -This activates the bar, but puts nothing in there, so you need to add more plugins. Note that -plugins inside the idlebar are sorted based on the {{{<LEVEL>}}} (except the -clock, it's always on the right side) - -=== Mail === - -This plugin checks for mail in your Unix mailbox. If you use a pop3 or imap email, you have to use something like fetchmail (http://catb.org/~esr/fetchmail/) to download them to your local box. Note that {{{/path/to/your/mailbox}}} generally is {{{/var/spool/mail/<USER>}}}. - -To activate the idle bar mail, put the following in your '''local_conf.py'''. - -Syntax: - -{{{ -plugin.activate('idlebar.mail', level=<LEVEL>, args=('</path/to/your/mailbox>', )) -}}} - -Example: User dmeyer - -{{{ -plugin.activate('idlebar.mail', level=10, args=('/var/spool/mail/dmeyer', )) -}}} - -=== TV === - -This plugin alerts you if you need to download your xmltv again (in case you don't use '''cron''' for that). It's based on {{{listing_threshold}}}, which is the number of hours before your xmltv listing run out when the TV icon will present you a warning. Once your xmltv data is expired, it will present a more severe warning. If no args are given, then no warnings will be given. - -To activate the idle bar tv, put the following in your '''local_conf.py'''. - -Syntax: - -{{{ -plugin.activate( 'idlebar.tv', level=<LEVEL>, args=(<listings_threshold>, ) ) -}}} - -Example: 12 hours before xmltv data expires - -{{{ -plugin.activate( 'idlebar.tv', level=20, args=( 12, ) ) -}}} - - -=== Weather === - -This plugin will show the weather to you as an icon. It's based on your location code (take a look at http://www.nws.noaa.gov/tg/siteloc.shtml to know yours). - -To activate the idle bar weather, put the following in your '''local_conf.py'''. - -Syntax: - -test - -{{{ -plugin.activate( 'idlebar.weather', level=<LEVEL>, args=('<4 letter location code>', ) ) -}}} - -Example: New York City Weather - -{{{ -plugin.activate( 'idlebar.weather', level=30, args=( 'KOKX', ) ) -}}} - -Example: New York City Weather in Fahrenheit - -{{{ -plugin.activate( 'idlebar.weather', level=30, args=( 'KOKX', 'F',) ) -}}} - -Example: New York City Weather in Kelvin - -{{{ -plugin.activate( 'idlebar.weather', level=30, args=( 'KOKX', 'K',) ) -}}} - - -=== Clock === - -This one puts a clock at the right side of the idle bar. - -To activate it, put the following in your '''local_conf.py'''. - -{{{ -plugin.activate( 'idlebar.clock' ) -}}} - -The default display format of the clock is: ''<Abbreviated weekday> <12hour>:<minutes> <AM/PM>''. -If you don't like the format, you can easily change the format by specifing the format as an argument, such as: - -{{{ -plugin.activate( 'idlebar.clock', level=50, args=('%a %H:%M', )) -}}} - -The format is based on the strftime() format ({{{man strftime}}} or http://linux.ctyme.com/userdoc/HTML/en/kdevelop/reference/C/MAN/strftime.htm). - -=== CD Status === - -This plugin will show you the state of all ROM drives avaiable to Freevo. - -To activate the idle bar cd status, put the following in your '''local_conf.py'''. - -{{{ -plugin.activate( 'idlebar.cdstatus' ) -}}} - - -=== Holidays === - -This plugin checks if the current date is a holiday and will -display a user specified icon for that holiday. - -To activate the idle bar holidays, put the following in your '''local_conf.py'''. - -{{{ -plugin.activate( 'idlebar.holidays' ) -}}} - -And you must specify your holidays and their icons in '''local_conf.py''' too. There are some defined dates in freevo_config.py, but you should ''NOT'' alter freevo_config.py, instead you must define your own array in local_conf.py, It should be like: -{{{ -HOLIDAYS = [ ('01-01', 'newyear.png'), - ('02-14', 'valentine.png'), - ('05-07', 'freevo_bday.png'), - ('07-03', 'usa_flag.png'), - ('07-04', 'usa_flag.png'), - ('10-30', 'ghost.png'), - ('10-31', 'pumpkin.png'), - ('12-21', 'snowman.png'), - ('12-25', 'christmas.png') - ] -}}} - -'''PS:''' You must have those icons (ie: newyear.png) in <FREEVO_PATH>/skins/images/holidays/, these listed above are there already, but if you add more holidays (or someone's birthday), you must put the related icons there! - -=== Sensors === - -This plugin can display your cpu and case temperature and ram usage. This requires a properly configured lm_sensors. If the standard sensors frontend delivered with lm_sensors works you're OK. As of release 1.4-rc3, the sensors plugin can also read kernel 2.6 sensors (located in the /sys filesystem). This doesn't require lm_sensors installed, but needs the proper kernel Chip & Bus driver enabled (and loaded if u compiled them as modules). -When one of your temperatures goes over the lm_sensors specified maximum temperature, the font color of all text on the idlebar changes to red, so u'll notice when your freevo box is starting to fry :). If you want to adjust these maximums, have a look at the lm_sensors documentation. The defaults are sane (60�s). - -To activate the idle bar sensors, put the following in your '''local_conf.py'''. -Syntax: - -{{{ -plugin.activate('idlebar.system.sensors', level=40, args=('<cpusensor>', '<casesensor>', '<meminfo>')) -}}} -(note that older versions of Freevo (before 1.4rc-2 ??) use idlebar.sensors instead of idlebar.system.sensors.) - -{{{<cpusensor>}}} and {{{<casesensor>}}} are the corresponding lm_sensors: they should be ''temp1'', ''temp2'' or ''temp3''. The default values are ''temp3'' for {{{<cpusensor>}}} and ''temp2'' for {{{<casesensor>}}}. -You can choose which meminfo you want, the types are the same as in '''/proc/meminfo''' -{{{ -MemTotal , MemFree, MemShared, Buffers, Cached, SwapCached, Active, Inactive, -HighTotal, HighFree, LowTotal, LowFree, SwapTotal and SwapFree -}}} - -The default is: ''{{{MemTotal}}}''. -These names are '''case-sensitive''', so be carefull. - -{{{<casesensor>}}} and {{{<meminfo>}}} arguments can be set to {{{None}}} if you don't want them. {{{<cpusensor>}}} cannot be turned off at the moment. - -Example: CPU is temp3 in lm_sensors, I want no case info and I want to display the free memory ({{{MemFree}}}): - -{{{ -plugin.activate('idlebar.sensors', level=40, args=('temp3', None, 'MemFree')) -}}} - +Everything about idlebar plugins is now in the new wiki: http://freevo.sourceforge.net/cgi-bin/doc/IdlebarPlugins == Icecast == @@ -577,14 +390,7 @@ == Mixer == -Displays the volume level in the idlebar. - -{{{ -plugin.activate('idlebar.volume', level=X) -}}} - -PleaseUpdate: Placeholder (is it mixer, ossmixer, or both?) - +moved to the new wiki: http://freevo.sourceforge.net/cgi-bin/doc/IdlebarPlugins == USB == ------------------------------------------------------- SF email is sponsored by - The IT Product Guide Read honest & candid reviews on hundreds of IT Products from real users. Discover which products truly live up to the hype. Start reading now. http://productguide.itmanagersjournal.com/ _______________________________________________ Freevo-wikilog mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/freevo-wikilog
