Use this to create aliases of variables. The first argument is the new name, the second the old name, and the other arguments are passed on to the variable. Example: If you want to use $alpha instead of ${beta gamma delta} then you have to write the following: alias alpha beta gamma delta . PS: Instead of creating an alias in the config you can also use environment variables. Example: Start conky like this: alpha="beta gamma delta" conky
Aligned position on screen, may be top_left, top_right, top_middle, bottom_left, bottom_right, bottom_middle, middle_left, middle_right, or none (also can be abreviated as tl, tr, tm, bl, br, bm, ml, mr)
.TP
\fB\*(T<\fBbackground\fR\*(T>\fR
Boolean value, if true, Conky will be forked to background when started
.TP
\fB\*(T<\fBborder_margin\fR\*(T>\fR
Border margin in pixels
.TP
\fB\*(T<\fBborder_width\fR\*(T>\fR
Border width in pixels
.TP
\fB\*(T<\fBcolorN\fR\*(T>\fR
Predefine a color for use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively. When specifying the color value in hex, omit the leading hash (#).
.TP
\fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
The number of samples to average for CPU monitoring
.TP
\fB\*(T<\fBtop_cpu_separate\fR\*(T>\fR
If true, cpu in top will show usage of one processor's power. If false, cpu in top will show the usage of all processors' power combined.
Specify a default width and height for bars. Example: 'default_bar_size 0 6'. This is particularly useful for execbar and execibar as they do not take size arguments
.TP
\fB\*(T<\fBdefault_graph_size\fR\*(T>\fR
Specify a default width and height for graphs. Example: 'default_graph_size 0 25'. This is particularly useful for execgraph and execigraph as they do not take size arguments
.TP
\fB\*(T<\fBdefault_gauge_size\fR\*(T>\fR
Specify a default width and height for gauges. Example: 'default_gauge_size 25 25'. This is particularly useful for execgauge and execigauge as they do not take size arguments
Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
.TP
\fB\*(T<\fBdraw_borders\fR\*(T>\fR
Draw borders around text?
.TP
\fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
Draw borders around graphs?
.TP
\fB\*(T<\fBdraw_outline\fR\*(T>\fR
Draw outlines?
.TP
\fB\*(T<\fBdraw_shades\fR\*(T>\fR
Draw shades?
.TP
\fB\*(T<\fBfont\fR\*(T>\fR
Font name in X, xfontsel can be used to get a nice font
.TP
\fB\*(T<\fBgap_x\fR\*(T>\fR
Gap, in pixels, between right or left border of screen, same as passing -x at command line,
e.g. gap_x 10
.TP
\fB\*(T<\fBgap_y\fR\*(T>\fR
Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
e.g. gap_y 10.
.TP
\fB\*(T<\fBif_up_strictness\fR\*(T>\fR
How strict should if_up be when testing an interface for being up? The value is one of up, link or address, to check for the interface being solely up, being up and having link or being up, having link and an assigned IP address.
.TP
\fB\*(T<\fBimap\fR\*(T>\fR
Default global IMAP server. Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command] [-r retries]". Default port is 143, default folder is 'INBOX', default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
Size of the standard text buffer (default is 256 bytes). This buffer is used for intermediary text, such as individual lines, output from $exec vars, and various other variables. Increasing the size of this buffer can drastically reduce Conky's performance, but will allow for more text display per variable. The size of this buffer cannot be smaller than the default value of 256 bytes.
If own_window_transparent no, set a specified background colour (defaults to black). Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
Pad percentages to this many decimals (0 = no padding)
.TP
\fB\*(T<\fBpop3\fR\*(T>\fR
Default global POP3 server. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
.TP
\fB\*(T<\fBshort_units\fR\*(T>\fR
Shortens units to a single character (kiB->k, GiB->G, etc.). Default is off.
.TP
\fB\*(T<\fBshow_graph_scale\fR\*(T>\fR
Shows the maximum value in scaled graphs.
.TP
\fB\*(T<\fBshow_graph_range\fR\*(T>\fR
Shows the time range covered by a graph.
.TP
\fB\*(T<\fBstippled_borders\fR\*(T>\fR
Border stippling (dashing) in pixels
.TP
\fB\*(T<\fBtemperature_unit\fR\*(T>\fR
Desired output unit of all objects displaying a temperature.
Parameters are either "fahrenheit" or "celsius". The default
unit is degree Celsius.
.TP
\fB\*(T<\fBtemplateN\fR\*(T>\fR
Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
but before some substitutions are applied:
\&'\en' -> newline
.br
\&'\e\e' -> backslash
.br
\&'\e ' -> space
.br
\&'\eN' -> template argument N
.TP
\fB\*(T<\fBtotal_run_times\fR\*(T>\fR
Total number of times for Conky to update before quitting. Zero makes Conky run forever
.TP
\fB\*(T<\fBupdate_interval\fR\*(T>\fR
Update interval in seconds
.TP
\fB\*(T<\fBuppercase\fR\*(T>\fR
Boolean value, if true, text is rendered in upper case
.TP
\fB\*(T<\fBuse_spacer\fR\*(T>\fR
Adds spaces around certain objects to stop them from moving other things around. Arguments are left, right, and none (default). The old true/false values are deprecated and default to right/none respectively. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
.TP
\fB\*(T<\fBuse_xft\fR\*(T>\fR
Use Xft (anti-aliased font and stuff)
.TP
\fB\*(T<\fBxftalpha\fR\*(T>\fR
Alpha of Xft font. Must be a value at or between 1 and 0.
After this begins text to be formatted on screen. Backslash (\e) escapes newlines in the text section. This can be useful for cleaning up config files where conky is used to pipe input to dzen2.
Places the lines of var2 to the right of the lines of var1 seperated by the chars that are put between var1 and var2. For 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 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.
CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
Disk IO graph for reads, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
Disk IO graph for writes, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
Evalutates given string according to the rules of TEXT interpretation, i.e. parsing any contained text object specifications into their output, any occuring '$$' into a single '$' and so on. The output is then being parsed again.
Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for bars can be controlled via the default_bar_size config setting.
Same as exec, except if the first value returned is a value between 0-100, it will use that number for a gauge. The size for gauges can be controlled via the default_gauge_size config setting.
Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100. The size for graphs can be controlled via the default_graph_size config setting.
Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch. 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 specific interval. Interval can't be less than update_interval in configuration. Note that the output from the $execpi command is still parsed and evaluated at every interval.
.TP
\fB\*(T<\fBfont\fR\*(T>\fR\*(T<\fB(font)\fR\*(T>
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)
.TP
\fB\*(T<\fBfreq\fR\*(T>\fR\*(T<\fB(n)\fR\*(T>
Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
.TP
\fB\*(T<\fBfreq_g\fR\*(T>\fR\*(T<\fB(n)\fR\*(T>
Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
Displays first N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
.TP
\fB\*(T<\fBhr\fR\*(T>\fR\*(T<\fB(height)\fR\*(T>
Horizontal line, height is the height in pixels
.TP
\fB\*(T<\fBhwmon\fR\*(T>\fR\*(T<\fB(dev) type n\fR\*(T>
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.
Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
.TP
\fB\*(T<\fBiconv_stop\fR\*(T>\fR
Stop iconv codeset conversion.
.TP
\fB\*(T<\fBi2c\fR\*(T>\fR\*(T<\fB(dev) type n\fR\*(T>
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.
.TP
\fB\*(T<\fBi8k_ac_status\fR\*(T>\fR
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.
.TP
\fB\*(T<\fBi8k_bios\fR\*(T>\fR
If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
.TP
\fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR
If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
.TP
\fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR
If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
.TP
\fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR
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.
.TP
\fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR
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.
.TP
\fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR
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.
.TP
\fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR
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.
.TP
\fB\*(T<\fBi8k_serial\fR\*(T>\fR
If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
.TP
\fB\*(T<\fBi8k_version\fR\*(T>\fR
If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
.TP
\fB\*(T<\fBibm_fan\fR\*(T>\fR
If running the IBM ACPI, displays the fan speed.
.TP
\fB\*(T<\fBibm_temps\fR\*(T>\fR\*(T<\fBN\fR\*(T>
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.
.TP
\fB\*(T<\fBibm_volume\fR\*(T>\fR
If running the IBM ACPI, displays the "master" volume,
controlled by the volume keys (0-14).
.TP
\fB\*(T<\fBibm_brightness\fR\*(T>\fR
If running the IBM ACPI, displays the brigtness of the
Displays the number of messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
Displays the number of unseen messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 143, 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.
Load1 average graph, similar to xload, with optional colours in hex, minus the #. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
\fB\*(T<\fBmboxscan\fR\*(T>\fR\*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T>
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"}
Prints the mixer value as reported by the OS. Default mixer is "vol", but you can specify one of the following optional arguments: "vol", "bass", "treble", "synth", "pcm", "speaker", "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin", "phout", "video", "radio", "monitor". Refer to the definition of SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <soundcard.h> (on OpenBSD), or <sys/soundcard.h> to find the exact options available on your system.
specifies, what information to display. Exactly one item
must be specified. Valid items are:
\fBstatus\fR:
Display if battery is fully charged, charging,
discharging or absent (running on AC)
.br
\fBpercent\fR:
Display charge of battery in percent, if
charging or discharging. Nothing will be
displayed, if battery is fully charged
or absent.
.br
\fBtime\fR:
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.
.TP
\fB\*(T<\fBplatform\fR\*(T>\fR\*(T<\fB(dev) type n\fR\*(T>
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.
Displays the number of unseen messages in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
Scroll 'text' by 'step' characters 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. If a var creates output on multiple lines then the lines are placed behind each other separated with a '|'-sign. Do NOT use vars that change colors or otherwise affect the design inside a scrolling text. If you want spaces between the start and the end of 'text', place them at the end of 'text' not at the front ("foobar" and " foobar" can both generate "barfoo" but "foobar " will keep the spaces like this "bar foo").
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 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.
\fB\*(T<\fBtcp_portmon\fR\*(T>\fR\*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR
TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
\fBcount\fR - total number of connections in the range
.br
\fBrip\fR - remote ip address
.br
\fBrhost\fR - remote host name
.br
\fBrport\fR - remote port number
.br
\fBrservice\fR - remote service name from /etc/services
.br
\fBlip\fR - local ip address
.br
\fBlhost\fR - local host name
.br
\fBlport\fR - local port number
.br
\fBlservice\fR - local service name from /etc/services
The connection index provides you with access to each connection in the port monitor. The monitor will return information for index values from 0 to n-1 connections. Values higher than n-1 are simply ignored. For the "count" item, the connection index must be omitted. It is required for all other items.
Examples:
.br
\fB${tcp_portmon 6881 6999 count}\fR -
displays the number of connections in the bittorrent port range
.br
\fB${tcp_portmon 22 22 rip 0}\fR -
displays the remote host ip of the first sshd connection
.br
\fB${tcp_portmon 22 22 rip 9}\fR -
displays the remote host ip of the tenth sshd connection
.br
\fB${tcp_portmon 1 1024 rhost 0}\fR -
displays the remote host name of the first connection on a privileged port
.br
\fB${tcp_portmon 1 1024 rport 4}\fR -
displays the remote host port of the fifth connection on a privileged port
.br
\fB${tcp_portmon 1 65535 lservice 14}\fR -
displays the local service name of the fifteenth connection in the range of all ports
Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a single port range for different items and different indexes all use the same monitor internally. In other words, the program avoids creating redundant monitors.
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 then the time it takes your script to execute. For example, if you have a script that take 5 seconds to execute, you should make the interval at least 6 seconds. See also $execi.
Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles (when using this action and spaces_in_front is given conky places that many spaces in front of each item).
Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
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.
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.
This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There can be a max of 10 processes listed.
Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time.
Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy).
All code written since the fork of torsmo is licensed under the GPL (see LICENSE.GPL for a copy), except where noted differently (such as in portmon code, timed thread code, and audacious code which are LGPL, and prss which is an MIT-style license).
.SHAUTHORS
The Conky dev team (see AUTHORS for a full list of contributors).
