</command>
<option>(color)</option>
</term>
- <listitem>Change drawing color to color
+ <listitem>Change drawing color to 'color' which is a name of
+ a color or a hexcode preceded with # (for example #0A1B2C ).
+ If you use ncurses only the following colors are supported:
+ red,green,yellow,blue,magenta,cyan,black,white.
<para /></listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term>
<command>
+ <option>curl</option>
+ </command>
+ <option>url interval_in_minutes</option>
+ </term>
+ <listitem>
+ <para>Download data from URI using Curl at the
+ specified interval. The interval may be a floating
+ point value greater than 0, otherwise defaults to 15
+ minutes. Most useful when used in conjunction with Lua
+ and the Lua API. This object is threaded, and once a
+ thread is created it can't be explicitely destroyed.
+ One thread will run for each URI specified. You can use
+ any protocol that Curl supports.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
<option>desktop</option>
</command>
</term>
- <listitem>Number of the desktop on which conky is running
- or the message "Not running in X" if this is the case.
+ <listitem>Number of the desktop on which conky is running
+ or the message "Not running in X" if this is the case.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>desktop_name</option>
</command>
</term>
- <listitem>Name of the desktop on which conky is running
- or the message "Not running in X" if this is the case.
+ <listitem>Name of the desktop on which conky is running or
+ the message "Not running in X" if this is the case.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>desktop_number</option>
</command>
</term>
- <listitem>Number of desktops or the message "Not running
- in X" if this is the case.
+ <listitem>Number of desktops or the message "Not running in
+ X" if this is the case.
<para /></listitem>
</varlistentry>
<varlistentry>
<command>
<option>head</option>
</command>
- <option>logfile lines (interval)</option>
+ <option>logfile lines (next_check)</option>
</term>
- <listitem>Displays first N lines of supplied text text
- file. If interval is not supplied, Conky assumes 2x Conky's
- interval. Max of 30 lines can be displayed, or until the
- text buffer is filled.
+ <listitem>Displays first N lines of supplied text file. The
+ file is checked every 'next_check' update. If next_check is
+ not supplied, Conky defaults to 2. Max of 30 lines can be
+ displayed, or until the text buffer is filled.
<para /></listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term>
<command>
+ <option>include</option>
+ </command>
+ <option>path</option>
+ </term>
+ <listitem>
+ <para>Loads the configfile at path, places the
+ configsettings behind the configsettings in the orginal
+ config and places the vars where the includevar
+ stood.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
<option>ioscheduler</option>
</command>
<option>disk</option>
</term>
<listitem>Executes a Lua function with given parameters,
then prints the returned string. See also 'lua_load' on how
- to load scripts.
+ to load scripts. Conky puts 'conky_' in front of
+ function_name to prevent accidental calls to the wrong
+ function unless you put you place 'conky_' in front of it
+ yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
</term>
<listitem>Executes a Lua function with given parameters and
draws a bar. Expects result value to be an integer between
- 0 and 100. See also 'lua_load' on how to load scripts.
+ 0 and 100. See also 'lua_load' on how to load scripts.
+ Conky puts 'conky_' in front of function_name to prevent
+ accidental calls to the wrong function unless you put you
+ place 'conky_' in front of it yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Executes a Lua function with given parameters and
draws a gauge. Expects result value to be an integer
between 0 and 100. See also 'lua_load' on how to load
- scripts.
+ scripts. Conky puts 'conky_' in front of function_name to
+ prevent accidental calls to the wrong function unless you
+ put you place 'conky_' in front of it yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
load scripts. Takes the switch '-t' to use a temperature
gradient, which makes the gradient values change depending
on the amplitude of a particular graph value (try it and
- see).
+ see). Conky puts 'conky_' in front of function_name to
+ prevent accidental calls to the wrong function unless you
+ put you place 'conky_' in front of it yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Executes a Lua function with given parameters as
per $lua, then parses and prints the result value as per
the syntax for Conky's TEXT section. See also 'lua_load' on
- how to load scripts.
- <para /></listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <command>
- <option>lua_read_parse</option>
- </command>
- <option />
- </term>
- <listitem>This function is deprecated. Please use the
- conky_parse() Lua function instead.
+ how to load scripts. Conky puts 'conky_' in front of
+ function_name to prevent accidental calls to the wrong
+ function unless you put you place 'conky_' in front of it
+ yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>monitor</option>
</command>
</term>
- <listitem>Number of the monitor on which conky is running
- or the message "Not running in X" if this is the case.
+ <listitem>Number of the monitor on which conky is running
+ or the message "Not running in X" if this is the case.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>monitor_number</option>
</command>
</term>
- <listitem>Number of monitors or the message "Not running
- in X" if this is the case.
+ <listitem>Number of monitors or the message "Not running in
+ X" if this is the case.
<para /></listitem>
</varlistentry>
<varlistentry>
<command>
<option>rss</option>
</command>
- <option>url delay_in_minutes action (num_par
+ <option>uri interval_in_minutes action (num_par
(spaces_in_front))</option>
</term>
- <listitem>Download and parse RSS feeds. Action may be one
- of the following: feed_title, item_title (with num par),
- item_desc (with num par) and item_titles (when using this
- action and spaces_in_front is given conky places that many
- spaces in front of each item).
- <para /></listitem>
+ <listitem>
+ <para>Download and parse RSS feeds. The interval may be
+ a floating point value greater than 0, otherwise
+ defaults to 15 minutes. Action may be one of the
+ following: feed_title, item_title (with num par),
+ item_desc (with num par) and item_titles (when using
+ this action and spaces_in_front is given conky places
+ that many spaces in front of each item). This object is
+ threaded, and once a thread is created it can't be
+ explicitely destroyed. One thread will run for each URI
+ specified. You can use any protocol that Curl
+ supports.</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term>
may also contain variables. 'step' is optional and defaults
to 1 if not set. If a var creates output on multiple lines
then the lines are placed behind each other separated with
- a '|'-sign. Do NOT use vars that change colors or otherwise
- affect the design inside a scrolling text. If you want
- spaces between the start and the end of 'text', place them
- at the end of 'text' not at the front ("foobar" and "
- foobar" can both generate "barfoo" but "foobar " will keep
- the spaces like this "bar foo").
+ a '|'-sign. If you change the textcolor inside $scroll it
+ will automatically have it's old value back at the end of
+ $scroll. The end and the start of text will be seperated by
+ 'length' number of spaces.
<para /></listitem>
</varlistentry>
<varlistentry>
<command>
<option>tail</option>
</command>
- <option>logfile lines (interval)</option>
+ <option>logfile lines (next_check)</option>
</term>
- <listitem>Displays last N lines of supplied text text file.
- If interval is not supplied, Conky assumes 2x Conky's
- interval. Max of 30 lines can be displayed, or until the
- text buffer is filled.
+ <listitem>Displays last N lines of supplied text file. The
+ file is checked every 'next_check' update. If next_check is
+ not supplied, Conky defaults to 2. Max of 30 lines can be
+ displayed, or until the text buffer is filled.
<para /></listitem>
</varlistentry>
<varlistentry>
longer then the time it takes your script to execute. For
example, if you have a script that take 5 seconds to
execute, you should make the interval at least 6 seconds.
- See also $execi.
+ See also $execi. This object will clean up the thread when
+ it is destroyed, so it can safely be used in a nested
+ fashion, though it may not produce the desired behaviour if
+ used this way.
<para /></listitem>
</varlistentry>
<varlistentry>
<command>
<option>weather</option>
</command>
- <option>URI locID data_type (delay_in_minutes)</option>
+ <option>URI locID data_type
+ (interval_in_minutes)</option>
</term>
<listitem>
<para>Download, parse and display METAR data.</para>
- <para>For the 'URI', there are two possibilities:</para>
- <simplelist>
- <member>
- http://weather.noaa.gov/pub/data/observations/metar/stations/
- </member>
- <member>
- http://xoap.weather.com/weather/local/
- </member>
- </simplelist>
- <para>The first one is free to use but the second requires you to
- register and obtain your partner ID and license key.
- These two must be written, separated by a space, into a file
- called .xoaprc which needs to be placed into your home directory.
- </para>
- <para>'locID' must be a valid location identifier for the required
- uri. For the NOAA site this must be a valid ICAO
- (see for instance https://pilotweb.nas.faa.gov/qryhtml/icao/).
- For the weather.com site this must be a valid location ID
- (see for instance http://aspnetresources.com/tools/locid.aspx).
- </para>
+ <para>For the 'URI', there are two
+ possibilities:</para>
+ <simplelist>
+ <member>
+ http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
+ <member>
+ http://xoap.weather.com/weather/local/</member>
+ </simplelist>
+ <para>The first one is free to use but the second
+ requires you to register and obtain your partner ID and
+ license key. These two must be written, separated by a
+ space, into a file called .xoaprc which needs to be
+ placed into your home directory.</para>
+ <para>'locID' must be a valid location identifier for
+ the required uri. For the NOAA site this must be a
+ valid ICAO (see for instance
+ https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
+ weather.com site this must be a valid location ID (see
+ for instance
+ http://aspnetresources.com/tools/locid.aspx).</para>
<para>'data_type' must be one of the following:</para>
<simplelist>
<member>
<command>last_update</command>
- <option>The date and time stamp of the data.
- The result depends on the URI used. For the NOAA site
- it is date (yyyy/mm/dd) and UTC time. For the
- weather.com one it is date ([m]m/[d]d/yy) and Local Time
- of the station.
- </option>
+ <para>The date and time stamp of the data.
+ The result depends on the URI used. For the
+ NOAA site it is date (yyyy/mm/dd) and UTC time.
+ For the weather.com one it is date
+ ([m]m/[d]d/yy) and Local Time of the
+ station.</para>
</member>
<member>
<command>temperature</command>
- <option>Air temperature (you can use the
+ <para>Air temperature (you can use the
'temperature_unit' config setting to change
- units)</option>
+ units)</para>
</member>
<member>
<command>cloud_cover</command>
- <option>The highest cloud cover status</option>
+ <para>The highest cloud cover status</para>
</member>
<member>
<command>pressure</command>
- <option>Air pressure in millibar</option>
+ <para>Air pressure in millibar</para>
</member>
<member>
<command>wind_speed</command>
+ <para>Wind speed in km/h</para>
+ </member>
+ <member>
+ <command>wind_dir</command>
+ <para>Wind direction</para>
+ </member>
+ <member>
+ <command>wind_dir_DEG</command>
+ <para>Compass wind direction</para>
+ </member>
+ <member>
+ <command>humidity</command>
+ <para>Relative humidity in %</para>
+ </member>
+ <member>
+ <command>weather</command>
+ <para>Any relevant weather event (rain, snow,
+ etc.). This is not used if you are querying the
+ weather.com site since this data is aggregated
+ into the cloud_cover one</para>
+ </member>
+ <member>
+ <command>icon</command>
+ <para>Weather icon (only for
+ www.weather.com). Can be used together with the
+ icon kit provided upon registering to their
+ service.</para>
+ </member>
+ </simplelist>
+ <para>'delay_in_minutes' (optional, default 30) cannot
+ be less than 30 minutes.</para>
+ <para>This object is threaded, and once a thread is
+ created it can't be explicitely destroyed. One thread
+ will run for each URI specified.</para>
+ <para>Note that these variables are still EXPERIMENTAL
+ and can be subject to many future changes.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>weather_forecast</option>
+ </command>
+ <option>URI locID day data_type
+ (interval_in_minutes)</option>
+ </term>
+ <listitem>
+ <para>Download, parse and display weather forecast data
+ for a given day (daytime only).</para>
+ <para>For the 'URI', for the time being only
+ http://xoap.weather.com/weather/local/ is
+ supported. See 'weather' above for details of usage</para>
+ <para>'locID', see 'weather' above.</para>
+ <para>'day' is a number from 0 (today) to 4 (3 days
+ after tomorrow).</para>
+ <para>'data_type' must be one of the following:</para>
+ <simplelist>
+ <member>
+ <command>low</command>
+ <option>Minimun temperature (you can use the
+ 'temperature_unit' config setting to change
+ units)</option>
+ </member>
+ <member>
+ <command>high</command>
+ <option>Maximum temperature (you can use the
+ 'temperature_unit' config setting to change
+ units)</option>
+ </member>
+ <member>
+ <command>icon</command>
+ <option>Weather icon. Can be used together with the
+ icon kit provided upon registering to the weather.com
+ service</option>
+ </member>
+ <member>
+ <command>forecast</command>
+ <option>Weather forecast (sunny, rainy, etc.)</option>
+ </member>
+ <member>
+ <command>wind_speed</command>
<option>Wind speed in km/h</option>
</member>
<member>
<option>Relative humidity in %</option>
</member>
<member>
- <command>weather</command>
- <option>Any relevant weather event (rain, snow,
- etc.). This is not used if you are querying the
- weather.com site since this data is aggregated
- into the cloud_cover one</option>
+ <command>precipitation</command>
+ <option>Probability of having a
+ precipitation (in %)</option>
</member>
</simplelist>
- <para>'delay_in_minutes' (optional, default 30) cannot be
- lower than 30 min.</para>
- <para>Note that these variables are still EXPERIMENTAL and
- can be subject to many future changes.</para>
- </listitem>
+ <para>'delay_in_minutes' (optional, default 150) cannot
+ be lower than 150 min.</para>
+ <para>This object is threaded, and once a thread is
+ created it can't be explicitely destroyed. One thread
+ will run for each URI specified. You can use any
+ protocol that Curl supports.</para>
+ <para>Note that these variables are still EXPERIMENTAL
+ and can be subject to many future changes.</para>
+ </listitem>
</varlistentry>
<varlistentry>
<term>
projects / monky / blobdiff