ACPI ac adapter state. On linux, the adapter option specifies the
subfolder of /sys/class/power_supply containing the state information (tries "AC"
and "ADP1" if there is no argument given). Non-linux systems ignore it.
ACPI fan state
ACPI temperature in C.
IP address for an interface, or "No Address" if
no address is assigned.
IP addresses for an interface (if one - works
like addr). Linux only.
CPU temperature from therm_adt746x
Fan speed from therm_adt746x
Align text to centre
Right-justify text, with space of N
Sets up the connection to apcupsd daemon. Prints
nothing, defaults to localhost:3551
Prints the UPS connection type.
Current battery capacity in percent.
Reason for last transfer from line to battery.
Nominal input voltage.
Current load in percent.
Bar showing current load.
Gauge that shows current load.
History graph of current load.
Prints the model of the UPS.
Prints the UPS user-defined name.
Prints current status (on-line, on-battery).
Current internal temperature.
Time left to run on battery.
Prints the UPS mode (e.g. standalone).
Display APM AC adapter status (FreeBSD, OpenBSD only)
Display APM battery life in percent (FreeBSD, OpenBSD
only)
Display remaining APM battery life in hh:mm:ss or
"unknown" if AC adapterstatus is on-line or charging
(FreeBSD, OpenBSD only)
Progress bar
Bitrate of current tune
Number of audio channels of current tune
Full path and filename of current tune
Sampling frequency of current tune
Total length of current tune as MM:SS
Total length of current tune in seconds
The current volume fetched from Audacious
Number of tunes in playlist
Playlist position of current tune
Position of current tune (MM:SS)
Position of current tune in seconds
Player status (Playing/Paused/Stopped/Not
running)
Title of current tune with optional maximum
length specifier
Battery status and remaining percentage capacity
of ACPI or APM battery. ACPI battery number can be given as
argument (default is BAT0).
Battery percentage remaining of ACPI battery in a
bar. ACPI battery number can be given as argument (default
is BAT0, use all to get the mean percentage remaining for
all batteries).
Battery percentage remaining for ACPI battery.
ACPI battery number can be given as argument (default is
BAT0, use all to get the mean percentage remaining for
all batteries).
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, D for discharging, F for full, N for not present,
E for empty and U for unknown.
Battery charge/discharge time remaining of ACPI
battery. ACPI battery number can be given as argument
(default is BAT0).
Let 'text_and_other_conky_vars' blink on and off.
Album in current BMPx track
Artist in current BMPx track
Bitrate of the current BMPx track
Title of the current BMPx track
Track number of the current BMPx track
URI of the current BMPx track
Amount of memory buffered
Amount of memory cached
Reads a file and displays the contents in conky.
This is useful if you have an independent process
generating output that you want to include in conky.
Reads a file and displays the contents in conky.
This is useful if you have an independent process
generating output that you want to include in conky. This
differs from $cat in that it parses the contents of the
file, so you can insert things like ${color red}hi!${color}
in your file and have it correctly parsed by Conky.
PID of the first process that has string in it's
commandline
Print aaa status of cmus (all/artist/album).
Prints the album of the current cmus song.
Prints the artist of the current cmus song.
Current time of the current cmus song.
Print the file name of the current cmus song
Print the date of the current cmus song
Print the genre name of the current cmus song
Percent of song's progress.
cmus' progress bar.
Random status of cmus (on/off).
Repeat status of cmus (song/all/off).
Current state of cmus (playing, paused, stopped etc).
Time left of the current cmus song.
Prints the title of the current cmus song.
Total length of the current cmus song.
Print track number of current cmus song.
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.
Change drawing color to colorN configuration
option, where N is a digit between 0 and 9, inclusively.
Places the lines of var2 to the right of the
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.
CPU architecture Conky was built for
Date Conky was built
Conky version
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.
Bar that shows CPU usage, height is bar's height
in pixels. See $cpu for more info on SMP.
Elliptical gauge that shows CPU usage, height and
width are gauge's vertical and horizontal axis
respectively. See $cpu for more info on SMP.
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 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 positive floating
point value (0 is allowed), 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.
Disk protection status, if supported (needs
kernel-patch). Prints either "frozen" or "free " (note the
padding).
Displays current disk IO. Device is optional, and
takes the form of sda for /dev/sda. A block device label can
be specified with label:foo. Individual partitions are also
allowed.
Displays current disk IO for reads. Device as in
diskio.
Displays current disk IO for writes. Device as in
diskio.
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 -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).
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 -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).
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 -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).
The name of the distribution. It could be that some
of the untested distributions will show up wrong or as "unknown",
if that's the case post a bug on sourceforge, make sure it
contains the name of your distribution, the contents of
/proc/version and if there is a file that only exists on your
distribution, also add the path of that file in the bug. If there
is no such file, please add another way which we can use to identify
your distribution.
Download speed in suitable IEC units
Download speed in KiB with one decimal
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 -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).
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.
Text to show if any of the above are not true
Ends an $if block.
Current entropy available for crypto freaks
Normalized bar of available entropy for crypto
freaks
Percentage of entropy available in comparison to
the poolsize
Total size of system entropy pool for crypto
freaks
Evaluates given string according to the rules of
conky.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.
Fetches a character's currently training skill from
the Eve Online API servers (http://www.eveonline.com/) and
displays the skill along with the remaining training time.
If the character is not actively training a skill then returns
the empty string (for use with $if_empty).
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/C++
and posting a patch.
Same as exec, except if the first value returned is
a value between 0-100, it will use that number to draw a
horizontal bar. The height and width parameters are optional,
and default to the default_bar_height and default_bar_width
config settings, respectively.
Same as exec, except if the first value returned is
a value between 0-100, it will use that number to draw a
round gauge (much like a vehicle speedometer). The height and
width parameters are optional, and default to the
default_gauge_height and default_gauge_width config settings,
respectively.
Draws a horizontally scrolling graph with values
from 0-100 plotted on the vertical axis. All parameters
following the command are optional. Gradient colors can
be specified as hexadecimal values with no 0x or #
prefix. Use the -t switch to enable a temperature
gradient, so that small values are "cold" with color 1
and large values are "hot" with color 2. Without the -t
switch, the colors produce a horizontal gradient
spanning the width of the graph. The scale parameter
defines the maximum value of the graph. Use the -l
switch to enable a logarithmic scale, which helps to see
small values. The default size for graphs can be
controlled via the default_graph_height and
default_graph_width config settings.If you need to execute a command with spaces, you
have a couple options: 1) wrap your command in
double-quotes, or 2) put your command into a separate
file, such as ~/bin/myscript.sh, and use that as your
execgraph command. Remember to make your script
executable!In the following example, we set up execgraph to
display seconds (0-59) on a graph that is 50px high and 200px
wide, using a temperature gradient with colors ranging from red
for small values (FF0000) to yellow for large values (FFFF00).
We set the scale to 60.${execgraph ~/seconds.sh 50,200 FF0000
FFFF00 60 -t}Same as exec, but with a specific interval in
seconds. The interval can't be less than the update_interval
in your configuration. See also $texeci.
Same as execbar, but with an interval.
Same as execgauge, but with an interval.
Same as execgraph, but with an interval.
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/C++
and posting a patch. This differs from $exec in that it
parses the output of the command, so you can insert things
like ${color red}hi!${color} in your script and have it
correctly parsed by Conky. Caveats: Conky parses and
evaluates the output of $execp every time Conky loops, and
then destroys all the objects. If you try to use anything
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.
Same as execp, but with an interval. Note that
the output from the $execpi command is still parsed
and evaluated at every interval.
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.
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)
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)
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.
Returns CPU #n's frequency in MHz. CPUs are
counted from 1. If omitted, the parameter defaults to 1.
Returns CPU #n's frequency in GHz. CPUs are
counted from 1. If omitted, the parameter defaults to 1.
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.
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.
Free space on a file system available for users.
Free percentage of space on a file system
available for users.
File system size.
File system type.
File system used space.
Percent of file system used space.
The next element will be printed at position 'x'.
Displays the default route's interface or
"multiple"/"none" accordingly.
Displays the default gateway's IP or
"multiple"/"none" accordingly.
Displays temperature of a selected hard disk
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.
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.
Horizontal line, height is the height in pixels
Hwmon sensor from sysfs (Linux 2.6). Parameter
dev may be omitted if you have only one hwmon device.
Parameter type is either 'in' or 'vol' meaning voltage;
'fan' meaning fan; 'temp' meaning temperature. Parameter n
is number of the sensor. See /sys/class/hwmon/ on your
local computer. The optional arguments 'factor' and
'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).
I2C sensor from sysfs (Linux 2.6). Parameter dev
may be omitted if you have only one I2C device. Parameter
type is either 'in' or 'vol' meaning voltage; 'fan' meaning
fan; 'temp' meaning temperature. Parameter n is number of
the sensor. See /sys/bus/i2c/devices/ on your local
computer. The optional arguments 'factor' and '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).
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.
If running the i8k kernel driver for Inspiron
laptops, displays the bios version as listed in /proc/i8k.
If running the i8k kernel driver for Inspiron
laptops, displays the volume buttons status as listed in
/proc/i8k.
If running the i8k kernel driver for Inspiron
laptops, displays the cpu temperature in Celsius, as
reported by /proc/i8k.
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.
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.
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.
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.
If running the i8k kernel driver for Inspiron
laptops, displays your laptop serial number as listed in
/proc/i8k.
If running the i8k kernel driver for Inspiron
laptops, displays the version formatting of /proc/i8k.
If running the IBM ACPI, displays the brigtness
of the laptops's LCD (0-7).
If running the IBM ACPI, displays the fan speed.
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.
If running the IBM ACPI, displays the status of your
ThinkLight™. Value is either 'on', 'off' or 'unknown'.
If running the IBM ACPI, displays the "master"
volume, controlled by the volume keys (0-14).
Shows title of event number 'number' in the ical (RFC 5545) file
'file'. The events are first ordered by starting time, events that started
in the past are ignored. The events that are shown are the VEVENTS, the
title that is shown is the SUMMARY and the starting time used for sorting
is DTSTART .
Shows everything that's being told in #channel on IRCserver
'server'. TCP-port 6667 is used for the connection unless 'port' is
specified. Shows everything since the last time or the last
'max_msg_lines' entries if specified.
Convert text from one codeset to another using
GNU iconv. Needs to be stopped with iconv_stop.
Stop iconv codeset conversion.
if conky variable VAR is empty, display
everything between $if_empty and the matching $endif
if FILE exists, display everything between
if_existing and the matching $endif. The optional second
parameter checks for FILE containing the specified string
and prints everything between $if_existing and the matching
$endif.
if there is at least one default gateway, display
everything between $if_gw and the matching $endif
Evaluates the given boolean expression, printing
everything between $if_match and the matching $endif
depending on whether the evaluation returns true or not.
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:
doubleArgument consists of only
digits and a single dot.longArgument consists of only
digits.stringArgument is enclosed in
quotation marks (")Valid operands are: '>', '<', '>=',
'<=', '==', '!='.
If mixer exists, display everything between
$if_mixer_mute and the matching $endif. If no mixer is
specified, "Vol" is used.
if MOUNTPOINT is mounted, display everything
between $if_mounted and the matching $endif
if mpd is playing or paused, display everything
between $if_mpd_playing and the matching $endif
If Pulseaudio's default sink is muted, display everything
between $if_pa_sink_muted and the corresponding $else or $endif.
If PROCESS is running, display everything
between $if_running and the corresponding $else or $endif.
Note that PROCESS may be either a full command line with
arguments (without the directory prefix), or simply the name
of an executable. For example, either of the following will
be true if there is a running process with the command line
/usr/bin/conky -u 5:
${if_running conky -u 5} or
${if_running conky}
It is important not to include trailing spaces. For example,
${if_running conky } will be false.
when using smapi, if the battery with index INDEX
is installed, display everything between
$if_smapi_bat_installed and the matching $endif
if INTERFACE exists and is up, display everything
between $if_up and the matching $endif
If it's the UPDATENR-th time that conky updates,
display everything between $if_updatenr and the matching
$endif. The counter resets when the highest UPDATENR is
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.
Display everything between $if_xmms2_connected
and the matching $endif if xmms2 is running.
Renders an image from the path specified using
Imlib2. Takes 4 optional arguments: a position, a size, a
no-cache switch, and a cache flush interval. Changing the
x,y position will move the position of the image, and
changing the WxH will scale the image. If you specify the
no-cache flag (-n), the image will not be cached.
Alternately, you can specify the -f int switch to specify a
cache flush interval for a particular image. Example:
${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
pixels. Conky does not make any attempt to adjust the
position (or any other formatting) of images, they are just
rendered as per the arguments passed. The only reason
$image is part of the conky.text section, is to allow for runtime
modifications, through $execp $lua_parse, or some other
method.
Displays the number of messages in your global
IMAP inbox by default. You can define individual 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]". 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 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 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.
Prints the current ioscheduler used for the given
disk name (i.e. e.g. "hda" or "sdb")
Displays last N lines of the systemd journal. The optional
type can be 'user' or 'system' which will show only the user or system
journal respectively. By default, all journal lines visible to the user
are shown. A maximum of 200 lines can be displayed, or until the text
buffer is filled.
Kernel version
Git version numer (DragonFly only)
The value of /proc/sys/vm/laptop_mode
Displays the number of lines in the given file
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.
Load1 average graph, similar to xload, with
optional colours in hex, minus the #. Uses a logarithmic
scale (to see small numbers) when you use the -l switch.
Takes the switch '-t' to use a temperature gradient, which
makes the gradient values change depending on the amplitude
of a particular graph value (try it and see).
Executes a Lua function with given parameters,
then prints the returned string. 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.
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.
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. 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.
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). 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.
Executes a Lua function with given parameters as
per $lua, then parses and prints the result value as per
the syntax for the conky.text section. 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.
Machine, i686 for example
Mail count in the specified mailbox or your mail
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.
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"}
Amount of memory in use
Amount of memory in use, including that used by system buffers and caches
Bar that shows amount of memory in use
Bar that shows amount of memory in use (including memory used by system buffers and caches)
Amount of "dirty" memory (linux only)
Amount of free memory including the memory that
is very easily freed (buffers/cache)
Amount of free memory
Gauge that shows amount of memory in use (see
cpugauge)
Memory usage graph. Uses a logarithmic scale (to
see small numbers) when you use the -l switch. Takes the
switch '-t' to use a temperature gradient, which makes the
gradient values change depending on the amplitude of a
particular graph value (try it and see).
Total amount of memory
Percentage of memory in use
Prints the mixer value as reported by the OS.
On Linux, this variable uses the OSS emulation, so you
need the proper kernel module loaded.
Default mixer is "Vol", but you can specify one of the
available OSS controls: "Vol", "Bass", "Trebl", "Synth",
"Pcm", "Spkr", "Line", "Mic", "CD", "Mix", "Pcm2 ", "Rec",
"IGain", "OGain", "Line1", "Line2", "Line3", "Digital1",
"Digital2", "Digital3", "PhoneIn", "PhoneOut", "Video",
"Radio" and "Monitor".
Displays mixer value in a bar as reported by the
OS. See docs for $mixer for details on arguments.
Prints the left channel mixer value as reported
by the OS. See docs for $mixer for details on arguments.
Displays the left channel mixer value in a bar as
reported by the OS. See docs for $mixer for details on
arguments.
Prints the right channel mixer value as reported
by the OS. See docs for $mixer for details on arguments.
Displays the right channel mixer value in a bar
as reported by the OS. See docs for $mixer for details on
arguments.
Album of the current MOC song
Artist of the current MOC song
Bitrate in the current MOC song
Current time of the current MOC song
File name of the current MOC song
Rate of the current MOC song
The current song name being played in MOC.
Current state of MOC; playing, stopped etc.
Time left in the current MOC song
Title of the current MOC song
Total length of the current MOC song
Number of the monitor on which conky is running
or the message "Not running in X" if this is the case.
Number of monitors or the message "Not running in
X" if this is the case.
Album in current MPD song
Artist in current MPD song must be enabled at
compile
Artist of the album of the current MPD song.
Bar of mpd's progress
Bitrate of current song
Date of current song
Song's elapsed time
Prints the file name of the current MPD song
Song's length
Prints the MPD name field
Percent of song's progress
Random status (On/Off)
Repeat status (On/Off)
Prints the song name in either the form "artist -
title" or file name, depending on whats available
Playing, stopped, et cetera.
Title of current MPD song
Prints the MPD track field
MPD's volume
Shows the first field of the first row of the
result of the query.
Print a nameserver from /etc/resolv.conf. Index
starts at and defaults to 0.
Unread mail count in the specified mailbox or
mail spool if not. Both mbox and maildir type mailboxes are
supported.
Hostname
Short hostname (same as 'hostname -s' shell command).
Shows text and parses the vars in it, but doesn't
update them. Use this for things that do not change while conky
is running, like $machine, $conky_version,... By not updating
this you can save some resources.
Nvidia graphics card information via the XNVCtrl
library.
GPU_ID: Optional parameter to choose the GPU to be used as 0,1,2,3,.. Default parameter is 0
Possible arguments: (Temperatures are
printed as float, all other values as integer. Bracketed
arguments are aliases)
gputemp
(temp)
gputempthreshold
(threshold)
ambienttemp
(ambient)
gpufreqcur
(gpufreq)
gpufreqmingpufreqmaxmemfreqcur
(memfreq)
memfreqminmemfreqmaxmtrfreqcur
(mtrfreq)
mtrfreqminmtrfreqmaxperflevelcur
(perflevel)
perflevelminperflevelmaxperfmodegpuutilmembwutilvideoutilpcieutilmemused
(mem)
memfree
(memavail)
memmax
(memtotal)
memutil
(memperc)
fanspeedfanlevelimagequalitymodelnameSame as nvidia, except it draws its output in a
horizontal bar. The height and width parameters are optional,
and default to the default_bar_height and default_bar_width
config settings, respectively.
GPU_ID: Optional parameter to choose the GPU to be used as 0,1,2,3,.. Default parameter is 0
Note the following arguments are incompatible:gputempthreshold
(threshold)
gpufreqmingpufreqmaxmemfreqminmemfreqmaxmtrfreqminmtrfreqmaxperflevelminperflevelmaxperfmodememtotal
(memmax)
fanspeedSame as nvidiabar, except a round gauge
(much like a vehicle speedometer). The height
and width parameters are optional, and default to the
default_gauge_height and default_gauge_width config
settings, respectively.
GPU_ID: Optional parameter to choose the GPU to be used as 0,1,2,3,.. Default parameter is 0
For possible arguments see nvidia and nvidiabar.
Same as nvidiabar, except a horizontally
scrolling graph with values from 0-100 plotted on the
vertical axis. The height and width parameters are
optional, and default to the default_graph_height and
default_graph_width config settings, respectively.
GPU_ID: NOT optional. This parameter allows to choose the GPU to be used as 0,1,2,3,..
For possible arguments see nvidia and nvidiabar. To learn more
about the -t -l and gradient color options,
see execgraph.
Move text over by N pixels. See also $voffset.
Change outline color
Pulseaudio's default sink volume percentage.
Pulseaudio's default sink volume bar.
Pulseaudio's default sink description.
Pulseaudio's default sink active port name.
Pulseaudio's default sink active port description.
Pulseaudio's default card name.
Pulseaudio's default card active profile.
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:
statuspercenttimeDirectory 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
Platform sensor from sysfs (Linux 2.6). Parameter
dev may be omitted if you have only one platform device.
Platform type is either 'in' or 'vol' meaning voltage;
'fan' meaning fan; 'temp' meaning temperature. Parameter n
is number of the sensor. See /sys/bus/platform/devices/ on
your local computer. The optional arguments 'factor' and
'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).
Displays the number of unseen messages in your
global POP3 inbox by default. You can define 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
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 separately 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.
Total processes (sleeping and running)
Connects to a tcp port on a host (default is
localhost), reads every char available at the moment and
shows them.
Connects to a udp port on a host (default is
localhost), reads every char available at the moment and
shows them.
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.
Download and parse RSS feeds. The interval may be
a (floating point) value greater than 0.
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.
Running processes (not sleeping), requires Linux
2.6
Number of running (runnable) threads. Linux only.
Scroll 'text' by 'step' characters to the left
or right (set 'direction' to 'left' or 'right' or 'wait')
showing 'length' number of characters at the same time. The
text may also contain variables. 'step' is optional and
defaults to 1 if not set. 'direction' is optional and defaults
to left if not set. When direction is 'wait' then text will
scroll left and wait for 'interval' itertations at the
beginning and end of the text. If a var creates output on
multiple lines then the lines are placed behind each other
separated with 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 unless direction is
'wait'.
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.
Prints info regarding System Integrity Protection (SIP) on macOS.
If no switch is provided, prints SIP status (enabled / disabled), else,
status of the specific SIP feature corresponding to the switch provided.
Below are shown the available switches:
SWITCH--------------------------RESULT--------------------------STATUS
0 apple internal YES/NO
1 forbid untrusted kexts YES/NO
2 forbid task-for-pid YES/NO
3 restrict filesystem YES/NO
4 forbid kernel-debugger YES/NO
5 restrict dtrace YES/NO
6 restrict nvram YES/NO
7 forbid device-configuration YES/NO
8 forbid any-recovery-os YES/NO
9 forbid user-approved-kexts YES/NO
a uses unsupported configuration? (*)
(*): If yes, prints "unsupported configuration, beware!"
Else, prints "configuration is ok".
----------------------------------------------------------------------
USAGE:
conky -t '${sip_status}' # print SIP status
conky -t '${sip_status 0}' # print allows apple-internal? Yes or No?
NOTES:
* Available for all macOS versions (even the ones prior El Capitan
where SIP was first introduced)
* If run on versions prior El Capitan SIP is unavailable, so all
you will get is "unsupported"
Change shading color
when using smapi, display contents of the
/sys/devices/platform/smapi directory. ARGS are either
'(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.
when using smapi, display the remaining capacity
of the battery with index INDEX as a bar.
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.
when using smapi, display the current power of
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.
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.
Displays the Sony VAIO fanspeed information if
sony-laptop kernel support is enabled. Linux only.
Stippled (dashed) horizontal line
Displays the data of a stock symbol. The following data
is supported: adv(Average Daily Volume), ask, asksize, bid, askrt(ask realtime), bidrt(bid realtime), bookvalue, bidsize, change, commission, changert(change realtime), ahcrt(After Hours Change realtime), ds(dividend/share), ltd(Last Trade Date), tradedate, es(earnings/share), ei(error indication), epsecy(EPS Estimate Current Year), epseny(EPS Estimate Next Year), epsenq(EPS Estimate Next Quarter), floatshares, dayslow, dayshigh, 52weeklow, 52weekhigh, hgp(Holdings Gain Percent), ag(Annualized Gain), hg(Holdings Gain), hgprt(Holdings Gain Percent realtime), hgrt(Holdings Gain realtime), moreinfo, obrt(Order Book realtime), mc(Market Capitalization), mcrt(Market Cap realtime), ebitda, c52wlow(Change From 52-week Low), pc52wlow(Percent Change From 52-week Low), cprt(change percent realtime), lts(Last Trade Size), c52whigh(Change from 52-week high), pc52whigh(percent change from 52-week high), ltp(last trade price), hl(high limit), ll(low limit), dr(day's range), drrt(day's range realtime), 50ma(50-day Moving Average), 200ma(200-day Moving Average), c200ma(Change From 200-day Moving Average), pc200ma(Percent Change From 200-day Moving Average), c50ma(Change From 50-day Moving Average), pc50ma(Percent Change From 50-day Moving Average), name, notes, open, pc(previous close), pricepaid, cip(change in percent), ps(price/sales), pb(price/book), edv(Ex-Dividend Date), per(P/E Ratio), dpd(Dividend Pay Date), perrt(P/E Ratio realtime), pegr(PEG Ratio), pepsecy(Price/EPS Estimate Current Year), pepseny(Price/EPS Estimate Next Year), symbol, sharesowned, shortratio, ltt(Last Trade Time), tradelinks, tt(Ticker Trend), 1ytp(1 yr Target Price), volume, hv(Holdings Value), hvrt(Holdings Value realtime), 52weekrange, dvc(Day's Value Change), dvcrt(Day's Value Change realtime), se(Stock Exchange), dy(Dividend Yield)
Amount of swap in use
Bar that shows amount of swap in use
Amount of free swap
Total amount of swap
Percentage of swap in use
System name, Linux for example
Puts a tab of the specified width, starting from
column 'start'. The unit is pixels for both arguments.
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.
Displays the number of microseconds it takes to
get a reply on a ping to to tcp 'port' on 'host'. 'port' is optional
and has 80 as default. This works on both open and closed
ports, just make sure that the port is not behind a firewall or you
will get 'down' as answer. It's best to test a closed port instead
of an open port, you will get a quicker response.
TCP port (both IPv6 and IPv4) monitor for
specified local ports. Port numbers must be in
the range 1 to 65535. Valid items are:countriprhostrportrserviceliplhostlportlserviceThe 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.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, note they are placed between [[ ... ]] instead of ' ... ':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:
using templatesame without template${template0 node name}$nodename${template1 root /}root: ${fs_free /} / ${fs_size
/}
${template1
${template2\ disk\ root}
/}
disk root:
${fs_free /} / ${fs_size
/}
Runs a command at an interval inside a thread and
displays the output. Same as $execi, except the command is
run inside a thread. Use this if you have a slow script to
keep Conky updating. You should make the interval slightly
longer than 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. 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.
Same as execpi, except the command is run inside
a thread.
Total threads
Local time, see man strftime to get more
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'.
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", "time", "uid", "user", "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
Same as top, except sorted by mem usage instead
of cpu
Same as top, except sorted by total CPU time
instead of current CPU usage
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.
Total upload, this one too, may overflow
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.
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.
Name of group with this gid
Username of user with this uid
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.
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.
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.
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.
for debugging
Upload speed in suitable IEC units
Upload speed in KiB with one decimal
Upload speed graph, colours defined in hex, minus
the #. If scale is non-zero, it becomes the scale for the
graph. Uses a logarithmic scale (to see small numbers) when
you use the -l switch. Takes the switch '-t' to use a
temperature gradient, which makes the gradient values
change depending on the amplitude of a particular graph
value (try it and see).
Uptime
Uptime in a shorter format
Lists the names of the users logged in
Number of users logged in
Lists the consoles in use
Lists how long users have been logged in for
Lists how long the user for the given console has been
logged in for
Display time in UTC (universal coordinate time).
IPv6 addresses for an interface, followed by
netmask if -n is specified and scope with -s. Scopes are
Global(G), Host-local(H), Link-local(L), Site-local(S), Compat(C)
and Unspecified(/). Linux only.
Change vertical offset by N pixels. Negative
values will cause text to overlap. See also $offset.
Returns CPU #n's voltage in mV. CPUs are counted
from 1. If omitted, the parameter defaults to 1.
Returns CPU #n's voltage in V. CPUs are counted
from 1. If omitted, the parameter defaults to 1.
Download, parse and display METAR data.'URI' must be a valid METAR URI.
http://tgftp.nws.noaa.gov/data/observations/metar/stations/'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_updateThe 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.temperatureAir temperature (you can use the
'temperature_unit' config setting to change
units)cloud_coverThe highest cloud cover statuspressureAir pressure in millibarwind_speedWind speed in km/hwind_dirWind directionwind_dir_DEGCompass wind directionhumidityRelative humidity in %weatherAny 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 oneiconWeather 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', http://xoap.weather.com/weather/local/ is
deprecated. Please suggest a new URI in
https://github.com/brndnmtthws/conky/issues/313. 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:daydatelowhiiconforecastwind_speedwind_dirwind_dir_DEGhumidityprecipitation'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 bitrate (ie 11 Mb/s) (Linux only)
WLAN channel on which device 'net' is listening (Linux only)
Wireless access point ESSID (Linux only)
Frequency on which device 'net' is listening (Linux only)
Wireless link quality bar (Linux only)
Wireless link quality (Linux only)
Wireless link quality maximum value (Linux only)
Wireless link quality in percents (Linux only)
Wireless mode (Managed/Ad-Hoc/Master) (Linux
only)
Displays the number of words in the given file
Album in current XMMS2 song
Artist in current XMMS2 song
Bar of XMMS2's progress
Bitrate of current song
Comment in current XMMS2 song
Returns song's date.
Duration of current song
Song's elapsed time
Genre in current XMMS2 song
XMMS2 id of current song
Percent of song's progress
Returns the XMMS2 playlist.
Size of current song
Prints the song name in either the form "artist -
title" or file name, depending on whats available
XMMS2 status (Playing, Paused, Stopped, or
Disconnected)
Number of times a song was played (presumably).
Title in current XMMS2 song
Track number in current XMMS2 song
Full path to current song