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_status (num) Battery status for ACPI battery. ACPI battery number can be given as argument (default is BAT0).

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.

buffers Amount of memory buffered.

cached Amount of memory cached.

cat file 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.

catp file 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.

cmdline_to_pid string PID of the first process that has string in its 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 #, e.g. #0A1B2C. If you use ncurses only the following colors are supported: red, green, yellow, blue, magenta, cyan, black, and 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 and a block device partuuid can be specified with partuuid:40000000-01.

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.

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).

fontN Change font to fontN configuration option, where N is a digit between 0 and 9, inclusively.

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 unit lower than 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.

freq2 (n) Returns CPU #n's clock speed from assembly in MHz. 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.

github_notifications Number of GitHub notifications.

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 can be: 1) Number. e.g '1' means hwmon1. 2) Module name. e.g. 'k10temp' means the first hwmon device whose module name is 'k10temp. 3) Omitted. Then the first hwmon device (hwmon0) will be used. 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).

iface (number) Display interface names starting from 1, eg ${iface 1}.

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).

i8k_ac_status 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.

i8k_bios If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.

i8k_buttons_status If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.

i8k_cpu_temp If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.

i8k_left_fan_rpm 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.

i8k_left_fan_status 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.

i8k_right_fan_rpm 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.

i8k_right_fan_status 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.

i8k_serial If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.

i8k_version If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.

ibm_brightness If running the IBM ACPI, displays the brigtness of the laptops's LCD (0-7).

ibm_fan If running the IBM ACPI, displays the fan speed.

ibm_temps N 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.

ibm_thinklight If running the IBM ACPI, displays the status of your ThinkLight™. Value is either 'on', 'off' or 'unknown'.

ibm_volume If running the IBM ACPI, displays the "master" volume, controlled by the volume keys (0-14).

ical number file 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.

irc server(:port) #channel (max_msg_lines) 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.

iconv_start codeset_from codeset_to Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.

iconv_stop Stop iconv codeset conversion.

if_empty (var) if conky variable VAR is empty, display everything between $if_empty and the matching $endif.

if_existing file (string) 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_gw if there is at least one default gateway, display everything between $if_gw and the matching $endif.

if_match expression 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:
  • double - Argument consists of only digits and a single dot.
  • long - Argument consists of only digits.
  • string - Argument is enclosed in quotation marks. (")
Valid operands are: '>', '<', '>=', '<=', '==', '!='.

if_mixer_mute (mixer) If mixer exists, display everything between $if_mixer_mute and the matching $endif. If no mixer is specified, "Vol" is used.

if_mounted (mountpoint) if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif.

if_mpd_playing if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif.

if_pa_sink_muted If Pulseaudio's default sink is muted, display everything between $if_pa_sink_muted and the corresponding $else or $endif.

if_running (process) 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.

if_smapi_bat_installed (INDEX) when using smapi, if the battery with index INDEX is installed, display everything between $if_smapi_bat_installed and the matching $endif.

if_up (interface) if INTERFACE exists and is up, display everything between $if_up and the matching $endif.

if_updatenr (updatenr) 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.

if_xmms2_connected Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.

image <path to image> (-p x,y) (-s WxH) (-n) (-f interval) 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.

imap_messages (args) 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.

imap_unseen (args) 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.

ioscheduler disk Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb").

journal lines (type) 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 Kernel version.

key_caps_lock An indicator for Capital Lock key.

key_num_lock An indicator for Number Lock key.

key_scroll_lock An indicator for Scrolling Lock key.

keyboard_layout Display keyboard layout.

version Git version number. DragonFly only.

laptop_mode The value of /proc/sys/vm/laptop_mode.

lines textfile Displays the number of lines in the given file.

loadavg (1|2|3) 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.

loadgraph (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) 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).

lua function_name (function parameters) 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.

lua_bar (height, width) function_name (function parameters) 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.

lua_gauge (height, width) function_name (function parameters) 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.

lua_graph function_name (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) 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.

lua_parse function_name (function parameters) 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 Machine, e.g. i686, x86_64.

mails (mailbox) 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.

