+
+ unforwarded_mails (maildir) (interval)
+ Number of mails not marked as forwarded in the specified mailbox
+ or mail spool if not. Only maildir type mailboxes are supported,
+ mbox type will return -1.
+
+
+ unreplied_mails (maildir) (interval)
+ Number of mails not marked as replied in the specified mailbox
+ or mail spool if not. Only maildir type mailboxes are supported,
+ mbox type will return -1.
+
+
+ unseen_mails (maildir) (interval)
+ Number of new or unseen mails in the specified mailbox or mail
+ spool if not. Only maildir type mailboxes are supported, mbox
+ type will return -1.
+
+
+ updates Number of updates
+ for debugging
+
+
+ upspeed (net)
+ Upload speed in suitable IEC units
+
+
+ upspeedf (net)
+ Upload speed in KiB with one decimal
+
+
+ upspeedgraph (netdev) (height),(width) (gradient colour 1) (gradient
+ colour 2) (scale) (-t) (-l)
+ Upload speed graph, colours defined in hex, minus the #. If
+ scale is non-zero, it becomes the scale for the graph. Uses a
+ logarithmic scale (to see small numbers) when you use the -l
+ switch. Takes the switch '-t' to use a temperature gradient,
+ which makes the gradient values change depending on the ampli-
+ tude of a particular graph value (try it and see).
+
+
+ uptime Uptime
+
+
+ uptime_short
+ Uptime in a shorter format
+
+
+ user_names
+ Lists the names of the users logged in
+
+
+ user_number
+ Number of users logged in
+
+
+ user_terms
+ Lists the consoles in use
+
+
+ user_times
+ Lists how long users have been logged in for
+
+
+ user_time console
+ Lists how long the user for the given console has been logged in
+ for
+
+
+ utime (format)
+ Display time in UTC (universal coordinate time).
+
+
+ voffset (pixels)
+ Change vertical offset by N pixels. Negative values will cause
+ text to overlap. See also $offset.
+
+
+ voltage_mv (n)
+ Returns CPU #n's voltage in mV. CPUs are counted from 1. If
+ omitted, the parameter defaults to 1.
+
+
+ voltage_v (n)
+ Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
+ ted, the parameter defaults to 1.
+
+
+ weather URI locID data_type (interval_in_minutes)
+ Download, parse and display METAR data.
+
+ For the 'URI', there are two possibilities:
+
+ http://weather.noaa.gov/pub/data/observations/metar/stations/
+ http://xoap.weather.com/weather/local/
+
+ The first one is free to use but the second requires you to reg-
+ ister 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.
+
+ 'locID' must be a valid location identifier for the required
+ uri. For the NOAA site this must be a valid ICAO (see for in-
+ stance https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
+ weather.com site this must be a valid location ID (see for in-
+ stance http://aspnetresources.com/tools/locid.aspx).
+
+ 'data_type' must be one of the following:
+
+ last_update The date and time stamp of the data. The result de-
+ pends 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.
+ temperature
+
+ Air temperature (you can use the 'temperature_unit' config set-
+ ting to change units)
+ cloud_cover
+
+ The highest cloud cover status
+ pressure
+
+ Air pressure in millibar
+ wind_speed
+
+ Wind speed in km/h
+ wind_dir
+
+ Wind direction
+ wind_dir_DEG
+
+ Compass wind direction
+ humidity
+
+ Relative humidity in %
+ weather
+
+ Any relevant weather event (rain, snow, etc.). This is not used
+ if you are querying the weather.com site since this data is ag-
+ gregated into the cloud_cover one
+ icon
+
+ Weather icon (only for www.weather.com). Can be used together
+ with the icon kit provided upon registering to their service.
+
+ 'delay_in_minutes' (optional, default 30) cannot be less than 30
+ minutes.
+
+ This object is threaded, and once a thread is created it can't
+ be explicitly destroyed. One thread will run for each URI speci-
+ fied.
+
+ Note that these variables are still EXPERIMENTAL and can be sub-
+ ject to many future changes.
+
+ weather_forecast URI locID day data_type (interval_in_minutes)
+ Download, parse and display weather forecast data for a given
+ day (daytime only).
+
+ For the 'URI', for the time being only http://xoap.weath-
+ er.com/weather/local/ is supported. See 'weather' above for de-
+ tails of usage
+
+ 'locID', see 'weather' above.
+
+ 'day' is a number from 0 (today) to 4 (3 days after tomorrow).
+
+ 'data_type' must be one of the following:
+
+ day Day of the week
+ date Date, in the form MMM DD (ie. Jul 14)
+ low Minimun temperature (you can use the 'temperature_unit' con-
+ fig setting to change units)
+ hi Maximum temperature (you can use the 'temperature_unit' con-
+ fig setting to change units)
+ icon Weather icon. Can be used together with the icon kit pro-
+ vided upon registering to the weather.com service
+ forecast Weather forecast (sunny, rainy, etc.)
+ wind_speed Wind speed in km/h
+ wind_dir Wind direction
+ wind_dir_DEG Compass wind direction
+ humidity Relative humidity in %
+ precipitation Probability of having a precipitation (in %)
+
+ 'delay_in_minutes' (optional, default 210) cannot be lower than
+ 210 min.
+
+ This object is threaded, and once a thread is created it can't
+ be explicitly destroyed. One thread will run for each URI speci-
+ fied. You can use any protocol that Curl supports.
+
+ Note that these variables are still EXPERIMENTAL and can be sub-
+ ject to many future changes.
+
+ wireless_ap (net)
+ Wireless access point MAC address (Linux only)
+
+
+ wireless_bitrate (net)
+ Wireless bitrate (ie 11 Mb/s) (Linux only)
+
+
+ wireless_essid (net)
+ Wireless access point ESSID (Linux only)
+
+
+ wireless_link_bar (height),(width) (net)
+ Wireless link quality bar (Linux only)
+
+
+ wireless_link_qual (net)
+ Wireless link quality (Linux only)
+
+
+ wireless_link_qual_max (net)
+ Wireless link quality maximum value (Linux only)
+
+
+ wireless_link_qual_perc (net)
+ Wireless link quality in percents (Linux only)
+
+
+ wireless_mode (net)
+ Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
+
+
+ words textfile
+ Displays the number of words in the given file
+
+
+ xmms2_album
+ Album in current XMMS2 song
+
+
+ xmms2_artist
+ Artist in current XMMS2 song
+
+
+ xmms2_bar (height),(width)
+ Bar of XMMS2's progress
+
+
+ xmms2_bitrate
+ Bitrate of current song
+
+
+ xmms2_comment
+ Comment in current XMMS2 song
+
+
+ xmms2_date
+ Returns song's date.
+
+
+ xmms2_duration
+ Duration of current song
+
+
+ xmms2_elapsed
+ Song's elapsed time
+
+
+ xmms2_genre
+ Genre in current XMMS2 song
+
+
+ xmms2_id
+ XMMS2 id of current song
+
+
+ xmms2_percent
+ Percent of song's progress
+
+
+ xmms2_playlist
+ Returns the XMMS2 playlist.
+
+
+ xmms2_size
+ Size of current song
+
+
+ xmms2_smart
+ Prints the song name in either the form "artist - title" or file
+ name, depending on whats available
+
+
+ xmms2_status
+ XMMS2 status (Playing, Paused, Stopped, or Disconnected)
+
+
+ xmms2_timesplayed
+ Number of times a song was played (presumably).
+
+
+ xmms2_title
+ Title in current XMMS2 song
+
+
+ xmms2_tracknr
+ Track number in current XMMS2 song
+
+
+ xmms2_url
+ Full path to current song
+
+
+LUA API
+ Conky features a Lua Programming API, and also ships with Lua bindings
+ for some useful libraries. Conky defines certain global functions and
+ variables which can be accessed from Lua code running in Conky.
+
+ To use Lua Conky, you first need to make sure you have a version of
+ Conky with Lua support enabled (``conky -v'' will report this). Scripts
+ must first be loaded using the lua_load configuration option. You then
+ call functions in Lua via Conky's $lua, $lua_read, and Lua hooks.
+
+ Be careful when creating threaded objects through the Lua API. You
+ could wind up with a whole bunch of threads running if a thread is cre-
+ ated with each iteration.
+
+ At this time, the Lua API should not be considered stable and may
+ change drastically from one release to another as it matures.
+
+ NOTE: In order to accommodate certain features in the cairo library's
+ API, Conky will export a few additional functions for the creation of
+ certain structures. These are documented below.
+
+ conky_parse(string) function
+ This function takes a string that is evaluated as per Conky's
+ TEXT section, and then returns a string with the result.
+
+ conky_set_update_interval(number) function
+ Sets Conky's update interval (in seconds) to 'number'.
+
+ conky_window table
+ This table contains some information about Conky's window. The
+ following table describes the values contained:
+
+ drawable Window's drawable (Xlib Drawable), requires Lua extras
+ enabled at compile time.
+ visual Window's visual (Xlib Visual), requires Lua extras en-
+ abled at compile time.
+ display Window's display (Xlib Display), requires Lua extras en-
+ abled at compile time.
+ width Window width (in pixels).
+ height Window height (in pixels).
+ border_inner_margin Window's inner border margin (in pixels).
+ border_outer_margin Window's outer border margin (in pixels).
+ border_width Window's border width (in pixels).
+ text_start_x The x component of the starting coordinate of text
+ drawing.
+ text_start_y The y component of the starting coordinate of text
+ drawing.
+ text_width The width of the text drawing region.
+ text_height The height of the text drawing region.
+
+ NOTE: This table is only defined when X support is enabled.
+
+ conky_info table
+ This table contains some information about Conky's internal da-
+ ta. The following table describes the values contained:
+
+ update_interval Conky's update interval (in seconds).
+ uptime System uptime, in seconds.
+
+ conky_build_info string
+ A string containing the build info for this particular instance
+ of Conky, including the version, build date, and architecture.
+
+ conky_build_date string
+ A string containing the build date for this particular instance
+ of Conky.
+
+ conky_build_arch string
+ A string containing the build architecture for this particular
+ instance of Conky.
+
+ conky_version string
+ A string containing the version of the current instance of
+ Conky.
+
+ conky_config string
+ A string containing the path of the current Conky configuration
+ file.
+
+ cairo_text_extents_t:create() function
+ Call this function to return a new cairo_text_extents_t struc-
+ ture. A creation function for this structure is not provided by
+ the cairo API. After calling this, you should use tolua.takeown-
+ ership() on the return value to ensure ownership is passed prop-
+ erly.
+
+ cairo_font_extents_t:create() function
+ Call this function to return a new cairo_font_extents_t struc-
+ ture. A creation function for this structure is not provided by
+ the cairo API. After calling this, you should use tolua.takeown-
+ ership() on the return value to ensure ownership is passed prop-
+ erly.
+
+ cairo_matrix_t:create() function
+ Call this function to return a new cairo_matrix_t structure. A
+ creation function for this structure is not provided by the
+ cairo API. After calling this, you should use tolua.takeowner-
+ ship() on the return value to ensure ownership is passed proper-
+ ly.
+
+EXAMPLES
+ conky -t '${time %D %H:%M}' -o -u 30
+ Start Conky in its own window with date and clock as text and 30
+ sec update interval.
+
+ conky -a top_left -x 5 -y 500 -d
+ Start Conky to background at coordinates (5, 500).
+
+ conky -C > ~/.conkyrc
+ Do not start Conky, but have it output the builtin default con-
+ fig file to ~/.conkyrc for later customising.
+
+FILES
+ ${sysconfdir}/conky/conky.conf
+ Default system-wide configuration file. The value of
+ ${sysconfdir} depends on the compile-time options (most likely
+ /etc).
+
+ ~/.conkyrc
+ Default personal configuration file.
+
+BUGS
+ Drawing to root or some other desktop window directly doesn't work with
+ all window managers. Especially doesn't work well with Gnome and it has
+ been reported that it doesn't work with KDE either. Nautilus can be
+ disabled from drawing to desktop with program gconf-editor. Uncheck
+ show_desktop in /apps/nautilus/preferences/. There is -w switch in
+ Conky to set some specific window id. You might find xwininfo -tree
+ useful to find the window to draw to. You can also use -o argument