Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2025-02-03 20:48:31 +00:00
Code Issues Releases Activity

Specify that imap/pop3 interval is in seconds.

Browse Source
This commit is contained in:
Brenden Matthews 2009-05-07 13:18:24 -06:00
parent 884ce9192e
commit 72a90b38be
3 changed files with 199 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

384
README
View File

@ -274,11 +274,11 @@ conky(1) conky(1)
imap Default global IMAP server. Arguments are: "host user pass [-i imap Default global IMAP server. Arguments are: "host user pass [-i
interval] [-f folder] [-p port] [-e command] [-r retries]". De‐ interval (in seconds)] [-f folder] [-p port] [-e command] [-r
fault port is 143, default folder is 'INBOX', default interval retries]". Default port is 143, default folder is 'INBOX', de‐
is 5 minutes, and default number of retries before giving up is fault interval is 5 minutes, and default number of retries be‐
5. If the password is supplied as '*', you will be prompted to fore giving up is 5. If the password is supplied as '*', you
enter the password when Conky starts. will be prompted to enter the password when Conky starts.
mail_spool mail_spool
@ -416,10 +416,11 @@ conky(1) conky(1)
pop3 Default global POP3 server. Arguments are: "host user pass [-i pop3 Default global POP3 server. Arguments are: "host user pass [-i
interval] [-p port] [-e command] [-r retries]". Default port is interval (in seconds)] [-p port] [-e command] [-r retries]". De‐
110, default interval is 5 minutes, and default number of re‐ fault port is 110, default interval is 5 minutes, and default
tries before giving up is 5. If the password is supplied as '*', number of retries before giving up is 5. If the password is sup‐
you will be prompted to enter the password when Conky starts. plied as '*', you will be prompted to enter the password when
Conky starts.
short_units short_units
@ -440,14 +441,14 @@ conky(1) conky(1)
temperature_unit temperature_unit
Desired output unit of all objects displaying a temperature. Desired output unit of all objects displaying a temperature.
Parameters are either "fahrenheit" or "celsius". The default Parameters are either "fahrenheit" or "celsius". The default
unit is degree Celsius. unit is degree Celsius.
templateN templateN
Define a template for later use inside TEXT segments. Substitute Define a template for later use inside TEXT segments. Substitute
N by a digit between 0 and 9, inclusively. The value of the N by a digit between 0 and 9, inclusively. The value of the
variable is being inserted into the stuff below TEXT at the cor‐ variable is being inserted into the stuff below TEXT at the cor‐
responding position, but before some substitutions are applied: responding position, but before some substitutions are applied:
@ -458,7 +459,7 @@ conky(1) conky(1)
total_run_times total_run_times
Total number of times for Conky to update before quitting. Zero Total number of times for Conky to update before quitting. Zero
makes Conky run forever makes Conky run forever
@ -473,8 +474,8 @@ conky(1) conky(1)
use_spacer use_spacer
Adds spaces around certain objects to stop them from moving oth‐ Adds spaces around certain objects to stop them from moving oth‐
er things around. Arguments are left, right, and none (default). er things around. Arguments are left, right, and none (default).
The old true/false values are deprecated and default to The old true/false values are deprecated and default to
right/none respectively. Note that this only helps if you are right/none respectively. Note that this only helps if you are
using a mono font, such as Bitstream Vera Sans Mono. using a mono font, such as Bitstream Vera Sans Mono.
@ -490,24 +491,24 @@ conky(1) conky(1)
Xft font to use. Xft font to use.
TEXT After this begins text to be formatted on screen. Backslash (\) TEXT After this begins text to be formatted on screen. Backslash (\)
escapes newlines in the text section. This can be useful for escapes newlines in the text section. This can be useful for
cleaning up config files where conky is used to pipe input to cleaning up config files where conky is used to pipe input to
dzen2. dzen2.
VARIABLES VARIABLES
Colors are parsed using XParsecolor(), there might be a list of them: Colors are parsed using XParsecolor(), there might be a list of them:
/usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩. /usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩.
Color can be also in #rrggbb format (hex). Color can be also in #rrggbb format (hex).
addr interface addr interface
IP address for an interface, or "No Address" if no address is IP address for an interface, or "No Address" if no address is
assigned. assigned.
addrs interface addrs interface
IP addresses for an interface (if one - works like addr). Linux IP addresses for an interface (if one - works like addr). Linux
only. only.
@ -548,7 +549,7 @@ conky(1) conky(1)
apm_battery_time apm_battery_time
Display remaining APM battery life in hh:mm:ss or "unknown" if Display remaining APM battery life in hh:mm:ss or "unknown" if
AC adapterstatus is on-line or charging (FreeBSD only) AC adapterstatus is on-line or charging (FreeBSD only)
@ -609,16 +610,16 @@ conky(1) conky(1)
battery (num) battery (num)
Battery status and remaining percentage capacity of ACPI or APM Battery status and remaining percentage capacity of ACPI or APM
battery. ACPI battery number can be given as argument (default battery. ACPI battery number can be given as argument (default
is BAT0). is BAT0).
battery_short (num) battery_short (num)
Battery status and remaining percentage capacity of ACPI or APM Battery status and remaining percentage capacity of ACPI or APM
battery. ACPI battery number can be given as argument (default battery. ACPI battery number can be given as argument (default
is BAT0). This mode display a short status, which means that C is BAT0). This mode display a short status, which means that C
is displayed instead of charging and D is displayed instead of is displayed instead of charging and D is displayed instead of
discharging. discharging.
@ -633,7 +634,7 @@ conky(1) conky(1)
battery_time (num) battery_time (num)
Battery charge/discharge time remaining of ACPI battery. ACPI Battery charge/discharge time remaining of ACPI battery. ACPI
battery number can be given as argument (default is BAT0). battery number can be given as argument (default is BAT0).
@ -672,13 +673,13 @@ conky(1) conky(1)
Change drawing color to color Change drawing color to color
colorN Change drawing color to colorN configuration option, where N is colorN Change drawing color to colorN configuration option, where N is
a digit between 0 and 9, inclusively. a digit between 0 and 9, inclusively.
combine var1 var2 combine var1 var2
Places the lines of var2 to the right of the lines of var1 Places the lines of var2 to the right of the lines of var1
seperated by the chars that are put between var1 and var2. For seperated by the chars that are put between var1 and var2. For
example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/memin‐ example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/memin‐
fo 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1 fo 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1
and "cpuinfo_line2 -" on line 2. $combine vars can also be nest‐ and "cpuinfo_line2 -" on line 2. $combine vars can also be nest‐
@ -698,26 +699,26 @@ conky(1) conky(1)
cpu (cpuN) cpu (cpuN)
CPU usage in percents. For SMP machines, the CPU number can be CPU usage in percents. For SMP machines, the CPU number can be
provided as an argument. ${cpu cpu0} is the total usage, and provided as an argument. ${cpu cpu0} is the total usage, and
${cpu cpuX} (X >= 1) are individual CPUs. ${cpu cpuX} (X >= 1) are individual CPUs.
cpubar (cpuN) (height),(width) cpubar (cpuN) (height),(width)
Bar that shows CPU usage, height is bar's height in pixels. See Bar that shows CPU usage, height is bar's height in pixels. See
$cpu for more info on SMP. $cpu for more info on SMP.
cpugauge (cpuN) (height),(width) cpugauge (cpuN) (height),(width)
Elliptical gauge that shows CPU usage, height and width are Elliptical gauge that shows CPU usage, height and width are
gauge's vertical and horizontal axis respectively. See $cpu for gauge's vertical and horizontal axis respectively. See $cpu for
more info on SMP. more info on SMP.
cpugraph (cpuN) ("normal"|"log") (height),(width) (gradient colour 1) cpugraph (cpuN) ("normal"|"log") (height),(width) (gradient colour 1)
(gradient colour 2) (scale) (gradient colour 2) (scale)
CPU usage graph, with optional colours in hex, minus the #. See CPU usage graph, with optional colours in hex, minus the #. See
$cpu for more info on SMP. Uses a logarithmic scale (to see $cpu for more info on SMP. Uses a logarithmic scale (to see
small numbers) when you use "log" instead of "normal". small numbers) when you use "log" instead of "normal".
@ -728,7 +729,7 @@ conky(1) conky(1)
diskiograph ("normal"|"log") (height),(width) (gradient colour 1) (gra‐ diskiograph ("normal"|"log") (height),(width) (gradient colour 1) (gra‐
dient colour 2) (scale) (device) dient colour 2) (scale) (device)
Disk IO graph, colours defined in hex, minus the #. If scale is Disk IO graph, colours defined in hex, minus the #. If scale is
non-zero, it becomes the scale for the graph. Uses a logarithmic non-zero, it becomes the scale for the graph. Uses a logarithmic
scale (to see small numbers) when you use "log" instead of "nor‐ scale (to see small numbers) when you use "log" instead of "nor‐
mal". mal".
@ -738,11 +739,11 @@ conky(1) conky(1)
Displays current disk IO for reads. Device as in diskio. Displays current disk IO for reads. Device as in diskio.
diskiograph_read ("normal"|"log") (height),(width) (gradient colour 1) diskiograph_read ("normal"|"log") (height),(width) (gradient colour 1)
(gradient colour 2) (scale) (device) (gradient colour 2) (scale) (device)
Disk IO graph for reads, colours defined in hex, minus the #. If 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 scale is non-zero, it becomes the scale for the graph. Device as
in diskio. Uses a logarithmic scale (to see small numbers) when in diskio. Uses a logarithmic scale (to see small numbers) when
you use "log" instead of "normal". you use "log" instead of "normal".
@ -752,9 +753,9 @@ conky(1) conky(1)
diskiograph_write ("normal"|"log") (height),(width) (gradient colour 1) diskiograph_write ("normal"|"log") (height),(width) (gradient colour 1)
(gradient colour 2) (scale) (device) (gradient colour 2) (scale) (device)
Disk IO graph for writes, colours defined in hex, minus the #. Disk IO graph for writes, colours defined in hex, minus the #.
If scale is non-zero, it becomes the scale for the graph. Device If scale is non-zero, it becomes the scale for the graph. Device
as in diskio. Uses a logarithmic scale (to see small numbers) as in diskio. Uses a logarithmic scale (to see small numbers)
when you use "log" instead of "normal". when you use "log" instead of "normal".
@ -771,11 +772,11 @@ conky(1) conky(1)
Download speed in KiB with one decimal Download speed in KiB with one decimal
downspeedgraph ("normal"|"log") (height),(width) (gradient colour 1) downspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)
(gradient colour 2) (scale) (net) (gradient colour 2) (scale) (net)
Download speed graph, colours defined in hex, minus the #. If Download speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph. Uses a scale is non-zero, it becomes the scale for the graph. Uses a
logarithmic scale (to see small numbers) when you use "log" in‐ logarithmic scale (to see small numbers) when you use "log" in‐
stead of "normal". stead of "normal".
@ -796,40 +797,40 @@ conky(1) conky(1)
eval string eval string
Evalutates given string according to the rules of TEXT interpre‐ Evalutates given string according to the rules of TEXT interpre‐
tation, i.e. parsing any contained text object specifications tation, i.e. parsing any contained text object specifications
into their output, any occuring '$$' into a single '$' and so into their output, any occuring '$$' into a single '$' and so
on. The output is then being parsed again. on. The output is then being parsed again.
exec command exec command
Executes a shell command and displays the output in conky. warn‐ Executes a shell command and displays the output in conky. warn‐
ing: this takes a lot more resources than other variables. I'd ing: this takes a lot more resources than other variables. I'd
recommend coding wanted behaviour in C and posting a patch. recommend coding wanted behaviour in C and posting a patch.
execbar command execbar command
Same as exec, except if the first value return is a value be‐ Same as exec, except if the first value return is a value be‐
tween 0-100, it will use that number for a bar. The size for tween 0-100, it will use that number for a bar. The size for
bars can be controlled via the default_bar_size config setting. bars can be controlled via the default_bar_size config setting.
execgauge command execgauge command
Same as exec, except if the first value returned is a value be‐ Same as exec, except if the first value returned is a value be‐
tween 0-100, it will use that number for a gauge. The size for tween 0-100, it will use that number for a gauge. The size for
gauges can be controlled via the default_gauge_size config set‐ gauges can be controlled via the default_gauge_size config set‐
ting. ting.
execgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ execgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
ent colour 2) (scale) command ent colour 2) (scale) command
Same as execbar, but graphs values. Uses a logaritmic scale when Same as execbar, but graphs values. Uses a logaritmic scale when
the log option is given (to see small numbers). Values still the log option is given (to see small numbers). Values still
have to be between 0 and 100. The size for graphs can be con‐ have to be between 0 and 100. The size for graphs can be con‐
trolled via the default_graph_size config setting. trolled via the default_graph_size config setting.
execi interval command execi interval command
Same as exec but with specific interval. Interval can't be less Same as exec but with specific interval. Interval can't be less
than update_interval in configuration. See also $texeci than update_interval in configuration. See also $texeci
@ -847,14 +848,14 @@ conky(1) conky(1)
execp command execp command
Executes a shell command and displays the output in conky. warn‐ Executes a shell command and displays the output in conky. warn‐
ing: this takes a lot more resources than other variables. I'd ing: this takes a lot more resources than other variables. I'd
recommend coding wanted behaviour in C and posting a patch. This recommend coding wanted behaviour in C and posting a patch. This
differs from $exec in that it parses the output of the command, differs from $exec in that it parses the output of the command,
so you can insert things like ${color red}hi!${color} in your so you can insert things like ${color red}hi!${color} in your
script and have it correctly parsed by Conky. Caveats: Conky script and have it correctly parsed by Conky. Caveats: Conky
parses and evaluates the output of $execp every time Conky parses and evaluates the output of $execp every time Conky
loops, and then destroys all the objects. If you try to use any‐ loops, and then destroys all the objects. If you try to use any‐
thing like $execi within an $execp statement, it will function‐ thing like $execi within an $execp statement, it will function‐
ally run at the same interval that the $execp statement runs, as ally run at the same interval that the $execp statement runs, as
it is created and destroyed at every interval. it is created and destroyed at every interval.
@ -862,34 +863,34 @@ conky(1) conky(1)
execpi interval command execpi interval command
Same as execp but with specific interval. Interval can't be less Same as execp but with specific interval. Interval can't be less
than update_interval in configuration. Note that the output from than update_interval in configuration. Note that the output from
the $execpi command is still parsed and evaluated at every in‐ the $execpi command is still parsed and evaluated at every in‐
terval. terval.
font (font) font (font)
Specify a different font. This new font will apply to the cur‐ Specify a different font. This new font will apply to the cur‐
rent line and everything following. You can use a $font with no rent line and everything following. You can use a $font with no
arguments to change back to the default font (much like with arguments to change back to the default font (much like with
$color) $color)
freq (n) freq (n)
Returns CPU #n's frequency in MHz. CPUs are counted from 1. If Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
omitted, the parameter defaults to 1. omitted, the parameter defaults to 1.
freq_g (n) freq_g (n)
Returns CPU #n's frequency in GHz. CPUs are counted from 1. If Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
omitted, the parameter defaults to 1. omitted, the parameter defaults to 1.
fs_bar (height),(width) fs fs_bar (height),(width) fs
Bar that shows how much space is used on a file system. height 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. is the height in pixels. fs is any file on that file system.
fs_bar_free (height),(width) fs fs_bar_free (height),(width) fs
Bar that shows how much space is free on a file system. height 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. is the height in pixels. fs is any file on that file system.
@ -921,23 +922,23 @@ conky(1) conky(1)
gw_iface gw_iface
Displays the default route's interface or "multiple"/"none" ac‐ Displays the default route's interface or "multiple"/"none" ac‐
cordingly. cordingly.
gw_ip Displays the default gateway's IP or "multiple"/"none" accord‐ gw_ip Displays the default gateway's IP or "multiple"/"none" accord‐
ingly. ingly.
hddtemp dev, (host,(port)) hddtemp dev, (host,(port))
Displays temperature of a selected hard disk drive as reported Displays temperature of a selected hard disk drive as reported
by the hddtemp daemon running on host:port. Default host is by the hddtemp daemon running on host:port. Default host is
127.0.0.1, default port is 7634. 127.0.0.1, default port is 7634.
head logfile lines (interval) head logfile lines (interval)
Displays first N lines of supplied text text file. If interval Displays first N lines of supplied text text file. If interval
is not supplied, Conky assumes 2x Conky's interval. Max of 30 is not supplied, Conky assumes 2x Conky's interval. Max of 30
lines can be displayed, or until the text buffer is filled. lines can be displayed, or until the text buffer is filled.
@ -946,15 +947,15 @@ conky(1) conky(1)
hwmon (dev) type n hwmon (dev) type n
Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐ Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
ted if you have only one hwmon device. Parameter type is either ted if you have only one hwmon device. Parameter type is either
'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning
temperature. Parameter n is number of the sensor. See temperature. Parameter n is number of the sensor. See
/sys/class/hwmon/ on your local computer. /sys/class/hwmon/ on your local computer.
iconv_start codeset_from codeset_to iconv_start codeset_from codeset_to
Convert text from one codeset to another using GNU iconv. Needs Convert text from one codeset to another using GNU iconv. Needs
to be stopped with iconv_stop. to be stopped with iconv_stop.
@ -963,70 +964,70 @@ conky(1) conky(1)
i2c (dev) type n i2c (dev) type n
I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
if you have only one I2C device. Parameter type is either 'in' if you have only one I2C device. Parameter type is either 'in'
or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐ or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
perature. Parameter n is number of the sensor. See perature. Parameter n is number of the sensor. See
/sys/bus/i2c/devices/ on your local computer. /sys/bus/i2c/devices/ on your local computer.
i8k_ac_status i8k_ac_status
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
whether ac power is on, as listed in /proc/i8k (translated to whether ac power is on, as listed in /proc/i8k (translated to
human-readable). Beware that this is by default not enabled by human-readable). Beware that this is by default not enabled by
i8k itself. i8k itself.
i8k_bios i8k_bios
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the bios version as listed in /proc/i8k. the bios version as listed in /proc/i8k.
i8k_buttons_status i8k_buttons_status
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the volume buttons status as listed in /proc/i8k. the volume buttons status as listed in /proc/i8k.
i8k_cpu_temp i8k_cpu_temp
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the cpu temperature in Celsius, as reported by /proc/i8k. the cpu temperature in Celsius, as reported by /proc/i8k.
i8k_left_fan_rpm i8k_left_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the left fan's rate of rotation, in revolutions per minute as the left fan's rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order. in reverse order.
i8k_left_fan_status i8k_left_fan_status
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the left fan status as listed in /proc/i8k (translated to human- the left fan status as listed in /proc/i8k (translated to human-
readable). Beware, some laptops i8k reports these fans in re‐ readable). Beware, some laptops i8k reports these fans in re‐
verse order. verse order.
i8k_right_fan_rpm i8k_right_fan_rpm
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the right fan's rate of rotation, in revolutions per minute as the right fan's rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order. in reverse order.
i8k_right_fan_status i8k_right_fan_status
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the right fan status as listed in /proc/i8k (translated to hu‐ the right fan status as listed in /proc/i8k (translated to hu‐
man-readable). Beware, some laptops i8k reports these fans in man-readable). Beware, some laptops i8k reports these fans in
reverse order. reverse order.
i8k_serial i8k_serial
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
your laptop serial number as listed in /proc/i8k. your laptop serial number as listed in /proc/i8k.
i8k_version i8k_version
If running the i8k kernel driver for Inspiron laptops, displays If running the i8k kernel driver for Inspiron laptops, displays
the version formatting of /proc/i8k. the version formatting of /proc/i8k.
@ -1035,13 +1036,13 @@ conky(1) conky(1)
ibm_temps N ibm_temps N
If running the IBM ACPI, displays the temperatures from the IBM 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 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
GPU. GPU.
ibm_volume ibm_volume
If running the IBM ACPI, displays the "master" volume, con‐ If running the IBM ACPI, displays the "master" volume, con‐
trolled by the volume keys (0-14). trolled by the volume keys (0-14).
@ -1051,14 +1052,14 @@ conky(1) conky(1)
if_empty (var) if_empty (var)
if conky variable VAR is empty, display everything between if conky variable VAR is empty, display everything between
$if_empty and the matching $endif $if_empty and the matching $endif
if_existing file (string) if_existing file (string)
if FILE exists, display everything between if_existing and the if FILE exists, display everything between if_existing and the
matching $endif. The optional second paramater checks for FILE matching $endif. The optional second paramater checks for FILE
containing the specified string and prints everything between containing the specified string and prints everything between
$if_existing and the matching $endif. $if_existing and the matching $endif.
@ -1067,11 +1068,11 @@ conky(1) conky(1)
if_match expression if_match expression
Evaluates the given boolean expression, printing everything be‐ Evaluates the given boolean expression, printing everything be‐
tween $if_match and the matching $endif depending on whether the tween $if_match and the matching $endif depending on whether the
evaluation returns true or not. Valid expressions consist of a evaluation returns true or not. Valid expressions consist of a
left side, an operator and a right side. Left and right sides left side, an operator and a right side. Left and right sides
are being parsed for contained text objects before evaluation. are being parsed for contained text objects before evaluation.
Recognised left and right side types are: Recognised left and right side types are:
double: argument consists of only digits and a single dot. double: argument consists of only digits and a single dot.
@ -1083,13 +1084,13 @@ conky(1) conky(1)
if_mixer_mute (mixer) if_mixer_mute (mixer)
If mixer exists, display everything between $if_mixer_mute and If mixer exists, display everything between $if_mixer_mute and
the matching $endif. If no mixer is specified, "Master" is used. the matching $endif. If no mixer is specified, "Master" is used.
if_running (process) if_running (process)
if PROCESS is running, display everything $if_running and the if PROCESS is running, display everything $if_running and the
matching $endif. This uses the ``pidof'' command, so the -x matching $endif. This uses the ``pidof'' command, so the -x
switch is also supported. switch is also supported.
@ -1099,8 +1100,8 @@ conky(1) conky(1)
if_smapi_bat_installed (INDEX) if_smapi_bat_installed (INDEX)
when using smapi, if the battery with index INDEX is installed, when using smapi, if the battery with index INDEX is installed,
display everything between $if_smapi_bat_installed and the display everything between $if_smapi_bat_installed and the
matching $endif matching $endif
@ -1110,38 +1111,38 @@ conky(1) conky(1)
if_updatenr (updatenr) if_updatenr (updatenr)
If it's the UPDATENR-th time that conky updates, display every‐ If it's the UPDATENR-th time that conky updates, display every‐
thing between $if_updatenr and the matching $endif. The counter thing between $if_updatenr and the matching $endif. The counter
resets when the highest UPDATENR is reached. Example : resets when the highest UPDATENR is reached. Example :
"{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr "{$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 4}$endif" shows foo 25% of the time followed by bar 25% of the
time followed by nothing the other half of the time. time followed by nothing the other half of the time.
imap_messages (args) imap_messages (args)
Displays the number of messages in your global IMAP inbox by de‐ Displays the number of messages in your global IMAP inbox by de‐
fault. You can define individual IMAP inboxes seperately by fault. You can define individual IMAP inboxes seperately by
passing arguments to this object. Arguments are: "host user pass passing arguments to this object. Arguments are: "host user pass
[-i interval] [-f folder] [-p port] [-e command] [-r retries]". [-i interval (in seconds)] [-f folder] [-p port] [-e command]
Default port is 143, default folder is 'INBOX', default interval [-r retries]". Default port is 143, default folder is 'INBOX',
is 5 minutes, and default number of retries before giving up is default interval is 5 minutes, and default number of retries be‐
5. If the password is supplied as '*', you will be prompted to fore giving up is 5. If the password is supplied as '*', you
enter the password when Conky starts. will be prompted to enter the password when Conky starts.
imap_unseen (args) imap_unseen (args)
Displays the number of unseen messages in your global IMAP inbox Displays the number of unseen messages in your global IMAP inbox
by default. You can define individual IMAP inboxes seperately by by default. You can define individual IMAP inboxes seperately by
passing arguments to this object. Arguments are: "host user pass passing arguments to this object. Arguments are: "host user pass
[-i interval] [-f folder] [-p port] [-e command] [-r retries]". [-i interval (in seconds)] [-f folder] [-p port] [-e command]
Default port is 143, default folder is 'INBOX', default interval [-r retries]". Default port is 143, default folder is 'INBOX',
is 5 minutes, and default number of retries before giving up is default interval is 5 minutes, and default number of retries be‐
5. If the password is supplied as '*', you will be prompted to fore giving up is 5. If the password is supplied as '*', you
enter the password when Conky starts. will be prompted to enter the password when Conky starts.
ioscheduler disk ioscheduler disk
Prints the current ioscheduler used for the given disk name Prints the current ioscheduler used for the given disk name
(i.e. e.g. "hda" or "sdb") (i.e. e.g. "hda" or "sdb")
@ -1159,8 +1160,8 @@ conky(1) conky(1)
loadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ loadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
ent colour 2) (scale) ent colour 2) (scale)
Load1 average graph, similar to xload, with optional colours in Load1 average graph, similar to xload, with optional colours in
hex, minus the #. Uses a logarithmic scale (to see small num‐ hex, minus the #. Uses a logarithmic scale (to see small num‐
bers) when you use "log" instead of "normal". bers) when you use "log" instead of "normal".
@ -1173,9 +1174,9 @@ conky(1) conky(1)
mails (mailbox) (interval) mails (mailbox) (interval)
Mail count in the specified mailbox or your mail spool if not. Mail count in the specified mailbox or your mail spool if not.
Both mbox and maildir type mailboxes are supported. You can use Both mbox and maildir type mailboxes are supported. You can use
a program like fetchmail to get mails from some server using a program like fetchmail to get mails from some server using
your favourite protocol. See also new_mails. your favourite protocol. See also new_mails.
@ -1185,32 +1186,32 @@ conky(1) conky(1)
seen_mails (maildir) (interval) seen_mails (maildir) (interval)
Number of mails marked as seen in the specified mailbox or mail Number of mails marked as seen in the specified mailbox or mail
spool if not. Only maildir type mailboxes are supported, mbox spool if not. Only maildir type mailboxes are supported, mbox
type will return -1. type will return -1.
unseen_mails (maildir) (interval) unseen_mails (maildir) (interval)
Number of new or unseen mails in the specified mailbox or mail Number of new or unseen mails in the specified mailbox or mail
spool if not. Only maildir type mailboxes are supported, mbox spool if not. Only maildir type mailboxes are supported, mbox
type will return -1. type will return -1.
flagged_mails (maildir) (interval) flagged_mails (maildir) (interval)
Number of mails marked as flagged in the specified mailbox or Number of mails marked as flagged in the specified mailbox or
mail spool if not. Only maildir type mailboxes are supported, mail spool if not. Only maildir type mailboxes are supported,
mbox type will return -1. mbox type will return -1.
unflagged_mails (maildir) (interval) unflagged_mails (maildir) (interval)
Number of mails not marked as flagged in the specified mailbox Number of mails not marked as flagged in the specified mailbox
or mail spool if not. Only maildir type mailboxes are supported, or mail spool if not. Only maildir type mailboxes are supported,
mbox type will return -1. mbox type will return -1.
forwarded_mails (maildir) (interval) forwarded_mails (maildir) (interval)
Number of mails marked as forwarded in the specified mailbox or Number of mails marked as forwarded in the specified mailbox or
mail spool if not. Only maildir type mailboxes are supported, mail spool if not. Only maildir type mailboxes are supported,
mbox type will return -1. mbox type will return -1.
@ -1221,33 +1222,33 @@ conky(1) conky(1)
replied_mails (maildir) (interval) replied_mails (maildir) (interval)
Number of mails marked as replied in the specified mailbox or Number of mails marked as replied in the specified mailbox or
mail spool if not. Only maildir type mailboxes are supported, mail spool if not. Only maildir type mailboxes are supported,
mbox type will return -1. mbox type will return -1.
unreplied_mails (maildir) (interval) unreplied_mails (maildir) (interval)
Number of mails not marked as replied in the specified mailbox Number of mails not marked as replied in the specified mailbox
or mail spool if not. Only maildir type mailboxes are supported, or mail spool if not. Only maildir type mailboxes are supported,
mbox type will return -1. mbox type will return -1.
draft_mails (maildir) (interval) draft_mails (maildir) (interval)
Number of mails marked as draft in the specified mailbox or mail Number of mails marked as draft in the specified mailbox or mail
spool if not. Only maildir type mailboxes are supported, mbox spool if not. Only maildir type mailboxes are supported, mbox
type will return -1. type will return -1.
trashed_mails (maildir) (interval) trashed_mails (maildir) (interval)
Number of mails marked as trashed in the specified mailbox or Number of mails marked as trashed in the specified mailbox or
mail spool if not. Only maildir type mailboxes are supported, mail spool if not. Only maildir type mailboxes are supported,
mbox type will return -1. mbox type will return -1.
mboxscan (-n number of messages to print) (-fw from width) (-sw subject mboxscan (-n number of messages to print) (-fw from width) (-sw subject
width) mbox width) mbox
Print a summary of recent messages in an mbox format mailbox. Print a summary of recent messages in an mbox format mailbox.
mbox parameter is the filename of the mailbox (can be encapsu‐ mbox parameter is the filename of the mailbox (can be encapsu‐
lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"} lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
@ -1262,14 +1263,14 @@ conky(1) conky(1)
Gauge that shows amount of memory in use (see cpugauge) Gauge that shows amount of memory in use (see cpugauge)
memgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐ memgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
ent colour 2) (scale) ent colour 2) (scale)
Memory usage graph. Uses a logarithmic scale (to see small num‐ Memory usage graph. Uses a logarithmic scale (to see small num‐
bers) when you use "log" instead of "normal". bers) when you use "log" instead of "normal".
memeasyfree memeasyfree
Amount of free memory including the memory that is very easily Amount of free memory including the memory that is very easily
freed (buffers/cache) freed (buffers/cache)
@ -1285,39 +1286,39 @@ conky(1) conky(1)
mixer (device) mixer (device)
Prints the mixer value as reported by the OS. Default mixer is Prints the mixer value as reported by the OS. Default mixer is
"vol", but you can specify one of the following optional argu‐ "vol", but you can specify one of the following optional argu‐
ments: "vol", "bass", "treble", "synth", "pcm", "speaker", ments: "vol", "bass", "treble", "synth", "pcm", "speaker",
"line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain",
"line1", "line2", "line3", "dig1", "dig2", "dig3", "phin", "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin",
"phout", "video", "radio", "monitor". Refer to the definition of "phout", "video", "radio", "monitor". Refer to the definition of
SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐ SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐
card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐ card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
tions available on your system. tions available on your system.
mixerbar (device) mixerbar (device)
Displays mixer value in a bar as reported by the OS. See docs Displays mixer value in a bar as reported by the OS. See docs
for $mixer for details on arguments. for $mixer for details on arguments.
mixerr (device) mixerr (device)
Prints the right channel mixer value as reported by the OS. See Prints the right channel mixer value as reported by the OS. See
docs for $mixer for details on arguments. docs for $mixer for details on arguments.
mixerrbar (device) mixerrbar (device)
Displays the right channel mixer value in a bar as reported by Displays the right channel mixer value in a bar as reported by
the OS. See docs for $mixer for details on arguments. the OS. See docs for $mixer for details on arguments.
mixerl (device) mixerl (device)
Prints the left channel mixer value as reported by the OS. See Prints the left channel mixer value as reported by the OS. See
docs for $mixer for details on arguments. docs for $mixer for details on arguments.
mixerlbar (device) mixerlbar (device)
Displays the left channel mixer value in a bar as reported by Displays the left channel mixer value in a bar as reported by
the OS. See docs for $mixer for details on arguments. the OS. See docs for $mixer for details on arguments.
@ -1439,12 +1440,12 @@ conky(1) conky(1)
if_mpd_playing if_mpd_playing
if mpd is playing or paused, display everything between if mpd is playing or paused, display everything between
$if_mpd_playing and the matching $endif $if_mpd_playing and the matching $endif
nameserver (index) nameserver (index)
Print a nameserver from /etc/resolv.conf. Index starts at and Print a nameserver from /etc/resolv.conf. Index starts at and
defaults to 0. defaults to 0.
@ -1453,8 +1454,8 @@ conky(1) conky(1)
nvidia threshold temp ambient gpufreq memfreq imagequality nvidia threshold temp ambient gpufreq memfreq imagequality
Nvidia graficcard support for the XNVCtrl library. Each option Nvidia graficcard support for the XNVCtrl library. Each option
can be shortened to the least significant part. Temperatures can be shortened to the least significant part. Temperatures
are printed as float, all other values as integer. are printed as float, all other values as integer.
threshold: the thresholdtemperature at which the gpu slows down threshold: the thresholdtemperature at which the gpu slows down
@ -1472,25 +1473,25 @@ conky(1) conky(1)
pb_battery item pb_battery item
If running on Apple powerbook/ibook, display information on bat‐ If running on Apple powerbook/ibook, display information on bat‐
tery status. The item parameter specifies, what information to tery status. The item parameter specifies, what information to
display. Exactly one item must be specified. Valid items are: display. Exactly one item must be specified. Valid items are:
status: Display if battery is fully charged, charging, discharg‐ status: Display if battery is fully charged, charging, discharg‐
ing or absent (running on AC) ing or absent (running on AC)
percent: Display charge of battery in percent, if charging or percent: Display charge of battery in percent, if charging or
discharging. Nothing will be displayed, if battery is fully discharging. Nothing will be displayed, if battery is fully
charged or absent. charged or absent.
time: Display the time remaining until the battery will be fully time: Display the time remaining until the battery will be fully
charged or discharged at current rate. Nothing is displayed, if charged or discharged at current rate. Nothing is displayed, if
battery is absent or if it's present but fully charged and not battery is absent or if it's present but fully charged and not
discharging. discharging.
platform (dev) type n platform (dev) type n
Platform sensor from sysfs (Linux 2.6). Parameter dev may be Platform sensor from sysfs (Linux 2.6). Parameter dev may be
omitted if you have only one platform device. Platform type is omitted if you have only one platform device. Platform type is
either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
meaning temperature. Parameter n is number of the sensor. See meaning temperature. Parameter n is number of the sensor. See
/sys/bus/platform/devices/ on your local computer. /sys/bus/platform/devices/ on your local computer.
@ -1498,21 +1499,22 @@ conky(1) conky(1)
Displays the number of unseen messages in your global POP3 inbox Displays the number of unseen messages in your global POP3 inbox
by default. You can define individual POP3 inboxes seperately by by default. You can define individual POP3 inboxes seperately by
passing arguments to this object. Arguments are: "host user pass passing arguments to this object. Arguments are: "host user pass
[-i interval] [-p port] [-e command] [-r retries]". Default port [-i interval (in seconds)] [-p port] [-e command] [-r retries]".
is 110, default interval is 5 minutes, and default number of re‐ Default port is 110, default interval is 5 minutes, and default
tries before giving up is 5. If the password is supplied as '*', number of retries before giving up is 5. If the password is sup‐
you will be prompted to enter the password when Conky starts. plied as '*', you will be prompted to enter the password when
Conky starts.
pop3_used (args) pop3_used (args)
Displays the amount of space (in MiB, 2^20) used in your global Displays the amount of space (in MiB, 2^20) used in your global
POP3 inbox by default. You can define individual POP3 inboxes POP3 inbox by default. You can define individual POP3 inboxes
seperately by passing arguments to this object. Arguments are: seperately by passing arguments to this object. Arguments are:
"host user pass [-i interval] [-p port] [-e command] [-r re‐ "host user pass [-i interval (in seconds)] [-p port] [-e com‐
tries]". Default port is 110, default interval is 5 minutes, and mand] [-r retries]". Default port is 110, default interval is 5
default number of retries before giving up is 5. If the password minutes, and default number of retries before giving up is 5. If
is supplied as '*', you will be prompted to enter the password the password is supplied as '*', you will be prompted to enter
when Conky starts. the password when Conky starts.
pre_exec shell command pre_exec shell command

