Update docs.
[monky] / doc / conky.1
1 '\" t -*- coding: us-ascii -*-
2 .if \n(.g .ds T< \\FC
3 .if \n(.g .ds T> \\F[\n[.fam]]
4 .de URL
5 \\$2 \(la\\$1\(ra\\$3
6 ..
7 .if \n(.g .mso www.tmac
8 .TH conky 1 2009-03-15 "" ""
9 .SH NAME
10 conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
11 .SH SYNOPSIS
12 'nh
13 .fi
14 .ad l
15 \fBconky\fR \kx
16 .if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
17 'in \n(.iu+\nxu
18 [\fIoptions\fR]
19 'in \n(.iu-\nxu
20 .ad b
21 'hy
22 .SH DESCRIPTION
23 Conky is a system monitor for X originally based on torsmo.
24 Since its inception, Conky has changed significantly from its predecessor, while maintaining
25 simplicity and configurability. Conky can display just about anything, either
26 on your root desktop or in its own window. Not only does Conky have many
27 built-in objects, it can also display just about any piece of information by
28 using scripts and other external programs.
29 .PP
30 Conky has more than 250 built in objects, including support for
31 a plethora of OS stats (uname, uptime, CPU usage, mem usage, disk
32 usage, "top" like process stats, and network monitoring, just to name a few),
33 built in IMAP and POP3 support, built in support for many popular
34 music players (MPD, XMMS2, BMPx, Audacious), and much much more.
35 Conky can display this info either as text, or using simple progress
36 bars and graph widgets, with different fonts and colours.
37 .PP
38 We are always looking for help, whether its reporting bugs, writing patches, or writing docs.
39 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches,
40 or stop by #conky on irc.freenode.net if you have questions or want to contribute.
41 .PP
42 Thanks for your interest in Conky.
43 .SH COMPILING
44 For users compiling from source on a binary distro, make sure you have the X development
45 libraries installed. This should be a package along the lines of "libx11-dev" or
46 "xorg-x11-dev" for X11 libs, and similar "-dev" format for the other libs required (depending
47 on your configure options).
48 .PP
49 Conky has (for some time) been available in the repositories of most popular distributions.
50 Here are some installation instructions for a few:
51 .PP
52 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
53 There is also usually an up-to-date ebuild within Conky's package or in the git repo.
54 .PP
55 Debian, etc. users -- Conky should be in your repositories, and can be installed by doing
56 "aptitude install conky".
57 .PP
58 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
59 .TP 
60 \fB\*(T<\fBsh autogen.sh\fR\*(T>\fR \*(T<\fB# Only required if building from the git repo\fR\*(T> 
61 .TP 
62 \fB\*(T<\fB\&./configure \fR\*(T>\fR\*(T<\fB\-\-prefix=/usr \-\-mandir=/usr/share/man \-\-infodir=/usr/share/info \-\-datadir=/usr/share \-\-sysconfdir=/etc \-\-localstatedir=/var/lib \-\-disable\-own\-window \-\-enable\-audacious[=yes|no|legacy] \-\-enable\-bmpx \-\-disable\-hddtemp \-\-disable\-mpd \-\-enable\-xmms2 \-\-disable\-portmon \-\-disable\-network \-\-enable\-debug \-\-disable\-x11 \-\-disable\-double\-buffer \-\-disable\-xdamage \-\-disable\-xft\fR\*(T> 
63 .TP 
64 \fB\*(T<\fBmake\fR\*(T>\fR 
65 .TP 
66 \fB\*(T<\fBmake install\fR\*(T>\fR \*(T<\fB# Optional\fR\*(T> 
67 .TP 
68 \fB\*(T<\fBsrc/conky\fR\*(T>\fR 
69 .PP
70 Conky has been tested to be compatible with C99 C, however it has not been tested
71 with anything other than gcc, and is not guaranteed to work with other compilers.
72 .PP
73 .SH "YOU SHOULD KNOW"
74 Conky is generally very good on resources. That said, the more you try to make Conky
75 do, the more resources it is going to consume.
76 .PP
77 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
78 Saves you the trouble of having to kill and then restart. You can now also do the same with SIGHUP.
79 .SH OPTIONS
80 Command line options override configurations defined in configuration file.
81 .TP 
82 \fB\*(T<\fB\-v | \-V | \-\-version\fR\*(T>\fR
83 Prints version and exits
84
85 .TP 
86 \fB\*(T<\fB\-q | \-\-quiet\fR\*(T>\fR
87 Run Conky in 'quiet mode' (ie. no output)
88
89 .TP 
90 \fB\*(T<\fB\-a | \-\-alignment=\fR\*(T>\fR\*(T<\fBALIGNMENT\fR\*(T>
91 Text alignment on screen, {top,bottom,middle}_{left,right,middle} or none
92
93 .TP 
94 \fB\*(T<\fB\-b | \-\-double\-buffer\fR\*(T>\fR
95 Use double buffering (eliminates "flicker")
96
97 .TP 
98 \fB\*(T<\fB\-c | \-\-config=\fR\*(T>\fR\*(T<\fBFILE\fR\*(T>
99 Config file to load instead of $HOME/.conkyrc
100
101 .TP 
102 \fB\*(T<\fB\-d | \-\-daemonize\fR\*(T>\fR
103 Daemonize Conky, aka fork to background
104
105 .TP 
106 \fB\*(T<\fB\-f | \-\-font=\fR\*(T>\fR\*(T<\fBFONT\fR\*(T>
107 Font to use
108
109 .TP 
110 \fB\*(T<\fB\-h | \-\-help\fR\*(T>\fR
111 Prints command line help and exits
112
113 .TP 
114 \fB\*(T<\fB\-o | \-\-own\-window\fR\*(T>\fR
115 Create own window to draw
116
117 .TP 
118 \fB\*(T<\fB\-t | \-\-text=\fR\*(T>\fR\*(T<\fBTEXT\fR\*(T>
119 Text to render, remember single quotes, like -t ' $uptime '
120
121 .TP 
122 \fB\*(T<\fB\-u | \-\-interval=\fR\*(T>\fR\*(T<\fBSECONDS\fR\*(T>
123 Update interval
124
125 .TP 
126 \fB\*(T<\fB\-w | \-\-window\-id=\fR\*(T>\fR\*(T<\fBWIN_ID\fR\*(T>
127 Window id to draw
128
129 .TP 
130 \fB\*(T<\fB\-x \fR\*(T>\fR\*(T<\fBX_COORDINATE\fR\*(T>
131 X position
132
133 .TP 
134 \fB\*(T<\fB\-y \fR\*(T>\fR\*(T<\fBY_COORDINATE\fR\*(T>
135 Y position
136
137 .TP 
138 \fB\*(T<\fB\-i \fR\*(T>\fR\*(T<\fBCOUNT\fR\*(T>
139 Number of times to update Conky (and quit)
140
141 .SH "CONFIGURATION SETTINGS"
142 Default configuration file location is $HOME/.conkyrc or
143 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
144 and you can find the sample config file there (/etc/conky/conky.conf).
145 .PP
146 You might want to copy it to $HOME/.conkyrc and then start modifying it.
147 Other configs can be found at http://conky.sf.net/
148 .TP 
149 \fB\*(T<\fBalias\fR\*(T>\fR
150 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
151
152 .TP 
153 \fB\*(T<\fBalignment\fR\*(T>\fR
154 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)
155
156 .TP 
157 \fB\*(T<\fBbackground\fR\*(T>\fR
158 Boolean value, if true, Conky will be forked to background when started
159
160 .TP 
161 \fB\*(T<\fBborder_margin\fR\*(T>\fR
162 Border margin in pixels
163
164 .TP 
165 \fB\*(T<\fBborder_width\fR\*(T>\fR
166 Border width in pixels
167
168 .TP 
169 \fB\*(T<\fBcolorN\fR\*(T>\fR
170 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 (#).
171
172 .TP 
173 \fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
174 The number of samples to average for CPU monitoring
175
176 .TP 
177 \fB\*(T<\fBtop_cpu_separate\fR\*(T>\fR
178 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.
179
180 .TP 
181 \fB\*(T<\fBdefault_bar_size\fR\*(T>\fR
182 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
183
184 .TP 
185 \fB\*(T<\fBdefault_graph_size\fR\*(T>\fR
186 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
187
188 .TP 
189 \fB\*(T<\fBdefault_gauge_size\fR\*(T>\fR
190 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
191
192 .TP 
193 \fB\*(T<\fBdefault_color\fR\*(T>\fR
194 Default color and border color
195
196 .TP 
197 \fB\*(T<\fBdefault_outline_color\fR\*(T>\fR
198 Default outline color
199
200 .TP 
201 \fB\*(T<\fBdefault_shade_color\fR\*(T>\fR
202 Default shading color and border's shading color
203
204 .TP 
205 \fB\*(T<\fBdouble_buffer\fR\*(T>\fR
206 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.
207
208 .TP 
209 \fB\*(T<\fBdraw_borders\fR\*(T>\fR
210 Draw borders around text?
211
212 .TP 
213 \fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
214 Draw borders around graphs?
215
216 .TP 
217 \fB\*(T<\fBdraw_outline\fR\*(T>\fR
218 Draw outlines?
219
220 .TP 
221 \fB\*(T<\fBdraw_shades\fR\*(T>\fR
222 Draw shades?
223
224 .TP 
225 \fB\*(T<\fBfont\fR\*(T>\fR
226 Font name in X, xfontsel can be used to get a nice font
227
228 .TP 
229 \fB\*(T<\fBgap_x\fR\*(T>\fR
230 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
231 e.g. gap_x 10
232
233 .TP 
234 \fB\*(T<\fBgap_y\fR\*(T>\fR
235 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
236 e.g. gap_y 10.
237
238 .TP 
239 \fB\*(T<\fBif_up_strictness\fR\*(T>\fR
240 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.
241
242 .TP 
243 \fB\*(T<\fBimap\fR\*(T>\fR
244 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.
245
246 .TP 
247 \fB\*(T<\fBmail_spool\fR\*(T>\fR
248 Mail spool for mail checking
249
250 .TP 
251 \fB\*(T<\fBmax_port_monitor_connections\fR\*(T>\fR
252 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
253
254 .TP 
255 \fB\*(T<\fBmax_specials\fR\*(T>\fR
256 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
257
258 .TP 
259 \fB\*(T<\fBmax_user_text\fR\*(T>\fR \*(T<\fBbytes\fR\*(T> 
260 Maximum size of user text buffer, i.e. layout below TEXT line in config file
261 (default is 16384 bytes)
262
263 .TP 
264 \fB\*(T<\fBtext_buffer_size\fR\*(T>\fR \*(T<\fBbytes\fR\*(T> 
265 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.
266
267 .TP 
268 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T> 
269 Maximum width of window
270
271 .TP 
272 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T> 
273 Minimum size of window
274
275 .TP 
276 \fB\*(T<\fBmpd_host\fR\*(T>\fR
277 Host of MPD server
278
279 .TP 
280 \fB\*(T<\fBmpd_port\fR\*(T>\fR
281 Port of MPD server
282
283 .TP 
284 \fB\*(T<\fBmpd_password\fR\*(T>\fR
285 MPD server password
286
287 .TP 
288 \fB\*(T<\fBmusic_player_interval\fR\*(T>\fR
289 Music player thread update interval (defaults to Conky's update interval)
290
291 .TP 
292 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
293 The number of samples to average for net data
294
295 .TP 
296 \fB\*(T<\fBno_buffers\fR\*(T>\fR
297 Substract (file system) buffers from used memory?
298
299 .TP 
300 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
301 Force UTF8? requires XFT
302
303 .TP 
304 \fB\*(T<\fBown_window\fR\*(T>\fR
305 Boolean, create own window to draw?
306
307 .TP 
308 \fB\*(T<\fBown_window_class\fR\*(T>\fR
309 Manually set the WM_CLASS name. Defaults to "Conky".
310
311 .TP 
312 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T> 
313 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)
314
315 .TP 
316 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T> 
317 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
318 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
319 If you use own_window_type override, window manager hints have no meaning and are ignored.
320
321 .TP 
322 \fB\*(T<\fBown_window_title\fR\*(T>\fR
323 Manually set the window name. Defaults to "<hostname> - conky".
324
325 .TP 
326 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
327 Boolean, set pseudo-transparency?
328
329 .TP 
330 \fB\*(T<\fBown_window_type\fR\*(T>\fR
331 if own_window is yes, you may specify type normal, desktop, dock or override (default: normal).
332 Desktop windows are special windows that have no window decorations; are always visible
333 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
334 Override windows are not under the control of the window manager. Hints are ignored. This type
335 of window can be useful for certain situations.
336
337 .TP 
338 \fB\*(T<\fBout_to_console\fR\*(T>\fR 
339 Print text to stdout.
340
341 .TP 
342 \fB\*(T<\fBout_to_stderr\fR\*(T>\fR 
343 Print text to stderr.
344
345 .TP 
346 \fB\*(T<\fBout_to_x\fR\*(T>\fR 
347 When set to no, there will be no output in X (useful when you also use things like out_to_console).
348 If you set it to no, make sure that it's placed before all other X-related setting (take the first
349 line of your configfile to be sure). Default value is yes
350
351 .TP 
352 \fB\*(T<\fBoverwrite_file\fR\*(T>\fR 
353 Overwrite the file given as argument.
354
355 .TP 
356 \fB\*(T<\fBappend_file\fR\*(T>\fR 
357 Append the file given as argument.
358
359 .TP 
360 \fB\*(T<\fBpad_percents\fR\*(T>\fR
361 Pad percentages to this many decimals (0 = no padding)
362
363 .TP 
364 \fB\*(T<\fBpop3\fR\*(T>\fR
365 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.
366
367 .TP 
368 \fB\*(T<\fBshort_units\fR\*(T>\fR
369 Shortens units to a single character (kiB->k, GiB->G, etc.). Default is off.
370
371 .TP 
372 \fB\*(T<\fBshow_graph_scale\fR\*(T>\fR
373 Shows the maximum value in scaled graphs.
374
375 .TP 
376 \fB\*(T<\fBshow_graph_range\fR\*(T>\fR
377 Shows the time range covered by a graph.
378
379 .TP 
380 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
381 Border stippling (dashing) in pixels
382
383 .TP 
384 \fB\*(T<\fBtemperature_unit\fR\*(T>\fR
385 Desired output unit of all objects displaying a temperature.
386 Parameters are either "fahrenheit" or "celsius". The default
387 unit is degree Celsius.
388
389 .TP 
390 \fB\*(T<\fBtemplateN\fR\*(T>\fR
391 Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
392 The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
393 but before some substitutions are applied:
394
395 \&'\en' -> newline
396 .br
397 \&'\e\e' -> backslash
398 .br
399 \&'\e ' -> space
400 .br
401 \&'\eN' -> template argument N
402
403 .TP 
404 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
405 Total number of times for Conky to update before quitting. Zero makes Conky run forever
406
407 .TP 
408 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
409 Update interval in seconds
410
411 .TP 
412 \fB\*(T<\fBuppercase\fR\*(T>\fR
413 Boolean value, if true, text is rendered in upper case
414
415 .TP 
416 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
417 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.
418
419 .TP 
420 \fB\*(T<\fBuse_xft\fR\*(T>\fR
421 Use Xft (anti-aliased font and stuff)
422
423 .TP 
424 \fB\*(T<\fBxftalpha\fR\*(T>\fR
425 Alpha of Xft font. Must be a value at or between 1 and 0.
426
427 .TP 
428 \fB\*(T<\fBxftfont\fR\*(T>\fR
429 Xft font to use.
430
431 .TP 
432 \fB\*(T<\fBTEXT\fR\*(T>\fR
433 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.
434
435 .SH VARIABLES
436 Colors are parsed using XParsecolor(), there might be a list of them:
437 /usr/share/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
438 Color can be also in #rrggbb format (hex).
439 .TP 
440 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> 
441 IP address for an interface, or "No Address" if no address is assigned.
442
443 .TP 
444 \fB\*(T<\fBaddrs\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> 
445 IP addresses for an interface (if one - works like addr). Linux only.
446
447 .TP 
448 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR 
449 ACPI ac adapter state.
450
451 .TP 
452 \fB\*(T<\fBacpifan\fR\*(T>\fR 
453 ACPI fan state
454
455 .TP 
456 \fB\*(T<\fBacpitemp\fR\*(T>\fR 
457 ACPI temperature in C.
458
459 .TP 
460 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR 
461 CPU temperature from therm_adt746x
462
463 .TP 
464 \fB\*(T<\fBadt746xfan\fR\*(T>\fR 
465 Fan speed from therm_adt746x
466
467 .TP 
468 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
469 Right-justify text, with space of N
470
471 .TP 
472 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
473 Align text to centre
474
475 .TP 
476 \fB\*(T<\fBapm_adapter\fR\*(T>\fR 
477 Display APM AC adapter status (FreeBSD only)
478
479 .TP 
480 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR 
481 Display APM battery life in percent (FreeBSD only)
482
483 .TP 
484 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR 
485 Display remaining APM battery life in hh:mm:ss or "unknown" if
486 AC adapterstatus is on-line or charging (FreeBSD only)
487
488 .TP 
489 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
490 Progress bar
491
492 .TP 
493 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR 
494 Bitrate of current tune
495
496 .TP 
497 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR 
498 Number of audio channels of current tune
499
500 .TP 
501 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR 
502 Full path and filename of current tune
503
504 .TP 
505 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR 
506 Sampling frequency of current tune
507
508 .TP 
509 \fB\*(T<\fBaudacious_length\fR\*(T>\fR 
510 Total length of current tune as MM:SS
511
512 .TP 
513 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR 
514 Total length of current tune in seconds
515
516 .TP 
517 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR 
518 Playlist position of current tune
519
520 .TP 
521 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR 
522 Number of tunes in playlist
523
524 .TP 
525 \fB\*(T<\fBaudacious_position\fR\*(T>\fR 
526 Position of current tune (MM:SS)
527
528 .TP 
529 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR 
530 Position of current tune in seconds
531
532 .TP 
533 \fB\*(T<\fBaudacious_status\fR\*(T>\fR 
534 Player status (Playing/Paused/Stopped/Not running)
535
536 .TP 
537 \fB\*(T<\fBaudacious_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
538 Title of current tune with optional maximum length specifier
539
540 .TP 
541 \fB\*(T<\fBaudacious_main_volume\fR\*(T>\fR 
542 The current volume fetched from Audacious
543
544 .TP 
545 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
546 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
547
548 .TP 
549 \fB\*(T<\fBbattery_short\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
550 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
551 This mode display a short status, which means that C is displayed instead of charging and D is displayed instead of discharging.
552
553 .TP 
554 \fB\*(T<\fBbattery_bar\fR\*(T>\fR \*(T<\fB(height),(width) (num)\fR\*(T> 
555 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
556
557 .TP 
558 \fB\*(T<\fBbattery_percent\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
559 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
560
561 .TP 
562 \fB\*(T<\fBbattery_time\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
563 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
564
565 .TP 
566 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR 
567 Artist in current BMPx track
568
569 .TP 
570 \fB\*(T<\fBbmpx_album\fR\*(T>\fR 
571 Album in current BMPx track
572
573 .TP 
574 \fB\*(T<\fBbmpx_title\fR\*(T>\fR 
575 Title of the current BMPx track
576
577 .TP 
578 \fB\*(T<\fBbmpx_track\fR\*(T>\fR 
579 Track number of the current BMPx track
580
581 .TP 
582 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR 
583 Bitrate of the current BMPx track
584
585 .TP 
586 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR 
587 URI of the current BMPx track
588
589 .TP 
590 \fB\*(T<\fBbuffers\fR\*(T>\fR 
591 Amount of memory buffered
592
593 .TP 
594 \fB\*(T<\fBcached\fR\*(T>\fR 
595 Amount of memory cached
596
597 .TP 
598 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
599 Change drawing color to color
600
601 .TP 
602 \fB\*(T<\fBcolorN\fR\*(T>\fR
603 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
604
605 .TP 
606 \fB\*(T<\fBconky_version\fR\*(T>\fR 
607 Conky version
608
609 .TP 
610 \fB\*(T<\fBconky_build_date\fR\*(T>\fR 
611 Date Conky was built
612
613 .TP 
614 \fB\*(T<\fBconky_build_arch\fR\*(T>\fR 
615 CPU architecture Conky was built for
616
617 .TP 
618 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T> 
619 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.
620
621 .TP 
622 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpuN) (height),(width)\fR\*(T> 
623 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
624
625 .TP 
626 \fB\*(T<\fBcpugauge\fR\*(T>\fR \*(T<\fB(cpuN) (height),(width)\fR\*(T> 
627 Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively. See $cpu for more info on SMP.
628
629 .TP 
630 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpuN) ("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
631 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".
632
633 .TP 
634 \fB\*(T<\fBdiskio\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
635 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
636
637 .TP 
638 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T> 
639 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".
640
641 .TP 
642 \fB\*(T<\fBdiskio_read\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
643 Displays current disk IO for reads. Device as in diskio.
644
645 .TP 
646 \fB\*(T<\fBdiskiograph_read\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T> 
647 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".
648
649 .TP 
650 \fB\*(T<\fBdiskio_write\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
651 Displays current disk IO for writes. Device as in diskio.
652
653 .TP 
654 \fB\*(T<\fBdiskiograph_write\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T> 
655 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".
656
657 .TP 
658 \fB\*(T<\fBdisk_protect\fR\*(T>\fR \*(T<\fBdevice\fR\*(T> 
659 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
660
661 .TP 
662 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
663 Download speed in KiB
664
665 .TP 
666 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
667 Download speed in KiB with one decimal
668
669 .TP 
670 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T> 
671 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".
672
673 .TP 
674 \fB\*(T<\fBelse\fR\*(T>\fR 
675 Text to show if any of the above are not true
676
677 .TP 
678 \fB\*(T<\fBentropy_avail\fR\*(T>\fR 
679 Current entropy available for crypto freaks
680
681 .TP 
682 \fB\*(T<\fBentropy_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
683 Normalized bar of available entropy for crypto freaks
684
685 .TP 
686 \fB\*(T<\fBentropy_poolsize\fR\*(T>\fR 
687 Total size of system entropy pool for crypto freaks
688
689 .TP 
690 \fB\*(T<\fBeval\fR\*(T>\fR \*(T<\fBstring\fR\*(T> 
691 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.
692
693 .TP 
694 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
695 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.
696
697 .TP 
698 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
699 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.
700
701 .TP 
702 \fB\*(T<\fBexecgauge\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
703 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.
704
705 .TP 
706 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command\fR\*(T> 
707 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.
708
709 .TP 
710 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
711 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
712
713 .TP 
714 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
715 Same as execbar, except with an interval
716
717 .TP 
718 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
719 Same as execgraph, but takes an interval arg and graphs values.
720
721 .TP 
722 \fB\*(T<\fBexecigauge\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
723 Same as execgauge, but takes an interval arg and gauges values.
724
725 .TP 
726 \fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
727 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.
728 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.
729
730 .TP 
731 \fB\*(T<\fBexecpi\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
732 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.
733
734 .TP 
735 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T> 
736 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)
737
738 .TP 
739 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
740 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
741
742 .TP 
743 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
744 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
745
746 .TP 
747 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
748 Returns CPU #n's frequency in MHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
749
750 .TP 
751 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
752 Returns CPU #n's frequency in GHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
753
754 .TP 
755 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T> 
756 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.
757
758 .TP 
759 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
760 Free space on a file system available for users.
761
762 .TP 
763 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
764 Free percentage of space on a file system available for users.
765
766 .TP 
767 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
768 File system size
769
770 .TP 
771 \fB\*(T<\fBfs_type\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
772 File system type
773
774 .TP 
775 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
776 File system used space
777
778 .TP 
779 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T> 
780 The next element will be printed at position 'x'.
781
782 .TP 
783 \fB\*(T<\fBgw_iface\fR\*(T>\fR 
784 Displays the default route's interface or "multiple"/"none" accordingly.
785
786 .TP 
787 \fB\*(T<\fBgw_ip\fR\*(T>\fR 
788 Displays the default gateway's IP or "multiple"/"none" accordingly.
789
790 .TP 
791 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T> 
792 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
793 Default host is 127.0.0.1, default port is 7634.
794
795 .TP 
796 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
797 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.
798
799 .TP 
800 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T> 
801 Horizontal line, height is the height in pixels
802
803 .TP 
804 \fB\*(T<\fBhwmon\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
805 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.
806
807 .TP 
808 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T> 
809 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
810
811 .TP 
812 \fB\*(T<\fBiconv_stop\fR\*(T>\fR 
813 Stop iconv codeset conversion.
814
815 .TP 
816 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
817 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.
818
819 .TP 
820 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR 
821 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.
822
823 .TP 
824 \fB\*(T<\fBi8k_bios\fR\*(T>\fR 
825 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
826
827 .TP 
828 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR 
829 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
830
831 .TP 
832 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR 
833 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
834
835 .TP 
836 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR 
837 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.
838
839 .TP 
840 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR 
841 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.
842
843 .TP 
844 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR 
845 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.
846
847 .TP 
848 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR 
849 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.
850
851 .TP 
852 \fB\*(T<\fBi8k_serial\fR\*(T>\fR 
853 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
854
855 .TP 
856 \fB\*(T<\fBi8k_version\fR\*(T>\fR 
857 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
858
859 .TP 
860 \fB\*(T<\fBibm_fan\fR\*(T>\fR 
861 If running the IBM ACPI, displays the fan speed.
862
863 .TP 
864 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T> 
865 If running the IBM ACPI, displays the temperatures
866 from the IBM temperature sensors (N=0..7) Sensor 0 is
867 on the CPU, 3 is on the GPU.
868
869 .TP 
870 \fB\*(T<\fBibm_volume\fR\*(T>\fR 
871 If running the IBM ACPI, displays the "master" volume,
872 controlled by the volume keys (0-14).
873
874 .TP 
875 \fB\*(T<\fBibm_brightness\fR\*(T>\fR 
876 If running the IBM ACPI, displays the brigtness of the
877 laptops's LCD (0-7).
878
879 .TP 
880 \fB\*(T<\fBif_empty\fR\*(T>\fR \*(T<\fB(var)\fR\*(T> 
881 if conky variable VAR is empty, display everything
882 between $if_empty and the matching $endif
883
884 .TP 
885 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fBfile (string)\fR\*(T> 
886 if FILE exists, display everything between if_existing
887 and the matching $endif. The optional second paramater
888 checks for FILE containing the specified string and
889 prints everything between $if_existing and the matching
890 $endif.
891
892 .TP 
893 \fB\*(T<\fBif_gw\fR\*(T>\fR 
894 if there is at least one default gateway, display
895 everything between $if_gw and the matching $endif
896
897 .TP 
898 \fB\*(T<\fBif_match\fR\*(T>\fR \*(T<\fBexpression\fR\*(T> 
899 Evaluates the given boolean expression, printing
900 everything between $if_match and the matching $endif
901 depending on whether the evaluation returns true or not.
902 Valid expressions consist of a left side, an operator
903 and a right side. Left and right sides are being parsed
904 for contained text objects before evaluation. Recognised
905 left and right side types are:
906
907 \fBdouble\fR:
908 argument consists of only digits and a
909 single dot.
910 .br
911 \fBlong\fR:
912 argument consists of only digits.
913 .br
914 \fBstring\fR:
915 argument is enclosed in quotation mark
916 or the checks for double and long failed
917 before.
918
919 Valid operands are:
920 \&'>', '<', '>=', '<=', '==', '!='.
921
922 .TP 
923 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T> 
924 if PROCESS is running, display everything $if_running
925 and the matching $endif. This uses the ``pidof'' command, so the
926 -x switch is also supported.
927
928 .TP 
929 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T> 
930 if MOUNTPOINT is mounted, display everything between
931 $if_mounted and the matching $endif
932
933 .TP 
934 \fB\*(T<\fBif_smapi_bat_installed\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T> 
935 when using smapi, if the battery with index INDEX is
936 installed, display everything between
937 $if_smapi_bat_installed and the matching $endif
938
939 .TP 
940 \fB\*(T<\fBif_up\fR\*(T>\fR \*(T<\fB(interface)\fR\*(T> 
941 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
942
943 .TP 
944 \fB\*(T<\fBif_updatenr\fR\*(T>\fR \*(T<\fB(updatenr)\fR\*(T> 
945 If it's the UPDATENR-th time that conky updates, 
946 display everything between $if_updatenr and the matching $endif.
947 The counter resets when the highest UPDATENR is reached.
948 Example : "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$endif"
949 shows foo 25% of the time followed by bar 25% of the time followed by nothing the other half of the time.
950
951 .TP 
952 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
953 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.
954
955 .TP 
956 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
957 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.
958
959 .TP 
960 \fB\*(T<\fBioscheduler\fR\*(T>\fR \*(T<\fBdisk\fR\*(T> 
961 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
962
963 .TP 
964 \fB\*(T<\fBkernel\fR\*(T>\fR 
965 Kernel version
966
967 .TP 
968 \fB\*(T<\fBlaptop_mode\fR\*(T>\fR 
969 The value of /proc/sys/vm/laptop_mode
970
971 .TP 
972 \fB\*(T<\fBloadavg\fR\*(T>\fR 
973 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
974
975 .TP 
976 \fB\*(T<\fBloadgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
977 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".
978
979 .TP 
980 \fB\*(T<\fBlines\fR\*(T>\fR \*(T<\fBtextfile\fR\*(T> 
981 Displays the number of lines in the given file
982
983 .TP 
984 \fB\*(T<\fBmachine\fR\*(T>\fR 
985 Machine, i686 for example
986
987 .TP 
988 \fB\*(T<\fBmails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
989 Mail count in the specified mailbox or your mail spool if not.
990 Both mbox and maildir type mailboxes are supported. You can
991 use a program like fetchmail to get mails from some server
992 using your favourite protocol. See also new_mails.
993
994 .TP 
995 \fB\*(T<\fBnew_mails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
996 Unread mail count in the specified mailbox or mail spool if
997 not. Both mbox and maildir type mailboxes are supported.
998
999 .TP 
1000 \fB\*(T<\fBseen_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1001 Number of mails marked as seen in the specified mailbox or mail spool if
1002 not. Only maildir type mailboxes are supported, mbox type will return -1.
1003
1004 .TP 
1005 \fB\*(T<\fBunseen_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1006 Number of new or unseen mails in the specified mailbox or mail spool if
1007 not. Only maildir type mailboxes are supported, mbox type will return -1.
1008
1009 .TP 
1010 \fB\*(T<\fBflagged_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1011 Number of mails marked as flagged in the specified mailbox or mail spool if
1012 not. Only maildir type mailboxes are supported, mbox type will return -1.
1013
1014 .TP 
1015 \fB\*(T<\fBunflagged_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1016 Number of mails not marked as flagged in the specified mailbox or mail spool if
1017 not. Only maildir type mailboxes are supported, mbox type will return -1.
1018
1019 .TP 
1020 \fB\*(T<\fBforwarded_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1021 Number of mails marked as forwarded in the specified mailbox or mail spool if
1022 not. Only maildir type mailboxes are supported, mbox type will return -1.
1023
1024 .TP 
1025 \fB\*(T<\fBunforwarded_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1026 Number of mails not marked as forwarded in the specified mailbox or mail spool if
1027 not. Only maildir type mailboxes are supported, mbox type will return -1.
1028
1029 .TP 
1030 \fB\*(T<\fBreplied_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1031 Number of mails marked as replied in the specified mailbox or mail spool if
1032 not. Only maildir type mailboxes are supported, mbox type will return -1.
1033
1034 .TP 
1035 \fB\*(T<\fBunreplied_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1036 Number of mails not marked as replied in the specified mailbox or mail spool if
1037 not. Only maildir type mailboxes are supported, mbox type will return -1.
1038
1039 .TP 
1040 \fB\*(T<\fBdraft_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1041 Number of mails marked as draft in the specified mailbox or mail spool if
1042 not. Only maildir type mailboxes are supported, mbox type will return -1.
1043
1044 .TP 
1045 \fB\*(T<\fBtrashed_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1046 Number of mails marked as trashed in the specified mailbox or mail spool if
1047 not. Only maildir type mailboxes are supported, mbox type will return -1.
1048
1049 .TP 
1050 \fB\*(T<\fBmboxscan\fR\*(T>\fR \*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T> 
1051 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"}
1052
1053 .TP 
1054 \fB\*(T<\fBmem\fR\*(T>\fR 
1055 Amount of memory in use
1056
1057 .TP 
1058 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1059 Bar that shows amount of memory in use
1060
1061 .TP 
1062 \fB\*(T<\fBmemgauge\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1063 Gauge that shows amount of memory in use (see cpugauge)
1064
1065 .TP 
1066 \fB\*(T<\fBmemgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
1067 Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1068
1069 .TP 
1070 \fB\*(T<\fBmemeasyfree\fR\*(T>\fR 
1071 Amount of free memory including the memory that is very easily freed (buffers/cache)
1072
1073 .TP 
1074 \fB\*(T<\fBmemfree\fR\*(T>\fR 
1075 Amount of free memory
1076
1077 .TP 
1078 \fB\*(T<\fBmemmax\fR\*(T>\fR 
1079 Total amount of memory
1080
1081 .TP 
1082 \fB\*(T<\fBmemperc\fR\*(T>\fR 
1083 Percentage of memory in use
1084
1085 .TP 
1086 \fB\*(T<\fBmixer\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1087 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.
1088
1089 .TP 
1090 \fB\*(T<\fBmixerbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1091 Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1092
1093 .TP 
1094 \fB\*(T<\fBmixerr\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1095 Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1096
1097 .TP 
1098 \fB\*(T<\fBmixerrbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1099 Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1100
1101 .TP 
1102 \fB\*(T<\fBmixerl\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1103 Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1104
1105 .TP 
1106 \fB\*(T<\fBmixerlbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1107 Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1108
1109 .TP 
1110 \fB\*(T<\fBmoc_state\fR\*(T>\fR 
1111 Current state of MOC; playing, stopped etc.
1112
1113 .TP 
1114 \fB\*(T<\fBmoc_file\fR\*(T>\fR 
1115 File name of the current MOC song
1116
1117 .TP 
1118 \fB\*(T<\fBmoc_title\fR\*(T>\fR 
1119 Title of the current MOC song
1120
1121 .TP 
1122 \fB\*(T<\fBmoc_artist\fR\*(T>\fR 
1123 Artist of the current MOC song
1124
1125 .TP 
1126 \fB\*(T<\fBmoc_song\fR\*(T>\fR 
1127 The current song name being played in MOC.
1128
1129 .TP 
1130 \fB\*(T<\fBmoc_album\fR\*(T>\fR 
1131 Album of the current MOC song
1132
1133 .TP 
1134 \fB\*(T<\fBmoc_totaltime\fR\*(T>\fR 
1135 Total length of the current MOC song
1136
1137 .TP 
1138 \fB\*(T<\fBmoc_timeleft\fR\*(T>\fR 
1139 Time left in the current MOC song
1140
1141 .TP 
1142 \fB\*(T<\fBmoc_curtime\fR\*(T>\fR 
1143 Current time of the current MOC song
1144
1145 .TP 
1146 \fB\*(T<\fBmoc_bitrate\fR\*(T>\fR 
1147 Bitrate in the current MOC song
1148
1149 .TP 
1150 \fB\*(T<\fBmoc_rate\fR\*(T>\fR 
1151 Rate of the current MOC song
1152
1153 .TP 
1154 \fB\*(T<\fBmonitor\fR\*(T>\fR 
1155 Number of the monitor on which conky is running
1156
1157 .TP 
1158 \fB\*(T<\fBmonitor_number\fR\*(T>\fR 
1159 Number of monitors
1160
1161 .TP 
1162 \fB\*(T<\fBmpd_artist\fR\*(T>\fR 
1163 Artist in current MPD song must be enabled at compile
1164
1165 .TP 
1166 \fB\*(T<\fBmpd_album\fR\*(T>\fR 
1167 Album in current MPD song
1168
1169 .TP 
1170 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1171 Bar of mpd's progress
1172
1173 .TP 
1174 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR 
1175 Bitrate of current song
1176
1177 .TP 
1178 \fB\*(T<\fBmpd_status\fR\*(T>\fR 
1179 Playing, stopped, et cetera.
1180
1181 .TP 
1182 \fB\*(T<\fBmpd_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
1183 Title of current MPD song
1184
1185 .TP 
1186 \fB\*(T<\fBmpd_vol\fR\*(T>\fR 
1187 MPD's volume
1188
1189 .TP 
1190 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR 
1191 Song's elapsed time
1192
1193 .TP 
1194 \fB\*(T<\fBmpd_length\fR\*(T>\fR 
1195 Song's length
1196
1197 .TP 
1198 \fB\*(T<\fBmpd_percent\fR\*(T>\fR 
1199 Percent of song's progress
1200
1201 .TP 
1202 \fB\*(T<\fBmpd_random\fR\*(T>\fR 
1203 Random status (On/Off)
1204
1205 .TP 
1206 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR 
1207 Repeat status (On/Off)
1208
1209 .TP 
1210 \fB\*(T<\fBmpd_track\fR\*(T>\fR 
1211 Prints the MPD track field
1212
1213 .TP 
1214 \fB\*(T<\fBmpd_name\fR\*(T>\fR 
1215 Prints the MPD name field
1216
1217 .TP 
1218 \fB\*(T<\fBmpd_file\fR\*(T>\fR 
1219 Prints the file name of the current MPD song
1220
1221 .TP 
1222 \fB\*(T<\fBmpd_smart\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
1223 Prints the song name in either the form "artist - title" or file name, depending on whats available
1224
1225 .TP 
1226 \fB\*(T<\fBif_mpd_playing\fR\*(T>\fR 
1227 if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1228
1229 .TP 
1230 \fB\*(T<\fBnameserver\fR\*(T>\fR \*(T<\fB(index)\fR\*(T> 
1231 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1232
1233 .TP 
1234 \fB\*(T<\fBnodename\fR\*(T>\fR 
1235 Hostname
1236
1237 .TP 
1238 \fB\*(T<\fBnvidia\fR\*(T>\fR \*(T<\fBthreshold\fR\*(T> \*(T<\fBtemp\fR\*(T> \*(T<\fBambient\fR\*(T> \*(T<\fBgpufreq\fR\*(T> \*(T<\fBmemfreq\fR\*(T> \*(T<\fBimagequality\fR\*(T> 
1239 Nvidia graficcard support for the XNVCtrl library.
1240 Each option can be shortened to the least significant part.
1241 Temperatures are printed as float, all other values as integer.
1242
1243 \fBthreshold\fR:
1244 the thresholdtemperature at which the gpu slows down
1245 .br
1246 \fBtemp\fR:
1247 gives the gpu current temperature
1248 .br
1249 \fBambient\fR:
1250 gives current air temperature near GPU case
1251 .br
1252 \fBgpufreq\fR:
1253 gives the current gpu frequency
1254 .br
1255 \fBmemfreq\fR:
1256 gives the current mem frequency
1257 .br
1258 \fBimagequality\fR:
1259 which imagequality should be choosen by OpenGL applications
1260
1261 .TP 
1262 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
1263 Change outline color
1264
1265 .TP 
1266 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T> 
1267 If running on Apple powerbook/ibook, display
1268 information on battery status. The item parameter
1269 specifies, what information to display. Exactly one item
1270 must be specified. Valid items are:
1271
1272 \fBstatus\fR:
1273 Display if battery is fully charged, charging,
1274 discharging or absent (running on AC)
1275 .br
1276 \fBpercent\fR:
1277 Display charge of battery in percent, if
1278 charging or discharging. Nothing will be
1279 displayed, if battery is fully charged
1280 or absent.
1281 .br
1282 \fBtime\fR:
1283 Display the time remaining until the battery
1284 will be fully charged or discharged at current
1285 rate. Nothing is displayed, if battery is
1286 absent or if it's present but fully charged
1287 and not discharging.
1288
1289 .TP 
1290 \fB\*(T<\fBplatform\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
1291 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.
1292
1293 .TP 
1294 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
1295 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.
1296
1297 .TP 
1298 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
1299 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.
1300
1301 .TP 
1302 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T> 
1303 Executes a shell command one time before conky displays anything and puts output as text.
1304
1305 .TP 
1306 \fB\*(T<\fBprocesses\fR\*(T>\fR 
1307 Total processes (sleeping and running)
1308
1309 .TP 
1310 \fB\*(T<\fBrunning_processes\fR\*(T>\fR 
1311 Running processes (not sleeping), requires Linux 2.6
1312
1313 .TP 
1314 \fB\*(T<\fBscroll\fR\*(T>\fR \*(T<\fBlength (step) text\fR\*(T> 
1315 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").
1316
1317 .TP 
1318 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
1319 Change shading color
1320
1321 .TP 
1322 \fB\*(T<\fBsmapi\fR\*(T>\fR \*(T<\fB(ARGS)\fR\*(T> 
1323 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.
1324
1325 .TP 
1326 \fB\*(T<\fBsmapi_bat_bar\fR\*(T>\fR \*(T<\fB(INDEX),(height),(width)\fR\*(T> 
1327 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1328
1329 .TP 
1330 \fB\*(T<\fBsmapi_bat_perc\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T> 
1331 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.
1332
1333 .TP 
1334 \fB\*(T<\fBsmapi_bat_power\fR\*(T>\fR \*(T<\fBINDEX\fR\*(T> 
1335 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.
1336
1337 .TP 
1338 \fB\*(T<\fBsmapi_bat_temp\fR\*(T>\fR \*(T<\fBINDEX\fR\*(T> 
1339 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.
1340
1341 .TP 
1342 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T> 
1343 Stippled (dashed) horizontal line
1344
1345 .TP 
1346 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1347 Bar that shows amount of swap in use
1348
1349 .TP 
1350 \fB\*(T<\fBswap\fR\*(T>\fR 
1351 Amount of swap in use
1352
1353 .TP 
1354 \fB\*(T<\fBswapmax\fR\*(T>\fR 
1355 Total amount of swap
1356
1357 .TP 
1358 \fB\*(T<\fBswapperc\fR\*(T>\fR 
1359 Percentage of swap in use
1360
1361 .TP 
1362 \fB\*(T<\fBsysname\fR\*(T>\fR 
1363 System name, Linux for example
1364
1365 .TP 
1366 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR 
1367 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1368
1369 \fBcount\fR - total number of connections in the range
1370 .br
1371 \fBrip\fR - remote ip address
1372 .br
1373 \fBrhost\fR - remote host name
1374 .br
1375 \fBrport\fR - remote port number
1376 .br
1377 \fBrservice\fR - remote service name from /etc/services
1378 .br
1379 \fBlip\fR - local ip address
1380 .br
1381 \fBlhost\fR - local host name
1382 .br
1383 \fBlport\fR - local port number
1384 .br
1385 \fBlservice\fR - local service name from /etc/services
1386
1387 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.
1388
1389 Examples:
1390 .br
1391 \fB${tcp_portmon 6881 6999 count}\fR -
1392 displays the number of connections in the bittorrent port range
1393 .br
1394 \fB${tcp_portmon 22 22 rip 0}\fR -
1395 displays the remote host ip of the first sshd connection
1396 .br
1397 \fB${tcp_portmon 22 22 rip 9}\fR -
1398 displays the remote host ip of the tenth sshd connection
1399 .br
1400 \fB${tcp_portmon 1 1024 rhost 0}\fR -
1401 displays the remote host name of the first connection on a privileged port
1402 .br
1403 \fB${tcp_portmon 1 1024 rport 4}\fR -
1404 displays the remote host port of the fifth connection on a privileged port
1405 .br
1406 \fB${tcp_portmon 1 65535 lservice 14}\fR -
1407 displays the local service name of the fifteenth connection in the range of all ports
1408
1409 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.
1410 .TP 
1411 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
1412 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.
1413
1414 .TP 
1415 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1416 Move text over by N pixels. See also $voffset.
1417
1418 .TP 
1419 \fB\*(T<\fBrss\fR\*(T>\fR \*(T<\fBurl delay_in_minutes action item_num\fR\*(T> 
1420 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.
1421
1422 .TP 
1423 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T> 
1424 Puts a tab of the specified width, starting from column 'start'. The unit is pixels for both arguments.
1425
1426 .TP 
1427 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
1428 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.
1429
1430 .TP 
1431 \fB\*(T<\fBtemplateN\fR\*(T>\fR \*(T<\fB(arg1)\fR\*(T> \*(T<\fB(arg2)\fR\*(T> \*(T<\fB(arg3 ...)\fR\*(T> 
1432 Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
1433 applying substitutions as described in the documentation of the corresponding configuration variable.
1434 The number of arguments is optional, but must match the highest referred index in the template. You can use the
1435 same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
1436 to contain a whitespace. Also simple nesting of templates is possible this way.
1437
1438 Here are some examples of template definitions:
1439
1440 template0 $\e1\e2
1441 .br
1442 template1 \e1: ${fs_used \e2} / ${fs_size \e2}
1443 .br
1444 template2 \e1 \e2
1445
1446 The following list shows sample usage of the templates defined above,
1447 with the equivalent syntax when not using any template at all:
1448 .TS
1449 l l.
1450 T{
1451 using template
1452 T}      T{
1453 same without template
1454 T}
1455 .T&
1456 _ _
1457 l l
1458 l l
1459 l l.
1460 T{
1461 ${template0 node name}
1462 T}      T{
1463 $nodename
1464 T}
1465 T{
1466 ${template1 root /}
1467 T}      T{
1468 root: ${fs_free /} / ${fs_size /}
1469 T}
1470 T{
1471 .nf
1472 \*(T<${template1 ${template2\e disk\e root} /}\*(T>
1473 .fi
1474 T}      T{
1475 .nf
1476 \*(T<disk root: ${fs_free /} / ${fs_size /}\*(T>
1477 .fi
1478 T}
1479 .TE
1480
1481 .TP 
1482 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1483 Local time, see man strftime to get more information about format
1484
1485 .TP 
1486 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1487 Display time in UTC (universal coordinate time).
1488
1489 .TP 
1490 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T> 
1491 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.
1492
1493 .TP 
1494 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1495 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.
1496
1497 .TP 
1498 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1499 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.
1500
1501 .TP 
1502 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1503 Same as top, except sorted by mem usage instead of cpu
1504
1505 .TP 
1506 \fB\*(T<\fBtop_time\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1507 Same as top, except sorted by total CPU time instead of current CPU usage
1508
1509 .TP 
1510 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1511 Total upload, this one too, may overflow
1512
1513 .TP 
1514 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T> 
1515 for debugging
1516
1517 .TP 
1518 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1519 Upload speed in KiB
1520
1521 .TP 
1522 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1523 Upload speed in KiB with one decimal
1524
1525 .TP 
1526 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T> 
1527 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".
1528
1529 .TP 
1530 \fB\*(T<\fBuptime\fR\*(T>\fR 
1531 Uptime
1532
1533 .TP 
1534 \fB\*(T<\fBuptime_short\fR\*(T>\fR 
1535 Uptime in a shorter format
1536
1537 .TP 
1538 \fB\*(T<\fBuser_number\fR\*(T>\fR 
1539 Number of users logged in
1540
1541 .TP 
1542 \fB\*(T<\fBuser_names\fR\*(T>\fR 
1543 Lists the names of the users logged in
1544
1545 .TP 
1546 \fB\*(T<\fBuser_terms\fR\*(T>\fR 
1547 Lists the consoles in use
1548
1549 .TP 
1550 \fB\*(T<\fBuser_times\fR\*(T>\fR 
1551 Lists how long users have been logged in for
1552
1553 .TP 
1554 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1555 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1556
1557 .TP 
1558 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1559 Returns CPU #n's voltage in mV. CPUs are
1560 counted from 1. If omitted, the parameter
1561 defaults to 1.
1562
1563 .TP 
1564 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1565 Returns CPU #n's voltage in V. CPUs are
1566 counted from 1. If omitted, the parameter
1567 defaults to 1.
1568
1569 .TP 
1570 \fB\*(T<\fBwireless_essid\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1571 Wireless access point ESSID (Linux only)
1572
1573 .TP 
1574 \fB\*(T<\fBwireless_mode\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1575 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1576
1577 .TP 
1578 \fB\*(T<\fBwireless_bitrate\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1579 Wireless bitrate (ie 11 Mb/s) (Linux only)
1580
1581 .TP 
1582 \fB\*(T<\fBwireless_ap\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1583 Wireless access point MAC address (Linux only)
1584
1585 .TP 
1586 \fB\*(T<\fBwireless_link_qual\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1587 Wireless link quality (Linux only)
1588
1589 .TP 
1590 \fB\*(T<\fBwireless_link_qual_max\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1591 Wireless link quality maximum value (Linux only)
1592
1593 .TP 
1594 \fB\*(T<\fBwireless_link_qual_perc\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1595 Wireless link quality in percents (Linux only)
1596
1597 .TP 
1598 \fB\*(T<\fBwireless_link_bar\fR\*(T>\fR \*(T<\fB(height), (width) net\fR\*(T> 
1599 Wireless link quality bar (Linux only)
1600
1601 .TP 
1602 \fB\*(T<\fBwords\fR\*(T>\fR \*(T<\fBtextfile\fR\*(T> 
1603 Displays the number of words in the given file
1604
1605 .TP 
1606 \fB\*(T<\fBxmms2_artist\fR\*(T>\fR 
1607 Artist in current XMMS2 song
1608
1609 .TP 
1610 \fB\*(T<\fBxmms2_album\fR\*(T>\fR 
1611 Album in current XMMS2 song
1612
1613 .TP 
1614 \fB\*(T<\fBxmms2_title\fR\*(T>\fR 
1615 Title in current XMMS2 song
1616
1617 .TP 
1618 \fB\*(T<\fBxmms2_genre\fR\*(T>\fR 
1619 Genre in current XMMS2 song
1620
1621 .TP 
1622 \fB\*(T<\fBxmms2_comment\fR\*(T>\fR 
1623 Comment in current XMMS2 song
1624
1625 .TP 
1626 \fB\*(T<\fBxmms2_decoder\fR\*(T>\fR 
1627 Decoder plugin used
1628
1629 .TP 
1630 \fB\*(T<\fBxmms2_transport\fR\*(T>\fR 
1631 Transport plugin used
1632
1633 .TP 
1634 \fB\*(T<\fBxmms2_url\fR\*(T>\fR 
1635 Full path to current song
1636
1637 .TP 
1638 \fB\*(T<\fBxmms2_tracknr\fR\*(T>\fR 
1639 Track number in current XMMS2 song
1640
1641 .TP 
1642 \fB\*(T<\fBxmms2_bitrate\fR\*(T>\fR 
1643 Bitrate of current song
1644
1645 .TP 
1646 \fB\*(T<\fBxmms2_id\fR\*(T>\fR 
1647 XMMS2 id of current song
1648
1649 .TP 
1650 \fB\*(T<\fBxmms2_duration\fR\*(T>\fR 
1651 Duration of current song
1652
1653 .TP 
1654 \fB\*(T<\fBxmms2_elapsed\fR\*(T>\fR 
1655 Song's elapsed time
1656
1657 .TP 
1658 \fB\*(T<\fBxmms2_size\fR\*(T>\fR 
1659 Size of current song
1660
1661 .TP 
1662 \fB\*(T<\fBxmms2_percent\fR\*(T>\fR 
1663 Percent of song's progress
1664
1665 .TP 
1666 \fB\*(T<\fBxmms2_status\fR\*(T>\fR 
1667 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1668
1669 .TP 
1670 \fB\*(T<\fBxmms2_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1671 Bar of XMMS2's progress
1672
1673 .TP 
1674 \fB\*(T<\fBxmms2_smart\fR\*(T>\fR 
1675 Prints the song name in either the form "artist - title" or file name, depending on whats available
1676
1677 .TP 
1678 \fB\*(T<\fBif_xmms2_connected\fR\*(T>\fR 
1679 Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
1680
1681 .TP 
1682 \fB\*(T<\fBeve\fR\*(T>\fR \*(T<\fBapi_userid api_key character_id\fR\*(T> 
1683 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.
1684
1685 .SH EXAMPLES
1686 .TP 
1687 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%M}' \-o \-u 30\fR\*(T>
1688 Start Conky in its own window with date and clock as text and 30 sec update interval.
1689 .TP 
1690 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1691 Start Conky to background at coordinates (5, 500).
1692 .SH FILES
1693 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1694 .SH BUGS
1695 Drawing to root or some other desktop window directly doesn't work with
1696 all window managers. Especially doesn't work well with Gnome and it has
1697 been reported that it doesn't work with KDE either. Nautilus can be
1698 disabled from drawing to desktop with program gconf-editor. Uncheck
1699 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1700 to set some specific window id. You might find xwininfo -tree useful to
1701 find the window to draw to. You can also use -o argument which makes
1702 Conky to create its own window. If you do try running Conky in its own
1703 window, be sure to read up on the own_window_type settings and experiment.
1704 .SH "SEE ALSO"
1705 \(lahttp://conky.sourceforge.net/\(ra
1706 .PP
1707 \(lahttp://www.sourceforge.net/projects/conky\(ra
1708 .PP
1709 #conky on irc.freenode.net
1710 .SH COPYING
1711 Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al.
1712 Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy).
1713 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).
1714 .SH AUTHORS
1715 The Conky dev team (see AUTHORS for a full list of contributors).