mboxscan (-n number of messages to print) (-fw from width) (-sw subject width) mbox 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"}

mem Amount of memory in use.

memwithbuffers Amount of memory in use, including that used by system buffers and caches.

membar (height),(width) Bar that shows amount of memory in use.

memwithbuffersbar (height),(width) Bar that shows amount of memory in use (including memory used by system buffers and caches).

memwithbuffersgraph (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) Memory usage graph including memory used by system buffers and cache. 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).

memdirty Amount of "dirty" memory. Linux only.

memeasyfree Amount of free memory including the memory that is very easily freed (buffers/cache).

memfree Amount of free memory.

memgauge (height),(width) Gauge that shows amount of memory in use (see cpugauge).

memgraph (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (-l) 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).

memmax Total amount of memory.

memperc Percentage of memory in use.

mixer (device) 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".

mixerbar (device) Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.

mixerl (device) Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.

mixerlbar (device) Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.

mixerr (device) Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.

mixerrbar (device) Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.

moc_album Album of the current MOC song.

moc_artist Artist of the current MOC song.

moc_bitrate Bitrate in the current MOC song.

moc_curtime Current time of the current MOC song.

moc_file File name of the current MOC song.

moc_rate Rate of the current MOC song.

moc_song The current song name being played in MOC.

moc_state Current state of MOC; playing, stopped etc.

moc_timeleft Time left in the current MOC song.

moc_title Title of the current MOC song.

moc_totaltime Total length of the current MOC song.

monitor Number of the monitor on which conky is running or the message "Not running in X" if this is the case.

monitor_number Number of monitors or the message "Not running in X" if this is the case.

mouse_speed Display mouse speed.

mpd_album Album in current MPD song.

mpd_artist Artist in current MPD song must be enabled at compile.

mpd_albumartist Artist of the album of the current MPD song.

mpd_bar (height),(width) Bar of mpd's progress.

mpd_bitrate Bitrate of current song.

mpd_date Date of current song.

mpd_elapsed Song's elapsed time.

mpd_file Prints the file name of the current MPD song.

mpd_length Song's length.

mpd_name Prints the MPD name field.

mpd_percent Percent of song's progress.

mpd_random Random status (On/Off).

mpd_repeat Repeat status (On/Off).

mpd_smart (max length) Prints the song name in either the form "artist - title" or file name, depending on whats available.

mpd_status Playing, stopped, et cetera.

mpd_title (max length) Title of current MPD song.

mpd_comment (max length) Comment of current MPD song.

mpd_track Prints the MPD track field.

mpd_vol MPD's volume.

mysql query Shows the first field of the first row of the result of the query.

nameserver (index) Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.

new_mails (mailbox) Unread mail count in the specified mailbox or mail spool if not. Both mbox and maildir type mailboxes are supported.

nodename Hostname.

nodename_short Short hostname (same as 'hostname -s' shell command).

no_update text 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 argument 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) GPU temperature gputempthreshold( threshold) Temperature threshold where the GPU will reduce it's clock speed ambienttemp( ambient) Ambient temperature outside the graphics card gpufreqcur( gpufreq) Current GPU clock speed gpufreqmin Minimum GPU clock speed gpufreqmax Maximum GPU clock speed memfreqcur( memfreq) Current memory clock speed memfreqmin Minimum memory clock speed memfreqmax Maximum memory clock speed mtrfreqcur( mtrfreq) Current memory transfer rate clock speed mtrfreqmin Minimum memory transfer rate clock speed mtrfreqmax Maximum memory transfer rate clock speed perflevelcur( perflevel) Current performance level perflevelmin Lowest performance level perflevelmax Highest performance level perfmode Performance mode gpuutil GPU utilization % membwutil Memory bandwidth utilization % videoutil Video engine utilization % pcieutil PCIe bandwidth utilization % memused( mem) Amount of used memory memfree( memavail) Amount of free memory memmax( memtotal) Total amount of memory memutil( memperc) Memory utilization % fanspeed Fan speed fanlevel Fan level % imagequality Image quality modelname name of the GPU card driverversion Driver version