4
doc/config_settings.xml
View File

@ -172,7 +172,7 @@
<varlistentry> <varlistentry>
<term><command><option>imap</option></command></term> <term><command><option>imap</option></command></term>
<listitem> <listitem>
Default global IMAP server. Arguments are: "host user pass [-i interval] [-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. Default global IMAP server. Arguments are: "host user pass [-i interval (in 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.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -394,7 +394,7 @@
<varlistentry> <varlistentry>
<term><command><option>pop3</option></command></term> <term><command><option>pop3</option></command></term>
<listitem> <listitem>
Default global POP3 server. Arguments are: "host user pass [-i interval] [-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. Default global POP3 server. Arguments are: "host user pass [-i interval (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.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>

8
doc/variables.xml
View File

@ -1198,7 +1198,7 @@
<option>(args)</option> <option>(args)</option>
</term> </term>
<listitem> <listitem>
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. Arguments are: "host user pass [-i interval] [-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. 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. Arguments are: "host user pass [-i interval (in 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.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -1208,7 +1208,7 @@
<option>(args)</option> <option>(args)</option>
</term> </term>
<listitem> <listitem>
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 object. Arguments are: "host user pass [-i interval] [-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. 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 object. Arguments are: "host user pass [-i interval (in 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.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -1957,7 +1957,7 @@
<option>(args)</option> <option>(args)</option>
</term> </term>
<listitem> <listitem>
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 object. Arguments are: "host user pass [-i interval] [-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. 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 object. Arguments are: "host user pass [-i interval (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.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>
@ -1968,7 +1968,7 @@
<option>(args)</option> <option>(args)</option>
</term> </term>
<listitem> <listitem>
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 this object. Arguments are: "host user pass [-i interval] [-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. 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 this object. Arguments are: "host user pass [-i interval (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.
<para></para></listitem> <para></para></listitem>
</varlistentry> </varlistentry>