| Variable | Arguments () = optional | Explanation |
|---|---|---|
| acpiacadapter | (adapter) | 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. |
| acpifan | ACPI fan state | |
| acpitemp | ACPI temperature in C. | |
| addr | (interface) | IP address for an interface, or "No Address" if no address is assigned. |
| addrs | (interface) | IP addresses for an interface (if one - works like addr). Linux only. |
| adt746xcpu | CPU temperature from therm_adt746x | |
| adt746xfan | Fan speed from therm_adt746x | |
| alignc | (num) | Align text to centre |
| alignr | (num) | Right-justify text, with space of N |
| apcupsd | host | Sets up the connection to apcupsd daemon. Prints nothing, defaults to localhost:3551 |
| apcupsd_cable | Prints the UPS connection type. | |
| apcupsd_charge | Current battery capacity in percent. | |
| apcupsd_lastxfer | Reason for last transfer from line to battery. | |
| apcupsd_linev | Nominal input voltage. | |
| apcupsd_load | Current load in percent. | |
| apcupsd_loadbar | Bar showing current load. | |
| apcupsd_loadgauge | (height),(width) | Gauge that shows current load. |
| apcupsd_loadgraph | (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) | History graph of current load. |
| apcupsd_model | Prints the model of the UPS. | |
| apcupsd_name | Prints the UPS user-defined name. | |
| apcupsd_status | Prints current status (on-line, on-battery). | |
| apcupsd_temp | Current internal temperature. | |
| apcupsd_timeleft | Time left to run on battery. | |
| apcupsd_upsmode | Prints the UPS mode (e.g. standalone). | |
| apm_adapter | Display APM AC adapter status (FreeBSD, OpenBSD only) | |
| apm_battery_life | Display APM battery life in percent (FreeBSD, OpenBSD only) | |
| apm_battery_time | Display remaining APM battery life in hh:mm:ss or "unknown" if AC adapterstatus is on-line or charging (FreeBSD, OpenBSD only) | |
| audacious_bar | (height),(width) | Progress bar |
| audacious_bitrate | Bitrate of current tune | |
| audacious_channels | Number of audio channels of current tune | |
| audacious_filename | Full path and filename of current tune | |
| audacious_frequency | Sampling frequency of current tune | |
| audacious_length | Total length of current tune as MM:SS | |
| audacious_length_seconds | Total length of current tune in seconds | |
| audacious_main_volume | The current volume fetched from Audacious | |
| audacious_playlist_length | Number of tunes in playlist | |
| audacious_playlist_position | Playlist position of current tune | |
| audacious_position | Position of current tune (MM:SS) | |
| audacious_position_seconds | Position of current tune in seconds | |
| audacious_status | Player status (Playing/Paused/Stopped/Not running) | |
| audacious_title | (max length) | Title of current tune with optional maximum length specifier |
| battery | (num) | Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0). |
| battery_bar | (height),(width) (num) | 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_percent | (num) | 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_short | (num) | 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_time | (num) | Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0). |
| blink | text_and_other_conky_vars | Let 'text_and_other_conky_vars' blink on and off. |
| bmpx_album | Album in current BMPx track | |
| bmpx_artist | Artist in current BMPx track | |
| bmpx_bitrate | Bitrate of the current BMPx track | |
| bmpx_title | Title of the current BMPx track | |
| bmpx_track | Track number of the current BMPx track | |
| bmpx_uri | URI of the current BMPx track | |
| buffers | Amount of memory buffered | |
| cached | Amount of memory cached | |
| cmdline_to_pid | string | PID of the first process that has string in it's commandline |
| cmus_aaa | Print aaa status of cmus (all/artist/album). | |
| cmus_album | Prints the album of the current cmus song. | |
| cmus_artist | Prints the artist of the current cmus song. | |
| cmus_curtime | Current time of the current cmus song. | |
| cmus_file | Print the file name of the current cmus song | |
| cmus_date | Print the date of the current cmus song | |
| cmus_genre | Print the genre name of the current cmus song | |
| cmus_percent | Percent of song's progress. | |
| cmus_progress | (height),(width) | cmus' progress bar. |
| cmus_random | Random status of cmus (on/off). | |
| cmus_repeat | Repeat status of cmus (song/all/off). | |
| cmus_state | Current state of cmus (playing, paused, stopped etc). | |
| cmus_timeleft | Time left of the current cmus song. | |
| cmus_title | Prints the title of the current cmus song. | |
| cmus_totaltime | Total length of the current cmus song. | |
| cmus_track | Print track number of current cmus song. | |
| color | (color) | Change drawing color to 'color' which is a name of a color or a hexcode preceded with # (for example #0A1B2C ). If you use ncurses only the following colors are supported: red,green,yellow,blue,magenta,cyan,black,white. |
| colorN | Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively. | |
| combine | var1 var2 | 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. |
| conky_build_arch | CPU architecture Conky was built for | |
| conky_build_date | Date Conky was built | |
| conky_version | Conky version | |
| cpu | (cpuN) | 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. |
| cpubar | (cpuN) (height),(width) | Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP. |
| cpugauge | (cpuN) (height),(width) | Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively. See $cpu for more info on SMP. |
| cpugraph | (cpuN) (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) | 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). |
| curl | url (interval_in_minutes) | 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. |
| desktop | Number of the desktop on which conky is running or the message "Not running in X" if this is the case. | |
| desktop_name | Name of the desktop on which conky is running or the message "Not running in X" if this is the case. | |
| desktop_number | Number of desktops or the message "Not running in X" if this is the case. | |
| disk_protect | device | Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding). |
| diskio | (device) | 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. |
| diskio_read | (device) | Displays current disk IO for reads. Device as in diskio. |
| diskio_write | (device) | Displays current disk IO for writes. Device as in diskio. |
| diskiograph | (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) | 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). |
| diskiograph_read | (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) | 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). |
| diskiograph_write | (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) | 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). |
| distribution | 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. | |
| downspeed | (net) | Download speed in suitable IEC units |
| downspeedf | (net) | Download speed in KiB with one decimal |
| downspeedgraph | (netdev) (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) | 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). |
| draft_mails | (maildir) | 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. |
| else | Text to show if any of the above are not true | |
| endif | Ends an $if block. | |
| entropy_avail | Current entropy available for crypto freaks | |
| entropy_bar | (height),(width) | Normalized bar of available entropy for crypto freaks |
| entropy_perc | Percentage of entropy available in comparison to the poolsize | |
| entropy_poolsize | Total size of system entropy pool for crypto freaks | |
| eval | string | 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. |
| eve | api_keyID api_vCode character_id | 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). |
| exec | command | 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. |
| execbar | (height),(width) | 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. |
| execgauge | (height),(width) | 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. |
| execgraph | command |
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} |
| execi | interval | 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. |
| execibar | interval | Same as execbar, but with an interval. |
| execigauge | interval | Same as execgauge, but with an interval. |
| execigraph | interval | Same as execgraph, but with an interval. |
| execp | command | 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. |
| execpi | interval | Same as execp, but with an interval. Note that the output from the $execpi command is still parsed and evaluated at every interval. |
| flagged_mails | (maildir) | 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. |
| font | (font) | 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 | seconds format | 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) |
| forwarded_mails | (maildir) | 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. |
| freq | (n) | Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1. |
| freq_g | (n) | Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1. |
| fs_bar | (height),(width) fs | 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. |
| fs_bar_free | (height),(width) fs | 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. |
| fs_free | (fs) | Free space on a file system available for users. |
| fs_free_perc | (fs) | Free percentage of space on a file system available for users. |
| fs_size | (fs) | File system size. |
| fs_type | (fs) | File system type. |
| fs_used | (fs) | File system used space. |
| fs_used_perc | (fs) | Percent of file system used space. |
| goto | x | The next element will be printed at position 'x'. |
| gw_iface | Displays the default route's interface or "multiple"/"none" accordingly. | |
| gw_ip | Displays the default gateway's IP or "multiple"/"none" accordingly. | |
| hddtemp | (dev) | 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. |
| head | logfile lines (next_check) | 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. |
| hr | (height) | Horizontal line, height is the height in pixels |
| hwmon | (dev) type n (factor offset) | 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 | (dev) type n (factor offset) | 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). |