X-Git-Url: http://vcs.maemo.org/git/?a=blobdiff_plain;f=doc%2Fvariables.xml;h=bc5c36cf18f654a13eb2cca0aff8a831738797e1;hb=0c83d64a86fcaf4741f5fdf0013df7f9e48e30ac;hp=a15b8c44c82b5192a07fada97816d07cbe1578bb;hpb=17d531098157b8f962c6936624470065a7f0a960;p=monky
diff --git a/doc/variables.xml b/doc/variables.xml
index a15b8c4..bc5c36c 100644
--- a/doc/variables.xml
+++ b/doc/variables.xml
@@ -4,8 +4,11 @@
+
- ACPI ac adapter state.
+ ACPI ac adapter state. On linux, the adapter option specifies the
+ subfolder of /sys/class/power_supply containing the state information (defaults
+ to "AC"). Other systems ignore it.
@@ -14,7 +17,7 @@
- ACPI fan state
+ ACPI fan state
@@ -23,7 +26,7 @@
- ACPI temperature in C.
+ ACPI temperature in C.
@@ -31,10 +34,10 @@
-
+
IP address for an interface, or "No Address" if
- no address is assigned.
+ no address is assigned.
@@ -42,10 +45,10 @@
-
+
IP addresses for an interface (if one - works
- like addr). Linux only.
+ like addr). Linux only.
@@ -54,7 +57,7 @@
- CPU temperature from therm_adt746x
+ CPU temperature from therm_adt746x
@@ -63,7 +66,7 @@
- Fan speed from therm_adt746x
+ Fan speed from therm_adt746x
@@ -73,7 +76,7 @@
- Align text to centre
+ Align text to centre
@@ -83,7 +86,7 @@
- Right-justify text, with space of N
+ Right-justify text, with space of N
@@ -95,7 +98,7 @@
Sets up the connection to apcupsd daemon. Prints
- nothing, defaults to localhost:3551
+ nothing, defaults to localhost:3551
@@ -104,7 +107,7 @@
- Prints the UPS connection type.
+ Prints the UPS connection type.
@@ -113,7 +116,7 @@
- Current battery capacity in percent.
+ Current battery capacity in percent.
@@ -122,7 +125,7 @@
- Reason for last transfer from line to battery.
+ Reason for last transfer from line to battery.
@@ -131,7 +134,7 @@
- Nominal input voltage.
+ Nominal input voltage.
@@ -140,7 +143,7 @@
- Current load in percent.
+ Current load in percent.
@@ -149,7 +152,7 @@
- Bar showing current load.
+ Bar showing current load.
@@ -159,7 +162,7 @@
- Gauge that shows current load.
+ Gauge that shows current load.
@@ -167,10 +170,10 @@
-
+
- History graph of current load.
+ History graph of current load.
@@ -179,7 +182,7 @@
- Prints the model of the UPS.
+ Prints the model of the UPS.
@@ -188,7 +191,7 @@
- Prints the UPS user-defined name.
+ Prints the UPS user-defined name.
@@ -197,7 +200,7 @@
- Prints current status (on-line, on-battery).
+ Prints current status (on-line, on-battery).
@@ -206,7 +209,7 @@
- Current internal temperature.
+ Current internal temperature.
@@ -215,7 +218,7 @@
- Time left to run on battery.
+ Time left to run on battery.
@@ -224,7 +227,7 @@
- Prints the UPS mode (e.g. standalone).
+ Prints the UPS mode (e.g. standalone).
@@ -233,7 +236,7 @@
- Display APM AC adapter status (FreeBSD only)
+ Display APM AC adapter status (FreeBSD only)
@@ -243,7 +246,7 @@
Display APM battery life in percent (FreeBSD
- only)
+ only)
@@ -254,7 +257,7 @@
Display remaining APM battery life in hh:mm:ss or
"unknown" if AC adapterstatus is on-line or charging
- (FreeBSD only)
+ (FreeBSD only)
@@ -264,7 +267,7 @@
- Progress bar
+ Progress bar
@@ -273,7 +276,7 @@
- Bitrate of current tune
+ Bitrate of current tune
@@ -282,7 +285,7 @@
- Number of audio channels of current tune
+ Number of audio channels of current tune
@@ -291,7 +294,7 @@
- Full path and filename of current tune
+ Full path and filename of current tune
@@ -300,7 +303,7 @@
- Sampling frequency of current tune
+ Sampling frequency of current tune
@@ -309,7 +312,7 @@
- Total length of current tune as MM:SS
+ Total length of current tune as MM:SS
@@ -318,7 +321,7 @@
- Total length of current tune in seconds
+ Total length of current tune in seconds
@@ -327,7 +330,7 @@
- The current volume fetched from Audacious
+ The current volume fetched from Audacious
@@ -336,7 +339,7 @@
- Number of tunes in playlist
+ Number of tunes in playlist
@@ -345,7 +348,7 @@
- Playlist position of current tune
+ Playlist position of current tune
@@ -354,7 +357,7 @@
- Position of current tune (MM:SS)
+ Position of current tune (MM:SS)
@@ -363,7 +366,7 @@
- Position of current tune in seconds
+ Position of current tune in seconds
@@ -373,7 +376,7 @@
Player status (Playing/Paused/Stopped/Not
- running)
+ running)
@@ -384,7 +387,7 @@
Title of current tune with optional maximum
- length specifier
+ length specifier
@@ -396,7 +399,7 @@
Battery status and remaining percentage capacity
of ACPI or APM battery. ACPI battery number can be given as
- argument (default is BAT0).
+ argument (default is BAT0).
@@ -408,7 +411,7 @@
Battery percentage remaining of ACPI battery in a
bar. ACPI battery number can be given as argument (default
- is BAT0).
+ is BAT0).
@@ -420,7 +423,7 @@
Battery percentage remaining for ACPI battery.
ACPI battery number can be given as argument (default is
- BAT0).
+ BAT0).
@@ -433,8 +436,9 @@
Battery status and remaining percentage capacity
of ACPI or APM battery. ACPI battery number can be given as
argument (default is BAT0). This mode display a short
- status, which means that C is displayed instead of charging
- and D is displayed instead of discharging.
+ status, which means that C is displayed instead of
+ charging, D for discharging, F for full, N for not present,
+ E for empty and U for unknown.
@@ -446,7 +450,18 @@
Battery charge/discharge time remaining of ACPI
battery. ACPI battery number can be given as argument
- (default is BAT0).
+ (default is BAT0).
+
+
+
+
+
+
+
+
+
+ Let 'text_and_other_conky_vars' blink on and off.
+
@@ -455,7 +470,7 @@
- Album in current BMPx track
+ Album in current BMPx track
@@ -464,7 +479,7 @@
- Artist in current BMPx track
+ Artist in current BMPx track
@@ -473,7 +488,7 @@
- Bitrate of the current BMPx track
+ Bitrate of the current BMPx track
@@ -482,7 +497,7 @@
- Title of the current BMPx track
+ Title of the current BMPx track
@@ -491,7 +506,7 @@
- Track number of the current BMPx track
+ Track number of the current BMPx track
@@ -500,7 +515,7 @@
- URI of the current BMPx track
+ URI of the current BMPx track
@@ -509,7 +524,7 @@
- Amount of memory buffered
+ Amount of memory buffered
@@ -518,7 +533,18 @@
- Amount of memory cached
+ Amount of memory cached
+
+
+
+
+
+
+
+
+
+ PID of the first process that has string in it's
+ commandline
@@ -528,7 +554,10 @@
- Change drawing color to color
+ 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.
@@ -538,7 +567,7 @@
Change drawing color to colorN configuration
- option, where N is a digit between 0 and 9, inclusively.
+ option, where N is a digit between 0 and 9, inclusively.
@@ -549,12 +578,12 @@
Places the lines of var2 to the right of the
- lines of var1 seperated by the chars that are put between
+ lines of var1 separated by the chars that are put between
var1 and var2. For example: ${combine ${head /proc/cpuinfo
2} - ${head /proc/meminfo 1}} gives as output
"cpuinfo_line1 - meminfo_line1" on line 1 and
"cpuinfo_line2 -" on line 2. $combine vars can also be
- nested to place more vars next to each other.
+ nested to place more vars next to each other.
@@ -563,7 +592,7 @@
- CPU architecture Conky was built for
+ CPU architecture Conky was built for
@@ -572,7 +601,7 @@
- Date Conky was built
+ Date Conky was built
@@ -581,7 +610,7 @@
- Conky version
+ Conky version
@@ -594,7 +623,7 @@
CPU usage in percents. For SMP machines, the CPU
number can be provided as an argument. ${cpu cpu0} is the
total usage, and ${cpu cpuX} (X >= 1) are individual
- CPUs.
+ CPUs.
@@ -605,7 +634,7 @@
Bar that shows CPU usage, height is bar's height
- in pixels. See $cpu for more info on SMP.
+ in pixels. See $cpu for more info on SMP.
@@ -617,7 +646,7 @@
Elliptical gauge that shows CPU usage, height and
width are gauge's vertical and horizontal axis
- respectively. See $cpu for more info on SMP.
+ respectively. See $cpu for more info on SMP.
@@ -625,17 +654,64 @@
-
+
CPU usage graph, with optional colours in hex,
minus the #. See $cpu for more info on SMP. Uses a
- logarithmic scale (to see small numbers) when you use "log"
- instead of "normal". 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).
+ 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 amplitude of a particular graph value (try it and
+ see).
+
+
+
+
+
+
+
+
+
+
+ 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 explicitly destroyed.
+ One thread will run for each URI specified. You can use
+ any protocol that Curl supports.
+
+
+
+
+
+
+
+
+ Number of the desktop on which conky is running
+ or the message "Not running in X" if this is the case.
+
+
+
+
+
+
+
+
+ Name of the desktop on which conky is running or
+ the message "Not running in X" if this is the case.
+
+
+
+
+
+
+
+
+ Number of desktops or the message "Not running in
+ X" if this is the case.
@@ -647,7 +723,7 @@
Disk protection status, if supported (needs
kernel-patch). Prints either "frozen" or "free " (note the
- padding).
+ padding).
@@ -659,7 +735,7 @@
Displays current disk IO. Device is optional, and
takes the form of sda for /dev/sda. Individual partitions
- are allowed.
+ are allowed.
@@ -670,7 +746,7 @@
Displays current disk IO for reads. Device as in
- diskio.
+ diskio.
@@ -681,7 +757,7 @@
Displays current disk IO for writes. Device as in
- diskio.
+ diskio.
@@ -689,17 +765,16 @@
-
+
Disk IO 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 "log" instead of "normal". Takes the switch '-t' to
- use a temperature gradient, which makes the gradient values
+ you use -l switch. 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).
+ value (try it and see).
@@ -707,18 +782,16 @@
-
+
Disk IO graph for reads, colours defined in hex,
minus the #. If scale is non-zero, it becomes the scale for
the graph. Device as in diskio. Uses a logarithmic scale
- (to see small numbers) when you use "log" instead of
- "normal". 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).
+ (to see small numbers) when you use -l switch. 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).
@@ -726,18 +799,16 @@
-
+
Disk IO graph for writes, colours defined in hex,
minus the #. If scale is non-zero, it becomes the scale for
the graph. Device as in diskio. Uses a logarithmic scale
- (to see small numbers) when you use "log" instead of
- "normal". 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).
+ (to see small numbers) when you use -l switch. 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).
@@ -745,9 +816,9 @@
-
+
- Download speed in KiB
+ Download speed in suitable IEC units
@@ -755,9 +826,9 @@
-
+
- Download speed in KiB with one decimal
+ Download speed in KiB with one decimal
@@ -765,17 +836,16 @@
-
+
Download 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 "log" instead of "normal". 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).
+ when you use -l switch. 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).
@@ -788,7 +858,7 @@
Number of mails marked as draft in the specified
mailbox or mail spool if not. Only maildir type mailboxes
- are supported, mbox type will return -1.
+ are supported, mbox type will return -1.
@@ -797,7 +867,7 @@
- Text to show if any of the above are not true
+ Text to show if any of the above are not true
@@ -807,7 +877,7 @@
- Ends an $if block.
+ Ends an $if block.
@@ -816,7 +886,7 @@
- Current entropy available for crypto freaks
+ Current entropy available for crypto freaks
@@ -827,7 +897,7 @@
Normalized bar of available entropy for crypto
- freaks
+ freaks
@@ -837,7 +907,7 @@
Percentage of entropy available in comparison to
- the poolsize
+ the poolsize
@@ -847,7 +917,7 @@
Total size of system entropy pool for crypto
- freaks
+ freaks
@@ -857,11 +927,11 @@
- Evalutates given string according to the rules of
+ Evaluates given string according to the rules of
TEXT interpretation, i.e. parsing any contained text object
specifications into their output, any occuring '$$' into a
single '$' and so on. The output is then being parsed
- again.
+ again.
@@ -873,7 +943,7 @@
Fetches your currently training skill from the
Eve Online API servers (http://www.eve-online.com/) and
- displays the skill along with the remaining training time.
+ displays the skill along with the remaining training time.
@@ -886,7 +956,7 @@
Executes a shell command and displays the output
in conky. warning: this takes a lot more resources than
other variables. I'd recommend coding wanted behaviour in C
- and posting a patch.
+ and posting a patch.
@@ -899,7 +969,7 @@
Same as exec, except if the first value return is
a value between 0-100, it will use that number for a bar.
The size for bars can be controlled via the
- default_bar_size config setting.
+ default_bar_size config setting.
@@ -912,7 +982,7 @@
Same as exec, except if the first value returned
is a value between 0-100, it will use that number for a
gauge. The size for gauges can be controlled via the
- default_gauge_size config setting.
+ default_gauge_size config setting.
@@ -920,16 +990,17 @@
-
+
Same as execbar, but graphs values. Uses a
- logaritmic scale when the log option is given (to see small
- numbers). Values still have to be between 0 and 100. The
- size for graphs can be controlled via the
+ logaritmic scale when the log option (-l switch) is given
+ (to see small numbers). Values still have to be between 0
+ and 100. The size for graphs can be controlled via the
default_graph_size config setting. 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).
+ value (try it and see). If -t or -l is your first argument,
+ you may need to preceed it by a space (' ').
@@ -941,7 +1012,7 @@
Same as exec but with specific interval. Interval
can't be less than update_interval in configuration. See
- also $texeci
+ also $texeci
@@ -951,7 +1022,7 @@
- Same as execbar, except with an interval
+ Same as execbar, except with an interval
@@ -962,7 +1033,7 @@
Same as execgauge, but takes an interval arg and
- gauges values.
+ gauges values.
@@ -970,10 +1041,11 @@
-
+
Same as execgraph, but takes an interval arg and
- graphs values.
+ graphs values. If -t or -l is your first argument, you may
+ need to preceed it by a space (' ').
@@ -995,7 +1067,7 @@
like $execi within an $execp statement, it will
functionally run at the same interval that the $execp
statement runs, as it is created and destroyed at every
- interval.
+ interval.
@@ -1008,7 +1080,7 @@
Same as execp but with specific interval.
Interval can't be less than update_interval in
configuration. Note that the output from the $execpi
- command is still parsed and evaluated at every interval.
+ command is still parsed and evaluated at every interval.
@@ -1021,7 +1093,7 @@
Number of mails marked as flagged in the
specified mailbox or mail spool if not. Only maildir type
- mailboxes are supported, mbox type will return -1.
+ mailboxes are supported, mbox type will return -1.
@@ -1034,7 +1106,29 @@
Specify a different font. This new font will
apply to the current line and everything following. You can
use a $font with no arguments to change back to the default
- font (much like with $color)
+ font (much like with $color)
+
+
+
+
+
+
+
+
+
+ Format time given in seconds. This var only works when
+ the times_in_seconds configuration setting is on. Format is a string
+ that should start and end with a "-char. The "-chars are not
+ part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
+ weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
+ it's value will be expressed in the highest unite lower then the
+ one left out. Text between ()-chars will not be visible if a
+ replaced unit in this text is 0. If seconds is a decimal number
+ then you can see the numbers behind the point by using \S
+ followed by a number that specifies the amount of
+ digits behind the point that you want to see (maximum 9).
+ You can also place a 'x' behind \S so you have all digits behind
+ the point and no trailing zero's. (also maximum 9)
@@ -1047,7 +1141,7 @@
Number of mails marked as forwarded in the
specified mailbox or mail spool if not. Only maildir type
- mailboxes are supported, mbox type will return -1.
+ mailboxes are supported, mbox type will return -1.
@@ -1058,7 +1152,7 @@
Returns CPU #n's frequency in MHz. CPUs are
- counted from 1. If omitted, the parameter defaults to 1.
+ counted from 1. If omitted, the parameter defaults to 1.
@@ -1069,7 +1163,7 @@
Returns CPU #n's frequency in GHz. CPUs are
- counted from 1. If omitted, the parameter defaults to 1.
+ counted from 1. If omitted, the parameter defaults to 1.
@@ -1081,7 +1175,7 @@
Bar that shows how much space is used on a file
system. height is the height in pixels. fs is any file on
- that file system.
+ that file system.
@@ -1093,7 +1187,7 @@
Bar that shows how much space is free on a file
system. height is the height in pixels. fs is any file on
- that file system.
+ that file system.
@@ -1103,7 +1197,7 @@
- Free space on a file system available for users.
+ Free space on a file system available for users.
@@ -1114,7 +1208,7 @@
Free percentage of space on a file system
- available for users.
+ available for users.
@@ -1124,7 +1218,7 @@
- File system size.
+ File system size.
@@ -1134,7 +1228,7 @@
- File system type.
+ File system type.
@@ -1144,7 +1238,7 @@
- File system used space.
+ File system used space.
@@ -1154,7 +1248,7 @@
- Percent of file system used space.
+ Percent of file system used space.
@@ -1165,7 +1259,7 @@
The next element will be printed at position 'x'.
-
+
@@ -1175,7 +1269,7 @@
Displays the default route's interface or
- "multiple"/"none" accordingly.
+ "multiple"/"none" accordingly.
@@ -1185,7 +1279,7 @@
Displays the default gateway's IP or
- "multiple"/"none" accordingly.
+ "multiple"/"none" accordingly.
@@ -1193,12 +1287,13 @@
-
+
Displays temperature of a selected hard disk
- drive as reported by the hddtemp daemon running on
- host:port. Default host is 127.0.0.1, default port is 7634.
-
+ drive as reported by the hddtemp daemon. Use hddtemp_host
+ and hddtemp_port to specify a host and port for all hddtemp
+ objects. If no dev parameter is given, the first disk returned
+ by the hddtemp daemon is used.
@@ -1206,12 +1301,12 @@
-
+
- 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.
+ 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.
@@ -1221,7 +1316,7 @@
- Horizontal line, height is the height in pixels
+ Horizontal line, height is the height in pixels
@@ -1240,7 +1335,7 @@
'offset' allow precalculation of the raw input, which is
being modified as follows: 'input = input * factor +
offset'. Note that they have to be given as decimal values
- (i.e. contain at least one decimal place).
+ (i.e. contain at least one decimal place).
@@ -1259,7 +1354,7 @@
allow precalculation of the raw input, which is being
modified as follows: 'input = input * factor + offset'.
Note that they have to be given as decimal values (i.e.
- contain at least one decimal place).
+ contain at least one decimal place).
@@ -1272,7 +1367,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays whether ac power is on, as listed in
/proc/i8k (translated to human-readable). Beware that this
- is by default not enabled by i8k itself.
+ is by default not enabled by i8k itself.
@@ -1283,7 +1378,7 @@
If running the i8k kernel driver for Inspiron
- laptops, displays the bios version as listed in /proc/i8k.
+ laptops, displays the bios version as listed in /proc/i8k.
@@ -1295,7 +1390,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays the volume buttons status as listed in
- /proc/i8k.
+ /proc/i8k.
@@ -1307,7 +1402,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays the cpu temperature in Celsius, as
- reported by /proc/i8k.
+ reported by /proc/i8k.
@@ -1320,7 +1415,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays the left fan's rate of rotation, in
revolutions per minute as listed in /proc/i8k. Beware, some
- laptops i8k reports these fans in reverse order.
+ laptops i8k reports these fans in reverse order.
@@ -1333,7 +1428,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays the left fan status as listed in
/proc/i8k (translated to human-readable). Beware, some
- laptops i8k reports these fans in reverse order.
+ laptops i8k reports these fans in reverse order.
@@ -1346,7 +1441,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays the right fan's rate of rotation, in
revolutions per minute as listed in /proc/i8k. Beware, some
- laptops i8k reports these fans in reverse order.
+ laptops i8k reports these fans in reverse order.
@@ -1359,7 +1454,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays the right fan status as listed in
/proc/i8k (translated to human-readable). Beware, some
- laptops i8k reports these fans in reverse order.
+ laptops i8k reports these fans in reverse order.
@@ -1371,7 +1466,7 @@
If running the i8k kernel driver for Inspiron
laptops, displays your laptop serial number as listed in
- /proc/i8k.
+ /proc/i8k.
@@ -1382,7 +1477,7 @@
If running the i8k kernel driver for Inspiron
- laptops, displays the version formatting of /proc/i8k.
+ laptops, displays the version formatting of /proc/i8k.
@@ -1392,7 +1487,7 @@
If running the IBM ACPI, displays the brigtness
- of the laptops's LCD (0-7).
+ of the laptops's LCD (0-7).
@@ -1401,7 +1496,7 @@
- If running the IBM ACPI, displays the fan speed.
+ If running the IBM ACPI, displays the fan speed.
@@ -1413,7 +1508,7 @@
If running the IBM ACPI, displays the
temperatures from the IBM temperature sensors (N=0..7)
- Sensor 0 is on the CPU, 3 is on the GPU.
+ Sensor 0 is on the CPU, 3 is on the GPU.
@@ -1423,7 +1518,7 @@
If running the IBM ACPI, displays the "master"
- volume, controlled by the volume keys (0-14).
+ volume, controlled by the volume keys (0-14).
@@ -1434,7 +1529,7 @@
Convert text from one codeset to another using
- GNU iconv. Needs to be stopped with iconv_stop.
+ GNU iconv. Needs to be stopped with iconv_stop.
@@ -1444,7 +1539,7 @@
- Stop iconv codeset conversion.
+ Stop iconv codeset conversion.
@@ -1455,7 +1550,7 @@
if conky variable VAR is empty, display
- everything between $if_empty and the matching $endif
+ everything between $if_empty and the matching $endif
@@ -1469,7 +1564,7 @@
if_existing and the matching $endif. The optional second
paramater checks for FILE containing the specified string
and prints everything between $if_existing and the matching
- $endif.
+ $endif.
@@ -1479,7 +1574,7 @@
if there is at least one default gateway, display
- everything between $if_gw and the matching $endif
+ everything between $if_gw and the matching $endif
@@ -1495,20 +1590,19 @@
Valid expressions consist of a left side, an operator and a
right side. Left and right sides are being parsed for
contained text objects before evaluation. Recognised left
- and right side types are:
+ and right side types are:
- double: argument consists of only
+ doubleArgument consists of only
digits and a single dot.
- long: argument consists of only
+ longArgument consists of only
digits.
- string: argument is enclosed in
- quotation mark or the checks for double and long failed
- before.
+ stringArgument is enclosed in
+ quotation marks (")
Valid operands are: '>', '<', '>=',
- '<=', '==', '!='.
+ '<=', '==', '!='.
@@ -1520,7 +1614,7 @@
If mixer exists, display everything between
$if_mixer_mute and the matching $endif. If no mixer is
- specified, "Master" is used.
+ specified, "Master" is used.
@@ -1531,7 +1625,7 @@
if MOUNTPOINT is mounted, display everything
- between $if_mounted and the matching $endif
+ between $if_mounted and the matching $endif
@@ -1541,7 +1635,7 @@
if mpd is playing or paused, display everything
- between $if_mpd_playing and the matching $endif
+ between $if_mpd_playing and the matching $endif
@@ -1553,7 +1647,7 @@
if PROCESS is running, display everything
$if_running and the matching $endif. This uses the
- ``pidof'' command, so the -x switch is also supported.
+ ``pidof'' command, so the -x switch is also supported.
@@ -1565,7 +1659,7 @@
when using smapi, if the battery with index INDEX
is installed, display everything between
- $if_smapi_bat_installed and the matching $endif
+ $if_smapi_bat_installed and the matching $endif
@@ -1576,7 +1670,7 @@
if INTERFACE exists and is up, display everything
- between $if_up and the matching $endif
+ between $if_up and the matching $endif
@@ -1592,7 +1686,7 @@
reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
time followed by bar 25% of the time followed by nothing
- the other half of the time.
+ the other half of the time.
@@ -1602,7 +1696,7 @@
Display everything between $if_xmms2_connected
- and the matching $endif if xmms2 is running.
+ and the matching $endif if xmms2 is running.
@@ -1627,8 +1721,8 @@
position (or any other formatting) of images, they are just
rendered as per the arguments passed. The only reason
$image is part of the TEXT section, is to allow for runtime
- modifications, through $execp $lua_parse, $lua_read_parse,
- or some other method.
+ modifications, through $execp $lua_parse, or some other
+ method.
@@ -1640,13 +1734,13 @@
Displays the number of messages in your global
IMAP inbox by default. You can define individual IMAP
- inboxes seperately by passing arguments to this object.
+ inboxes separately by passing arguments to this object.
Arguments are: "host user pass [-i interval (in seconds)]
- [-f folder] [-p port] [-e command] [-r retries]". Default
+ [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
port is 143, default folder is 'INBOX', default interval is
5 minutes, and default number of retries before giving up
is 5. If the password is supplied as '*', you will be
- prompted to enter the password when Conky starts.
+ prompted to enter the password when Conky starts.
@@ -1658,24 +1752,38 @@
Displays the number of unseen messages in your
global IMAP inbox by default. You can define individual
- IMAP inboxes seperately by passing arguments to this
+ IMAP inboxes separately by passing arguments to this
object. Arguments are: "host user pass [-i interval (in
- seconds)] [-f folder] [-p port] [-e command] [-r retries]".
+ seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
Default port is 143, default folder is 'INBOX', default
interval is 5 minutes, and default number of retries before
giving up is 5. If the password is supplied as '*', you
- will be prompted to enter the password when Conky starts.
+ will be prompted to enter the password when Conky starts.
+
+
+
+
+
+ Loads the configfile at path, places the
+ configsettings behind the configsettings in the orginal
+ config and places the vars where the includevar
+ stood.
+
+
+
+
+ Prints the current ioscheduler used for the given
- disk name (i.e. e.g. "hda" or "sdb")
+ disk name (i.e. e.g. "hda" or "sdb")
@@ -1684,7 +1792,7 @@
- Kernel version
+ Kernel version
@@ -1693,7 +1801,7 @@
- The value of /proc/sys/vm/laptop_mode
+ The value of /proc/sys/vm/laptop_mode
@@ -1703,7 +1811,7 @@
- Displays the number of lines in the given file
+ Displays the number of lines in the given file
@@ -1711,9 +1819,11 @@
+
- (1,2,3)> System load average, 1 is for past 1
- minute, 2 for past 5 minutes and 3 for past 15 minutes.
+ System load average, 1 is for past 1 minute, 2
+ for past 5 minutes and 3 for past 15 minutes. Without argument, prints
+ all three values separated by whitespace.
@@ -1721,16 +1831,15 @@
-
+
Load1 average graph, similar to xload, with
optional colours in hex, minus the #. Uses a logarithmic
- scale (to see small numbers) when you use "log" instead of
- "normal". 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).
+ 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 amplitude
+ of a particular graph value (try it and see).
@@ -1742,7 +1851,10 @@
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.
@@ -1756,6 +1868,9 @@
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.
+ 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.
@@ -1769,7 +1884,9 @@
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.
@@ -1777,17 +1894,18 @@
-
+
- Executes a Lua function with given parameters and
- draws a graph. Expects result value to be any number, and by default will scale to show the full range. See also 'lua_load' on how to load
- scripts. Takes the switch '-t' to use a temperature
+ Executes a Lua function with and draws a graph.
+ Expects result value to be any number, and by default will
+ scale to show the full range. See also 'lua_load' on how to
+ 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.
@@ -1800,22 +1918,10 @@
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.
-
-
-
-
-
-
-
-
-
- Executes a Lua function per $lua, except takes a
- 2nd argument which is first evaluated as per Conky's TEXT
- section and passed to the function first. The return value
- is then parsed and prints the result value as per the
- syntax for Conky's TEXT section. See also 'lua_load' on how
- to load scripts.
+ 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.
@@ -1824,7 +1930,7 @@
- Machine, i686 for example
+ Machine, i686 for example
@@ -1839,7 +1945,7 @@
spool if not. Both mbox and maildir type mailboxes are
supported. You can use a program like fetchmail to get
mails from some server using your favourite protocol. See
- also new_mails.
+ also new_mails.
@@ -1853,7 +1959,7 @@
Print a summary of recent messages in an mbox
format mailbox. mbox parameter is the filename of the
mailbox (can be encapsulated using '"', ie. ${mboxscan -n
- 10 "/home/brenden/some box"}
+ 10 "/home/brenden/some box"}
@@ -1862,7 +1968,7 @@
- Amount of memory in use
+ Amount of memory in use
@@ -1872,7 +1978,7 @@
- Bar that shows amount of memory in use
+ Bar that shows amount of memory in use
@@ -1882,7 +1988,7 @@
Amount of free memory including the memory that
- is very easily freed (buffers/cache)
+ is very easily freed (buffers/cache)
@@ -1891,7 +1997,7 @@
- Amount of free memory
+ Amount of free memory
@@ -1902,7 +2008,7 @@
Gauge that shows amount of memory in use (see
- cpugauge)
+ cpugauge)
@@ -1910,14 +2016,14 @@
-
+
Memory usage graph. Uses a logarithmic scale (to
- see small numbers) when you use "log" instead of "normal".
- 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 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 amplitude of a
+ particular graph value (try it and see).
@@ -1926,7 +2032,7 @@
- Total amount of memory
+ Total amount of memory
@@ -1935,7 +2041,7 @@
- Percentage of memory in use
+ Percentage of memory in use
@@ -1954,7 +2060,7 @@
"monitor". Refer to the definition of SOUND_DEVICE_NAMES in
<linux/soundcard.h> (on Linux), <soundcard.h>
(on OpenBSD), or <sys/soundcard.h> to find the exact
- options available on your system.
+ options available on your system.
@@ -1965,7 +2071,7 @@
Displays mixer value in a bar as reported by the
- OS. See docs for $mixer for details on arguments.
+ OS. See docs for $mixer for details on arguments.
@@ -1976,7 +2082,7 @@
Prints the left channel mixer value as reported
- by the OS. See docs for $mixer for details on arguments.
+ by the OS. See docs for $mixer for details on arguments.
@@ -1988,7 +2094,7 @@
Displays the left channel mixer value in a bar as
reported by the OS. See docs for $mixer for details on
- arguments.
+ arguments.
@@ -1999,7 +2105,7 @@
Prints the right channel mixer value as reported
- by the OS. See docs for $mixer for details on arguments.
+ by the OS. See docs for $mixer for details on arguments.
@@ -2011,7 +2117,7 @@
Displays the right channel mixer value in a bar
as reported by the OS. See docs for $mixer for details on
- arguments.
+ arguments.
@@ -2020,7 +2126,7 @@
- Album of the current MOC song
+ Album of the current MOC song
@@ -2029,7 +2135,7 @@
- Artist of the current MOC song
+ Artist of the current MOC song
@@ -2038,7 +2144,7 @@
- Bitrate in the current MOC song
+ Bitrate in the current MOC song
@@ -2047,7 +2153,7 @@
- Current time of the current MOC song
+ Current time of the current MOC song
@@ -2056,7 +2162,7 @@
- File name of the current MOC song
+ File name of the current MOC song
@@ -2065,7 +2171,7 @@
- Rate of the current MOC song
+ Rate of the current MOC song
@@ -2074,7 +2180,7 @@
- The current song name being played in MOC.
+ The current song name being played in MOC.
@@ -2083,7 +2189,7 @@
- Current state of MOC; playing, stopped etc.
+ Current state of MOC; playing, stopped etc.
@@ -2092,7 +2198,7 @@
- Time left in the current MOC song
+ Time left in the current MOC song
@@ -2101,7 +2207,7 @@
- Title of the current MOC song
+ Title of the current MOC song
@@ -2110,7 +2216,7 @@
- Total length of the current MOC song
+ Total length of the current MOC song
@@ -2120,6 +2226,7 @@
Number of the monitor on which conky is running
+ or the message "Not running in X" if this is the case.
@@ -2128,7 +2235,8 @@
- Number of monitors
+ Number of monitors or the message "Not running in
+ X" if this is the case.
@@ -2137,7 +2245,7 @@
- Album in current MPD song
+ Album in current MPD song
@@ -2147,7 +2255,7 @@
Artist in current MPD song must be enabled at
- compile
+ compile
@@ -2157,7 +2265,7 @@
- Bar of mpd's progress
+ Bar of mpd's progress
@@ -2166,7 +2274,7 @@
- Bitrate of current song
+ Bitrate of current song
@@ -2175,7 +2283,7 @@
- Song's elapsed time
+ Song's elapsed time
@@ -2184,7 +2292,7 @@
- Prints the file name of the current MPD song
+ Prints the file name of the current MPD song
@@ -2193,7 +2301,7 @@
- Song's length
+ Song's length
@@ -2202,7 +2310,7 @@
- Prints the MPD name field
+ Prints the MPD name field
@@ -2211,7 +2319,7 @@
- Percent of song's progress
+ Percent of song's progress
@@ -2220,7 +2328,7 @@
- Random status (On/Off)
+ Random status (On/Off)
@@ -2229,7 +2337,7 @@
- Repeat status (On/Off)
+ Repeat status (On/Off)
@@ -2240,7 +2348,7 @@
Prints the song name in either the form "artist -
- title" or file name, depending on whats available
+ title" or file name, depending on whats available
@@ -2249,7 +2357,7 @@
- Playing, stopped, et cetera.
+ Playing, stopped, et cetera.
@@ -2259,7 +2367,7 @@
- Title of current MPD song
+ Title of current MPD song
@@ -2268,7 +2376,7 @@
- Prints the MPD track field
+ Prints the MPD track field
@@ -2277,7 +2385,7 @@
- MPD's volume
+ MPD's volume
@@ -2288,7 +2396,7 @@
Print a nameserver from /etc/resolv.conf. Index
- starts at and defaults to 0.
+ starts at and defaults to 0.
@@ -2301,7 +2409,7 @@
Unread mail count in the specified mailbox or
mail spool if not. Both mbox and maildir type mailboxes are
- supported.
+ supported.
@@ -2310,7 +2418,7 @@
- Hostname
+ Hostname
@@ -2328,26 +2436,36 @@
Nvidia graficcard support for the XNVCtrl
library. Each option can be shortened to the least
significant part. Temperatures are printed as float, all
- other values as integer.
+ other values as integer.
- threshold: the thresholdtemperature
- at which the gpu slows down
+ threshold
+
+
- temp: gives the gpu current
- temperature
+ temp
+
+
- ambient: gives current air
- temperature near GPU case
+ ambient
+
+
- gpufreq: gives the current gpu
- frequency
+ gpufreq
+
+
- memfreq: gives the current mem
- frequency
+ memfreq
+
+
- imagequality: which imagequality
- should be choosen by OpenGL applications
+ imagequality
+
+
@@ -2358,7 +2476,7 @@
- Move text over by N pixels. See also $voffset.
+ Move text over by N pixels. See also $voffset.
@@ -2368,7 +2486,7 @@
- Change outline color
+ Change outline color
@@ -2381,29 +2499,438 @@
If running on Apple powerbook/ibook, display
information on battery status. The item parameter
specifies, what information to display. Exactly one item
- must be specified. Valid items are:
+ must be specified. Valid items are:
- status: Display if battery is fully
- charged, charging, discharging or absent (running on
- AC)
+ status
+
+
- percent: Display charge of battery
- in percent, if charging or discharging. Nothing will be
- displayed, if battery is fully charged or
- absent.
+ percent
+
+
- time: Display the time remaining
- until the battery will be fully charged or discharged
- at current rate. Nothing is displayed, if battery is
- absent or if it's present but fully charged and not
- discharging.
+ time
+
+
+
+
+
+
+ Directory used as rootdirectory by the process
+ (this will be "/" unless the process did a chroot syscall)
+
+
+
+
+
+
+
+
+
+ Command line this process was invoked with
+
+
+
+
+
+
+
+
+
+ Current working directory of the process
+
+
+
+
+
+
+
+
+
+ Contents of a environment-var of the process
+
+
+
+
+
+
+
+
+
+ List of environment-vars that the process can see
+
+
+
+
+
+
+
+
+
+ Path to executed command that started the process
+
+
+
+
+
+
+
+
+
+ The nice value of the process
+
+
+
+
+
+
+
+
+
+ List of files that the process has open
+
+
+
+
+
+
+
+
+
+ The pid of the parent of the process
+
+
+
+
+
+
+
+
+
+ The priority of the process (see 'priority' in "man 5 proc")
+
+
+
+
+
+
+
+
+
+ Total number of bytes read by the process
+
+
+
+
+
+
+
+
+
+ State of the process
+
+
+
+
+
+
+
+
+
+ One of the chars in "RSDZTW" representing the state
+ of the process where R is running, S is sleeping in an
+ interruptible wait, D is waiting in uninterruptible disk sleep,
+ Z is zombie, T is traced or stopped (on a signal), and W is paging
+
+
+
+
+
+
+
+
+
+ Filedescriptor binded to the STDERR of the process
+
+
+
+
+
+
+
+
+
+ Filedescriptor binded to the STDIN of the process
+
+
+
+
+
+
+
+
+
+ Filedescriptor binded to the STDOUT of the process
+
+
+
+
+
+
+
+
+
+ Number of threads in process containing this thread
+
+
+
+
+
+
+
+
+
+ List with pid's from threads from this process
+
+
+
+
+
+
+
+
+
+ Amount of time that the process has been scheduled in kernel mode in seconds
+
+
+
+
+
+
+
+
+
+ Amount of time that the process has been scheduled in user mode in seconds
+
+
+
+
+
+
+
+
+
+ Sum of $pid_time_kernelmode and $pid_time_usermode
+
+
+
+
+
+
+
+
+
+ The real uid of the process
+
+
+
+
+
+
+
+
+
+ The effective uid of the process
+
+
+
+
+
+
+
+
+
+ The saved set uid of the process
+
+
+
+
+
+
+
+
+
+ The file system uid of the process
+
+
+
+
+
+
+
+
+
+ The real gid of the process
+
+
+
+
+
+
+
+
+
+ The effective gid of the process
+
+
+
+
+
+
+
+
+
+ The saved set gid of the process
+
+
+
+
+
+
+
+
+
+ The file system gid of the process
+
+
+
+
+
+
+
+
+
+ Peak virtual memory size of the process
+
+
+
+
+
+
+
+
+
+ Virtual memory size of the process
+
+
+
+
+
+
+
+
+
+ Locked memory size of the process
+
+
+
+
+
+
+
+
+
+ Peak resident set size ("high water mark") of the process
+
+
+
+
+
+
+
+
+
+ Resident set size of the process
+
+
+
+
+
+
+
+
+
+ Data segment size of the process
+
+
+
+
+
+
+
+
+
+ Stack segment size of the process
+
+
+
+
+
+
+
+
+
+ Text segment size of the process
+
+
+
+
+
+
+
+
+
+ Shared library code size of the process
+
+
+
+
+
+
+
+
+
+ Page table entries size of the process
+
+
+
+
+
+
+
+
+
+ Total number of bytes written by the process
+
+
+
+
+
@@ -2417,7 +2944,7 @@
'offset' allow precalculation of the raw input, which is
being modified as follows: 'input = input * factor +
offset'. Note that they have to be given as decimal values
- (i.e. contain at least one decimal place).
+ (i.e. contain at least one decimal place).
@@ -2429,13 +2956,13 @@
Displays the number of unseen messages in your
global POP3 inbox by default. You can define individual
- POP3 inboxes seperately by passing arguments to this
+ POP3 inboxes separately by passing arguments to this
object. Arguments are: "host user pass [-i interval (in
- seconds)] [-p port] [-e command] [-r retries]". Default
+ seconds)] [-p port] [-e 'command'] [-r retries]". Default
port is 110, default interval is 5 minutes, and default
number of retries before giving up is 5. If the password is
supplied as '*', you will be prompted to enter the password
- when Conky starts.
+ when Conky starts.
@@ -2447,13 +2974,13 @@
Displays the amount of space (in MiB, 2^20) used
in your global POP3 inbox by default. You can define
- individual POP3 inboxes seperately by passing arguments to
+ individual POP3 inboxes separately by passing arguments to
this object. Arguments are: "host user pass [-i interval
- (in seconds)] [-p port] [-e command] [-r retries]". Default
+ (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
port is 110, default interval is 5 minutes, and default
number of retries before giving up is 5. If the password is
supplied as '*', you will be prompted to enter the password
- when Conky starts.
+ when Conky starts.
@@ -2464,7 +2991,7 @@
Executes a shell command one time before conky
- displays anything and puts output as text.
+ displays anything and puts output as text.
@@ -2473,7 +3000,7 @@
- Total processes (sleeping and running)
+ Total processes (sleeping and running)
@@ -2485,7 +3012,7 @@
Connects to a tcp port on a host (default is
localhost), reads every char available at the moment and
- shows them.
+ shows them.
@@ -2498,7 +3025,7 @@
Number of mails marked as replied in the
specified mailbox or mail spool if not. Only maildir type
- mailboxes are supported, mbox type will return -1.
+ mailboxes are supported, mbox type will return -1.
@@ -2506,15 +3033,22 @@
-
- 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).
-
+
+ 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
+ explicitly destroyed. One thread will run for each URI
+ specified. You can use any protocol that Curl
+ supports.
+
@@ -2523,7 +3057,16 @@
Running processes (not sleeping), requires Linux
- 2.6
+ 2.6
+
+
+
+
+
+
+
+
+ Number of running (runnable) threads. Linux only.
@@ -2538,12 +3081,10 @@
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 separated by
+ 'length' number of spaces.
@@ -2556,7 +3097,7 @@
Number of mails marked as seen in the specified
mailbox or mail spool if not. Only maildir type mailboxes
- are supported, mbox type will return -1.
+ are supported, mbox type will return -1.
@@ -2566,7 +3107,7 @@
- Change shading color
+ Change shading color
@@ -2581,7 +3122,7 @@
'(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
corresponding files' content. This is a very raw method of
accessing the smapi values. When available, better use one
- of the smapi_* variables instead.
+ of the smapi_* variables instead.
@@ -2592,7 +3133,7 @@
when using smapi, display the remaining capacity
- of the battery with index INDEX as a bar.
+ of the battery with index INDEX as a bar.
@@ -2605,7 +3146,7 @@
when using smapi, display the remaining capacity
in percent of the battery with index INDEX. This is a
separate variable because it supports the 'use_spacer'
- configuration option.
+ configuration option.
@@ -2619,7 +3160,7 @@
the battery with index INDEX in watt. This is a separate
variable because the original read out value is being
converted from mW. The sign of the output reflects charging
- (positive) or discharging (negative) state.
+ (positive) or discharging (negative) state.
@@ -2632,7 +3173,7 @@
when using smapi, display the current temperature
of the battery with index INDEX in degree Celsius. This is
a separate variable because the original read out value is
- being converted from milli degree Celsius.
+ being converted from milli degree Celsius.
@@ -2642,7 +3183,7 @@
Displays the Sony VAIO fanspeed information if
- sony-laptop kernel support is enabled. Linux only.
+ sony-laptop kernel support is enabled. Linux only.
@@ -2652,7 +3193,7 @@
- Stippled (dashed) horizontal line
+ Stippled (dashed) horizontal line
@@ -2661,7 +3202,7 @@
- Amount of swap in use
+ Amount of swap in use
@@ -2671,7 +3212,16 @@
- Bar that shows amount of swap in use
+ Bar that shows amount of swap in use
+
+
+
+
+
+
+
+
+ Amount of free swap
@@ -2680,7 +3230,7 @@
- Total amount of swap
+ Total amount of swap
@@ -2689,7 +3239,7 @@
- Percentage of swap in use
+ Percentage of swap in use
@@ -2698,7 +3248,7 @@
- System name, Linux for example
+ System name, Linux for example
@@ -2709,7 +3259,7 @@
Puts a tab of the specified width, starting from
- column 'start'. The unit is pixels for both arguments.
+ column 'start'. The unit is pixels for both arguments.
@@ -2717,12 +3267,12 @@
-
+
- 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.
+ 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.
@@ -2731,70 +3281,103 @@
- (ip4 only at present)
- TCP port monitor for specified local ports. Port
- numbers must be in the range 1 to 65535. Valid items are:
-
-
- count- total number of connections
- in the range
-
- rip- remote ip address
-
- rhost- remote host name
-
- rport- remote port number
-
- rservice- remote service name from
- /etc/services
-
- lip- local ip address
-
- lhost- local host name
-
- lport- local port number
-
- lservice- local service name from
- /etc/services
- The connection index provides you with access
- to each connection in the port monitor. The monitor will
- return information for index values from 0 to n-1
- connections. Values higher than n-1 are simply ignored. For
- the "count" item, the connection index must be omitted. It
- is required for all other items.
-
- Examples:
-
- ${tcp_portmon 6881 6999 count}-
- displays the number of connections in the bittorrent
- port range
-
- ${tcp_portmon 22 22 rip 0}- displays
- the remote host ip of the first sshd
- connection
-
- ${tcp_portmon 22 22 rip 9}- displays
- the remote host ip of the tenth sshd
- connection
-
- ${tcp_portmon 1 1024 rhost 0}-
- displays the remote host name of the first connection
- on a privileged port
-
- ${tcp_portmon 1 1024 rport 4}-
- displays the remote host port of the fifth connection
- on a privileged port
-
- ${tcp_portmon 1 65535 lservice 14}-
- displays the local service name of the fifteenth
- connection in the range of all ports
- Note that port monitor variables which share
- the same port range actually refer to the same monitor, so
- many references to a single port range for different items
- and different indexes all use the same monitor internally.
- In other words, the program avoids creating redundant
- monitors.
+
+ TCP port (both IPv6 and IPv4) monitor for
+ specified local ports. Port numbers must be in
+ the range 1 to 65535. Valid items are:
+
+
+ count
+
+
+
+ rip
+
+
+
+ rhost
+
+
+
+ rport
+
+
+
+ rservice
+
+
+
+ lip
+
+
+
+ lhost
+
+
+
+ lport
+
+
+
+ lservice
+
+
+
+ The connection index provides you with access to
+ each connection in the port monitor. The monitor will
+ return information for index values from 0 to n-1
+ connections. Values higher than n-1 are simply ignored.
+ For the "count" item, the connection index must be
+ omitted. It is required for all other items.
+ Examples:
+
+
+ ${tcp_portmon 6881 6999
+ count}
+
+
+
+ ${tcp_portmon 22 22 rip 0}
+
+
+
+ ${tcp_portmon 22 22 rip 9}
+
+
+
+ ${tcp_portmon 1 1024 rhost
+ 0}
+
+
+
+ ${tcp_portmon 1 1024 rport
+ 4}
+
+
+
+ ${tcp_portmon 1 65535 lservice
+ 14}
+
+
+
+ Note that port monitor variables which share the
+ same port range actually refer to the same monitor, so
+ many references to a single port range for different
+ items and different indexes all use the same monitor
+ internally. In other words, the program avoids creating
+ redundant monitors.
+
@@ -2805,59 +3388,63 @@
- Evaluate the content of the templateN
- configuration variable (where N is a value between 0 and 9,
- inclusively), applying substitutions as described in the
- documentation of the corresponding configuration variable.
- The number of arguments is optional, but must match the
- highest referred index in the template. You can use the
- same special sequences in each argument as the ones valid
- for a template definition, e.g. to allow an argument to
- contain a whitespace. Also simple nesting of templates is
- possible this way.
-
- Here are some examples of template definitions:
-
- template0 $\1\2
- template1 \1: ${fs_used \2} / ${fs_size
- \2}
- template2 \1 \2
- The following list shows sample usage of the
- templates defined above, with the equivalent syntax when
- not using any template at all:
-
-
+
+ Evaluate the content of the templateN
+ configuration variable (where N is a value between 0
+ and 9, inclusively), applying substitutions as
+ described in the documentation of the corresponding
+ configuration variable. The number of arguments is
+ optional, but must match the highest referred index in
+ the template. You can use the same special sequences in
+ each argument as the ones valid for a template
+ definition, e.g. to allow an argument to contain a
+ whitespace. Also simple nesting of templates is
+ possible this way.
+ Here are some examples of template
+ definitions:
+
+ template0 $\1\2
+ template1 \1: ${fs_used \2} / ${fs_size
+ \2}
+ template2 \1 \2
+
+ The following list shows sample usage of the
+ templates defined above, with the equivalent syntax
+ when not using any template at all:
+
+
@@ -2873,7 +3460,19 @@
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.
+
+
+
+
+
+
+
+
+ Total threads
@@ -2884,7 +3483,19 @@
Local time, see man strftime to get more
- information about format
+ information about format
+
+
+
+
+
+
+
+
+
+ If 'size' is a number followed by a size-unit
+ (kilobyte,mb,GiB,...) then it converts the size to bytes
+ and shows it without unit, otherwise it just shows 'size'.
@@ -2892,14 +3503,25 @@
-
+
This takes arguments in the form:top (name)
(number) Basically, processes are ranked from highest to
lowest in terms of cpu usage, which is what (num)
represents. The types are: "name", "pid", "cpu", "mem",
- "mem_res", "mem_vsize", and "time". There can be a max of
- 10 processes listed.
+ "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
+ "io_write". There can be a max of 10 processes listed.
+
+
+
+
+
+
+
+
+
+ Same as top, except sorted by the amount of I/O
+ the process has done during the update interval
@@ -2907,10 +3529,10 @@
-
+
Same as top, except sorted by mem usage instead
- of cpu
+ of cpu
@@ -2918,10 +3540,10 @@
-
+
Same as top, except sorted by total CPU time
- instead of current CPU usage
+ instead of current CPU usage
@@ -2929,12 +3551,12 @@
-
+
Total download, overflows at 4 GB on Linux with
32-bit arch and there doesn't seem to be a way to know how
many times it has already done that before conky has
- started.
+ started.
@@ -2942,9 +3564,9 @@
-
+
- Total upload, this one too, may overflow
+ Total upload, this one too, may overflow
@@ -2957,7 +3579,7 @@
Number of mails marked as trashed in the
specified mailbox or mail spool if not. Only maildir type
- mailboxes are supported, mbox type will return -1.
+ mailboxes are supported, mbox type will return -1.
@@ -2965,13 +3587,33 @@
-
+
Local time for specified timezone, see man
strftime to get more information about format. The timezone
argument is specified in similar fashion as TZ environment
variable. For hints, look in /usr/share/zoneinfo. e.g.
- US/Pacific, Europe/Zurich, etc.
+ US/Pacific, Europe/Zurich, etc.
+
+
+
+
+
+
+
+
+
+ Name of group with this gid
+
+
+
+
+
+
+
+
+
+ Username of user with this uid
@@ -2984,7 +3626,7 @@
Number of mails not marked as flagged in the
specified mailbox or mail spool if not. Only maildir type
- mailboxes are supported, mbox type will return -1.
+ mailboxes are supported, mbox type will return -1.
@@ -2997,7 +3639,7 @@
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.
+ mailboxes are supported, mbox type will return -1.
@@ -3010,7 +3652,7 @@
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.
+ mailboxes are supported, mbox type will return -1.
@@ -3023,7 +3665,7 @@
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.
+ are supported, mbox type will return -1.
@@ -3033,7 +3675,7 @@
- for debugging
+ for debugging
@@ -3041,9 +3683,9 @@
-
+
- Upload speed in KiB
+ Upload speed in suitable IEC units
@@ -3051,9 +3693,9 @@
-
+
- Upload speed in KiB with one decimal
+ Upload speed in KiB with one decimal
@@ -3061,17 +3703,16 @@
-
+
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 "log" instead of "normal". Takes the switch '-t' to
- use a temperature gradient, which makes the gradient values
+ you use the -l switch. 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).
+ value (try it and see).
@@ -3080,7 +3721,7 @@
- Uptime
+ Uptime
@@ -3089,7 +3730,7 @@
- Uptime in a shorter format
+ Uptime in a shorter format
@@ -3098,7 +3739,7 @@
- Lists the names of the users logged in
+ Lists the names of the users logged in
@@ -3107,7 +3748,7 @@
- Number of users logged in
+ Number of users logged in
@@ -3116,7 +3757,7 @@
- Lists the consoles in use
+ Lists the consoles in use
@@ -3125,7 +3766,18 @@
- Lists how long users have been logged in for
+ Lists how long users have been logged in for
+
+
+
+
+
+
+
+
+
+ Lists how long the user for the given console has been
+ logged in for
@@ -3135,7 +3787,7 @@
- Display time in UTC (universal coordinate time).
+ Display time in UTC (universal coordinate time).
@@ -3146,7 +3798,7 @@
Change vertical offset by N pixels. Negative
- values will cause text to overlap. See also $offset.
+ values will cause text to overlap. See also $offset.
@@ -3157,7 +3809,7 @@
Returns CPU #n's voltage in mV. CPUs are counted
- from 1. If omitted, the parameter defaults to 1.
+ from 1. If omitted, the parameter defaults to 1.
@@ -3168,17 +3820,193 @@
Returns CPU #n's voltage in V. CPUs are counted
- from 1. If omitted, the parameter defaults to 1.
-
+ from 1. If omitted, the parameter defaults to 1.
+
+
+
+
+
+
+
+
+
+
+ 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 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.
+ '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).
+ 'data_type' must be one of the following:
+
+
+ last_update
+ 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.
+
+
+ temperature
+ Air temperature (you can use the
+ 'temperature_unit' config setting 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 aggregated
+ 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 specified.
+ Note that these variables are still EXPERIMENTAL
+ and can be subject to many future changes.
+
+
+
+
+
+
+
+
+
+
+ Download, parse and display weather forecast data
+ for a given day (daytime only).
+ For the 'URI', for the time being only
+ http://xoap.weather.com/weather/local/ is
+ supported. See 'weather' above for details 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
+
+
+
+ date
+
+
+
+ low
+
+
+
+ hi
+
+
+
+ icon
+
+
+
+ forecast
+
+
+
+ wind_speed
+
+
+
+ wind_dir
+
+
+
+ wind_dir_DEG
+
+
+
+ humidity
+
+
+
+ precipitation
+
+
+
+ '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 specified. You can use any
+ protocol that Curl supports.
+ Note that these variables are still EXPERIMENTAL
+ and can be subject to many future changes.
+
-
+
- Wireless access point MAC address (Linux only)
+ Wireless access point MAC address (Linux only)
@@ -3186,9 +4014,9 @@
-
+
- Wireless bitrate (ie 11 Mb/s) (Linux only)
+ Wireless bitrate (ie 11 Mb/s) (Linux only)
@@ -3196,9 +4024,9 @@
-
+
- Wireless access point ESSID (Linux only)
+ Wireless access point ESSID (Linux only)
@@ -3206,9 +4034,9 @@
-
+
- Wireless link quality bar (Linux only)
+ Wireless link quality bar (Linux only)
@@ -3216,9 +4044,9 @@
-
+
- Wireless link quality (Linux only)
+ Wireless link quality (Linux only)
@@ -3226,9 +4054,9 @@
-
+
- Wireless link quality maximum value (Linux only)
+ Wireless link quality maximum value (Linux only)
@@ -3236,9 +4064,9 @@
-
+
- Wireless link quality in percents (Linux only)
+ Wireless link quality in percents (Linux only)
@@ -3246,10 +4074,10 @@
-
+
Wireless mode (Managed/Ad-Hoc/Master) (Linux
- only)
+ only)
@@ -3259,7 +4087,7 @@
- Displays the number of words in the given file
+ Displays the number of words in the given file
@@ -3268,7 +4096,7 @@
- Album in current XMMS2 song
+ Album in current XMMS2 song
@@ -3277,7 +4105,7 @@
- Artist in current XMMS2 song
+ Artist in current XMMS2 song
@@ -3287,7 +4115,7 @@
- Bar of XMMS2's progress
+ Bar of XMMS2's progress
@@ -3296,7 +4124,7 @@
- Bitrate of current song
+ Bitrate of current song
@@ -3305,7 +4133,7 @@
- Comment in current XMMS2 song
+ Comment in current XMMS2 song
@@ -3314,7 +4142,7 @@
- Returns song's date.
+ Returns song's date.
@@ -3323,7 +4151,7 @@
- Duration of current song
+ Duration of current song
@@ -3332,7 +4160,7 @@
- Song's elapsed time
+ Song's elapsed time
@@ -3341,7 +4169,7 @@
- Genre in current XMMS2 song
+ Genre in current XMMS2 song
@@ -3350,7 +4178,7 @@
- XMMS2 id of current song
+ XMMS2 id of current song
@@ -3359,7 +4187,7 @@
- Percent of song's progress
+ Percent of song's progress
@@ -3368,7 +4196,7 @@
- Returns the XMMS2 playlist.
+ Returns the XMMS2 playlist.
@@ -3377,7 +4205,7 @@
- Size of current song
+ Size of current song
@@ -3387,7 +4215,7 @@
Prints the song name in either the form "artist -
- title" or file name, depending on whats available
+ title" or file name, depending on whats available
@@ -3397,7 +4225,7 @@
XMMS2 status (Playing, Paused, Stopped, or
- Disconnected)
+ Disconnected)
@@ -3406,7 +4234,7 @@
- Number of times a song was played (presumably).
+ Number of times a song was played (presumably).
@@ -3415,7 +4243,7 @@
- Title in current XMMS2 song
+ Title in current XMMS2 song
@@ -3424,7 +4252,7 @@
- Track number in current XMMS2 song
+ Track number in current XMMS2 song
@@ -3433,7 +4261,7 @@
- Full path to current song
+ Full path to current song