Variables
To configure what Conky displays, you must supply some variables in the
conky.text
section of your configuration. In this secton you'll find a
listing of the available variables. Some of them may require build options to
be enabled at compile time for them to work.
Colours are parsed using XParseColor()
, there might be a list of them:
/usr/share/X11/rgb.txt
. Colour can be also in #rrggbb
format (hex).
Some objects may create threads, and sometimes these threads will not be
destroyed until Conky terminates. There is no way to destroy or clean up
threads while Conky is running. For example, if you use an MPD variable,
the MPD thread will keep running until Conky dies. Some threaded objects
will use one of the parameters as a key
, so that you only have 1
relevant thread running (for example, the $curl, and $rss
objects launch one thread per URI).
Optional arguments are generally denoted with paretheses (i.e., (optional)
).
${
battery_short
(num)
}
Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument. 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.
BAT0
${
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.
${
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.
${
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.
${
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 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.
${
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 defines the maximum value of the graph (in bytes per second). 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).
${
execgauge
(height),(width)
command
}
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
(height),(width)
(gradient color 1)
(gradient color 2)
(scale)
(-t)
(-l)
}
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:
- wrap your command in double-quotes, or
- 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}
${
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.
${
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 double quote "
character. The quote
characters 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).
${
hwmon
(dev)
type
n
(factor offset)
}
Hwmon sensor from sysfs (Linux 2.6). Parameter dev can be:
- Number. e.g
1
means hwmon1. - Module name. e.g.
k10temp
means the first hwmon device whose module name is `k10temp. - 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).
${
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).
${
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.
${
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:
<
or>
<=
or>=
==
or!=
${
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_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.
${
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.
${
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.
${
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 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 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 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 place 'conky_' in front of it yourself.
${
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).
${
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).
${
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".
Vol
${
nvidia
argument
(GPU_ID)
}
Nvidia graphics card information via the XNVCtrl library.
Temperatures are printed as float, all other values as integers.
GPU_ID: Optional parameter to choose the GPU to be used as 0,1,2,3,.. Default parameter is 0
Possible arguments:
Argument | Alias | Description |
---|---|---|
gputemp |
temp |
GPU temperature |
gputempthreshold |
threshold |
Temperature threshold where the GPU will reduce its 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 |
Model name of the GPU card | |
driverversion |
Driver version |
${
nvidiabar
(height),(width)
argument
(GPU_ID)
}
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)
argument
(GPU_ID)
}
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
(height),(width)
(gradient color 1)
(gradient color 2)
(scale)
(-t)
(-l)
GPU_ID
}
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.
${
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:
Item | Description |
---|---|
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. |
${
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.
${
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.
${
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'.
${
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 | 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 |
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".
${
smapi
(ARGS)
}
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.
${
stock
symbol
data
}
Displays the data of a stock symbol. The following data is supported:
Name | Description |
---|---|
1ytp | 1 yr Target Price |
200ma | 200-day Moving Average |
50ma | 50-day Moving Average |
52weekhigh | |
52weeklow | |
52weekrange | |
adv | Average Daily Volume |
ag | Annualized Gain |
ahcrt | After Hours Change realtime |
ask | |
askrt | ask realtime |
asksize | |
bid | |
bidrt | bid realtime |
bidsize | |
bookvalue | |
c200ma | Change From 200-day Moving Average |
c50ma | Change From 50-day Moving Average |
c52whigh | Change from 52-week high |
c52wlow | Change From 52-week Low |
change | |
changert | change realtime |
cip | change in percent |
commission | |
cprt | change percent realtime |
dayshigh | |
dayslow | |
dpd | Dividend Pay Date |
dr | day's range |
drrt | day's range realtime |
ds | dividend/share |
dvc | Day's Value Change |
dvcrt | Day's Value Change realtime |
dy | Dividend Yield |
ebitda | |
edv | Ex-Dividend Date |
ei | error indication |
epsecy | EPS Estimate Current Year |
epsenq | EPS Estimate Next Quarter |
epseny | EPS Estimate Next Year |
es | earnings/share |
floatshares | |
hg | Holdings Gain |
hgp | Holdings Gain Percent |
hgprt | Holdings Gain Percent realtime |
hgrt | Holdings Gain realtime |
hl | high limit |
hv | Holdings Value |
hvrt | Holdings Value realtime |
ll | low limit |
ltd | Last Trade Date |
ltp | last trade price |
lts | Last Trade Size |
ltt | Last Trade Time |
mc | Market Capitalization |
mcrt | Market Cap realtime |
moreinfo | |
name | |
notes | |
obrt | Order Book realtime |
open | |
pb | price/book |
pc | previous close |
pc200ma | Percent Change From 200-day Moving Average |
pc50ma | Percent Change From 50-day Moving Average |
pc52whigh | percent change from 52-week high |
pc52wlow | Percent Change From 52-week Low |
pegr | PEG Ratio |
pepsecy | Price/EPS Estimate Current Year |
pepseny | Price/EPS Estimate Next Year |
per | P/E Ratio |
perrt | P/E Ratio realtime |
pricepaid | |
ps | price/sales |
se | Stock Exchange |
sharesowned | |
shortratio | |
symbol | |
tradedate | |
tradelinks | |
tt | Ticker Trend |
volume |
${
tcp_ping
host
(port)
}
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_portmon
port_begin
port_end
item
(index)
}
TCP port (both IPv6 and IPv4) monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
Item | Description |
---|---|
count |
Total number of connections in the range |
rip |
Remote ip address |
rhost |
Remote host name |
rport |
Remote port number |
rservice |
Remote service name from /etc/services |
lip |
Local ip address |
lhost |
Local host name |
lport |
Local port number |
lservice |
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:
Example | Description |
---|---|
${tcp_portmon 6881 6999 count} |
Displays the number of connections in the bittorrent port range |
${tcp_portmon 22 22 rip 0} |
Displays the remote host ip of the first sshd connection |
${tcp_portmon 22 22 rip 9} |
Displays the remote host ip of the tenth sshd connection |
${tcp_portmon 1 1024 rhost 0} |
Displays the remote host name of the first connection on a privileged port |
${tcp_portmon 1 1024 rport 4} |
Displays the remote host port of the fifth connection on a privileged port |
${tcp_portmon 1 65535 lservice 14} |
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.
${
templateN
(arg1)
(arg2)
(arg3 ...)
}
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 = [[$12]]
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 template | Same without template |
---|---|
${template0 node name} |
$nodename |
${template1 root /} |
root: ${fs_free /} / ${fs_size /} |
${template1 ${template2 disk root} /} |
disk root: ${fs_free /} / ${fs_size /} |
--------------------------------------------- | ------------------------------------------ |
${
texeci
interval
command
}
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.
${
top
type
num
}
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.
${
upspeedgraph
(netdev)
(height),(width)
(gradient colour 1)
(gradient colour 2)
(scale)
(-t)
(-l)
}
Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it defines the maximum value of the graph (in bytes per second). 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).