nvidiabar (height),(width) Same 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) gpufreqmin gpufreqmax memfreqmin memfreqmax mtrfreqmin mtrfreqmax perflevelmin perflevelmax perfmode memtotal( memmax) fanspeed

nvidiagauge (height),(width) Same 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.

nvidiagraph argument 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.

offset (pixels) Move text over by N pixels. See also $voffset.

outlinecolor (color) Change outline color.

password (length) Generate random passwords.

pa_sink_volume Pulseaudio's default sink volume percentage.

pa_sink_volumebar Pulseaudio's default sink volume bar.

pa_sink_description Pulseaudio's default sink description.

pa_sink_active_port_name Pulseaudio's default sink active port name.

pa_sink_active_port_description Pulseaudio's default sink active port description.

pa_card_name Pulseaudio's default card name.

pa_card_active_profile Pulseaudio's default card active profile.

pb_battery item 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:
  • status - Display if battery is fully charged, charging, discharging or absent (running on AC)
  • percent - Display charge of battery in percent, if charging or discharging. Nothing will be displayed, if battery is fully charged or absent.
  • time - Display the time remaining until the battery will be fully charged or discharged at current rate. Nothing is displayed, if battery is absent or if it's present but fully charged and not discharging.

pid_chroot pid Directory used as rootdirectory by the process (this will be "/" unless the process did a chroot syscall).

pid_cmdline pid Command line this process was invoked with.

pid_cwd pid Current working directory of the process.

pid_environ pid varname Contents of a environment-var of the process.

pid_environ_list pid List of environment-vars that the process can see.

pid_exe pid Path to executed command that started the process.

pid_nice pid The nice value of the process.

pid_openfiles pid List of files that the process has open.

pid_parent pid The pid of the parent of the process.

pid_priority pid The priority of the process (see 'priority' in "man 5 proc").

pid_read pid Total number of bytes read by the process.

pid_state pid State of the process.

pid_state_short pid 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.

pid_stderr pid Filedescriptor binded to the STDERR of the process.

pid_stdin pid Filedescriptor binded to the STDIN of the process.

pid_stdout pid Filedescriptor binded to the STDOUT of the process.

pid_threads pid Number of threads in process containing this thread.

pid_thread_list pid List with pid's from threads from this process.

pid_time_kernelmode pid Amount of time that the process has been scheduled in kernel mode in seconds.

pid_time_usermode pid Amount of time that the process has been scheduled in user mode in seconds.

pid_time pid Sum of $pid_time_kernelmode and $pid_time_usermode.

pid_uid pid The real uid of the process.

pid_euid pid The effective uid of the process.

pid_suid pid The saved set uid of the process.

pid_fsuid pid The file system uid of the process.

pid_gid pid The real gid of the process.

pid_egid pid The effective gid of the process.

pid_sgid pid The saved set gid of the process.

pid_fsgid pid The file system gid of the process.

pid_vmpeak pid Peak virtual memory size of the process.

pid_vmsize pid Virtual memory size of the process.

pid_vmlck pid Locked memory size of the process.

pid_vmhwm pid Peak resident set size ("high water mark") of the process.

pid_vmrss pid Resident set size of the process.

pid_vmdata pid Data segment size of the process.

pid_vmstk pid Stack segment size of the process.

pid_vmexe pid Text segment size of the process.

pid_vmlib pid Shared library code size of the process.

pid_vmpte pid Page table entries size of the process.

pid_write pid Total number of bytes written by the process.

platform (dev) type n (factor offset) 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).

pop3_unseen (args) 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.

pop3_used (args) 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.

processes Total processes (sleeping and running).

read_tcp (host) port Connects to a tcp port on a host (default is localhost), reads every char available at the moment and shows them.

read_udp (host) port Connects to a udp port on a host (default is localhost), reads every char available at the moment and shows them.

replied_mails (maildir) 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.

rss uri interval_in_seconds action (num_par (spaces_in_front)) 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 Running processes (not sleeping). Requires Linux 2.6.

running_threads Number of running (runnable) threads. Linux only.

scroll (direction) length (step) (interval) text 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'.

seen_mails (maildir) 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.

sip_status (switch) 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 YE