e9bed5830b935875fb52ae1287b6c7d0ac8ad4d3
[monky] / doc / conky.1
1 .\" -*- 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 2007-08-08 "" ""
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 the torsmo code.
24 Since it's original conception, Conky has changed a fair bit from it's predecessor.
25 Conky can display just about anything, either on your root desktop or in it's own window.
26 Conky has many built-in objects, as well as the ability to execute programs and scripts,
27 then display the output from stdout.
28 .PP
29 We are always looking for help, and anyone interested in becoming a developer is welcome.
30 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
31 .PP
32 Thanks for your interest in Conky.
33 .SH COMPILING
34 For users compiling from source, make sure you have the X development libraries installed.
35 This should be a package along the lines of "libx11-dev or xorg-x11-dev".
36 .PP
37 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
38 There is also usually an up-to-date ebuild within Conky's package or in Svn.
39 .PP
40 Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then
41 Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install.
42 .PP
43 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
44 .TP 
45 \fB\*(T<\fBsh autogen.sh\fR\*(T>\fR \*(T<\fB# Only required if building from SVN\fR\*(T> 
46 .TP 
47 \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> 
48 .TP 
49 \fB\*(T<\fBmake\fR\*(T>\fR 
50 .TP 
51 \fB\*(T<\fBmake install\fR\*(T>\fR \*(T<\fB# Optional\fR\*(T> 
52 .TP 
53 \fB\*(T<\fBsrc/conky\fR\*(T>\fR 
54 .PP
55 Conky probably doesn't compile with compilers other than gcc and icc.
56 It doesn't compile with C89 compiler and not even with pure C99.
57 It uses a few things that might not exist: strdup(), strcasecmp(), strncasecmp(),
58 optarg variable with getopt() and long long (not in C89). Crashes in file system
59 statistics stuff when compiled with icc, I don't know exactly why.
60 .PP
61 You can disable 'drawing to own window' feature in case you don't need it by passing
62 --disable-own-window to configure -script.
63 .PP
64 .SH "YOU SHOULD KNOW"
65 Conky is generally very good on resources. However, certain objects in
66 Conky are harder on resources then others. In particular, the $tail,
67 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
68 .PP
69 If you do use them, please do not complain about memory or CPU usage,
70 unless you think something's seriously wrong (mem leak, etc.).
71 .PP
72 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
73 Saves you the trouble of having to kill and then restart. You can now also do the same with SIGHUP.
74 .PP
75 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff.
76 mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
77 .SH OPTIONS
78 Command line options override configurations defined in configuration file.
79 .TP 
80 \fB\*(T<\fB\-v | \-V | \-\-verbose\fR\*(T>\fR
81 Prints version and exits
82
83 .TP 
84 \fB\*(T<\fB\-a | \-\-alignment=\fR\*(T>\fR\*(T<\fBALIGNMENT\fR\*(T>
85 Text alignment on screen, {top,bottom}_{left,right} or none
86
87 .TP 
88 \fB\*(T<\fB\-b | \-\-double\-buffer\fR\*(T>\fR
89 Use double buffering (eliminates "flicker")
90
91 .TP 
92 \fB\*(T<\fB\-c | \-\-config=\fR\*(T>\fR\*(T<\fBFILE\fR\*(T>
93 Config file to load instead of $HOME/.conkyrc
94
95 .TP 
96 \fB\*(T<\fB\-d | \-\-daemonize\fR\*(T>\fR
97 Daemonize Conky, aka fork to background
98
99 .TP 
100 \fB\*(T<\fB\-f | \-\-font=\fR\*(T>\fR\*(T<\fBFONT\fR\*(T>
101 Font to use
102
103 .TP 
104 \fB\*(T<\fB\-h | \-\-help\fR\*(T>\fR
105 Prints command line help and exits
106
107 .TP 
108 \fB\*(T<\fB\-o | \-\-own\-window\fR\*(T>\fR
109 Create own window to draw
110
111 .TP 
112 \fB\*(T<\fB\-t | \-\-text=\fR\*(T>\fR\*(T<\fBTEXT\fR\*(T>
113 Text to render, remember single quotes, like -t ' $uptime '
114
115 .TP 
116 \fB\*(T<\fB\-u | \-\-interval=\fR\*(T>\fR\*(T<\fBSECONDS\fR\*(T>
117 Update interval
118
119 .TP 
120 \fB\*(T<\fB\-w | \-\-window\-id=\fR\*(T>\fR\*(T<\fBWIN_ID\fR\*(T>
121 Window id to draw
122
123 .TP 
124 \fB\*(T<\fB\-x \fR\*(T>\fR\*(T<\fBX_COORDINATE\fR\*(T>
125 X position
126
127 .TP 
128 \fB\*(T<\fB\-y \fR\*(T>\fR\*(T<\fBY_COORDINATE\fR\*(T>
129 Y position
130
131 .SH "CONFIGURATION SETTINGS"
132 Default configuration file is $HOME/.conkyrc (can be changed from
133 conky.c among other things). See conkyrc.sample. If installing from Debian package,
134 this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
135 .PP
136 You might want to copy it to $HOME/.conkyrc and then start modifying it.
137 Other configs can be found at http://conky.sf.net
138 .TP 
139 \fB\*(T<\fBalignment\fR\*(T>\fR
140 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)
141
142 .TP 
143 \fB\*(T<\fBbackground\fR\*(T>\fR
144 Boolean value, if true, Conky will be forked to background when started
145
146 .TP 
147 \fB\*(T<\fBborder_margin\fR\*(T>\fR
148 Border margin in pixels
149
150 .TP 
151 \fB\*(T<\fBborder_width\fR\*(T>\fR
152 Border width in pixels
153
154 .TP 
155 \fB\*(T<\fBcolor0\fR\*(T>\fR
156 A color variable for use inside TEXT segments
157
158 .TP 
159 \fB\*(T<\fBcolor1\fR\*(T>\fR
160 A color variable for use inside TEXT segments
161
162 .TP 
163 \fB\*(T<\fBcolor2\fR\*(T>\fR
164 A color variable for use inside TEXT segments
165
166 .TP 
167 \fB\*(T<\fBcolor3\fR\*(T>\fR
168 A color variable for use inside TEXT segments
169
170 .TP 
171 \fB\*(T<\fBcolor4\fR\*(T>\fR
172 A color variable for use inside TEXT segments
173
174 .TP 
175 \fB\*(T<\fBcolor5\fR\*(T>\fR
176 A color variable for use inside TEXT segments
177
178 .TP 
179 \fB\*(T<\fBcolor6\fR\*(T>\fR
180 A color variable for use inside TEXT segments
181
182 .TP 
183 \fB\*(T<\fBcolor7\fR\*(T>\fR
184 A color variable for use inside TEXT segments
185
186 .TP 
187 \fB\*(T<\fBcolor8\fR\*(T>\fR
188 A color variable for use inside TEXT segments
189
190 .TP 
191 \fB\*(T<\fBcolor9\fR\*(T>\fR
192 A color variable for use inside TEXT segments
193
194 .TP 
195 \fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
196 The number of samples to average for CPU monitoring
197
198 .TP 
199 \fB\*(T<\fBtop_cpu_separate\fR\*(T>\fR
200 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.
201
202 .TP 
203 \fB\*(T<\fBdefault_color\fR\*(T>\fR
204 Default color and border color
205
206 .TP 
207 \fB\*(T<\fBdefault_outline_color\fR\*(T>\fR
208 Default outline color
209
210 .TP 
211 \fB\*(T<\fBdefault_shade_color\fR\*(T>\fR
212 Default shading color and border's shading color
213
214 .TP 
215 \fB\*(T<\fBdouble_buffer\fR\*(T>\fR
216 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.
217
218 .TP 
219 \fB\*(T<\fBdraw_borders\fR\*(T>\fR
220 Draw borders around text?
221
222 .TP 
223 \fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
224 Draw borders around graphs?
225
226 .TP 
227 \fB\*(T<\fBdraw_outline\fR\*(T>\fR
228 Draw outlines?
229
230 .TP 
231 \fB\*(T<\fBdraw_shades\fR\*(T>\fR
232 Draw shades?
233
234 .TP 
235 \fB\*(T<\fBfont\fR\*(T>\fR
236 Font name in X, xfontsel can be used to get a nice font
237
238 .TP 
239 \fB\*(T<\fBgap_x\fR\*(T>\fR
240 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
241 e.g. gap_x 10
242
243 .TP 
244 \fB\*(T<\fBgap_y\fR\*(T>\fR
245 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
246 e.g. gap_y 10.
247
248 .TP 
249 \fB\*(T<\fBimap\fR\*(T>\fR
250 Default global IMAP server. Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command]". Default port is 143, default folder is 'INBOX', default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
251
252 .TP 
253 \fB\*(T<\fBmail_spool\fR\*(T>\fR
254 Mail spool for mail checking
255
256 .TP 
257 \fB\*(T<\fBmax_port_monitor_connections\fR\*(T>\fR
258 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
259
260 .TP 
261 \fB\*(T<\fBmax_specials\fR\*(T>\fR
262 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
263
264 .TP 
265 \fB\*(T<\fBmax_user_text\fR\*(T>\fR \*(T<\fBbytes\fR\*(T> 
266 Maximum size of user text buffer, i.e. layout below TEXT line in config file
267 (default is 16384 bytes)
268
269 .TP 
270 \fB\*(T<\fBtext_buffer_size\fR\*(T>\fR \*(T<\fBbytes\fR\*(T> 
271 Size of the standard text buffer (default is 128 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 128 bytes.
272
273 .TP 
274 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T> 
275 Maximum width of window
276
277 .TP 
278 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T> 
279 Minimum size of window
280
281 .TP 
282 \fB\*(T<\fBmpd_host\fR\*(T>\fR
283 Host of MPD server
284
285 .TP 
286 \fB\*(T<\fBmpd_port\fR\*(T>\fR
287 Port of MPD server
288
289 .TP 
290 \fB\*(T<\fBmpd_password\fR\*(T>\fR
291 MPD server password
292
293 .TP 
294 \fB\*(T<\fBmusic_player_interval\fR\*(T>\fR
295 Music player thread update interval (defaults to Conky's update interval)
296
297 .TP 
298 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
299 The number of samples to average for net data
300
301 .TP 
302 \fB\*(T<\fBno_buffers\fR\*(T>\fR
303 Substract (file system) buffers from used memory?
304
305 .TP 
306 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
307 Force UTF8? requires XFT
308
309 .TP 
310 \fB\*(T<\fBown_window\fR\*(T>\fR
311 Boolean, create own window to draw?
312
313 .TP 
314 \fB\*(T<\fBown_window_class\fR\*(T>\fR
315 Manually set the WM_CLASS name. Defaults to "Conky".
316
317 .TP 
318 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T> 
319 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)
320
321 .TP 
322 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T> 
323 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
324 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
325 If you use own_window_type override, window manager hints have no meaning and are ignored.
326
327 .TP 
328 \fB\*(T<\fBown_window_title\fR\*(T>\fR
329 Manually set the window name. Defaults to "<hostname> - conky".
330
331 .TP 
332 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
333 Boolean, set pseudo-transparency?
334
335 .TP 
336 \fB\*(T<\fBown_window_type\fR\*(T>\fR
337 if own_window is yes, you may specify type normal, desktop or override (default: normal).
338 Desktop windows are special windows that have no window decorations; are always visible
339 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
340 Override windows are not under the control of the window manager. Hints are ignored. This type
341 of window can be useful for certain situations.
342
343 .TP 
344 \fB\*(T<\fBout_to_console\fR\*(T>\fR 
345 Print text to stdout.
346
347 .TP 
348 \fB\*(T<\fBpad_percents\fR\*(T>\fR
349 Pad percentages to this many decimals (0 = no padding)
350
351 .TP 
352 \fB\*(T<\fBpop3\fR\*(T>\fR
353 Default global POP3 server. Arguments are: "host user pass [-i interval] [-p port] [-e command]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
354
355 .TP 
356 \fB\*(T<\fBshort_units\fR\*(T>\fR
357 Shortens units to a single character (kiB->k, GiB->G, etc.). Default is off.
358
359 .TP 
360 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
361 Border stippling (dashing) in pixels
362
363 .TP 
364 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
365 Total number of times for Conky to update before quitting. Zero makes Conky run forever
366
367 .TP 
368 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
369 Update interval in seconds
370
371 .TP 
372 \fB\*(T<\fBuppercase\fR\*(T>\fR
373 Boolean value, if true, text is rendered in upper case
374
375 .TP 
376 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
377 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.
378
379 .TP 
380 \fB\*(T<\fBuse_xft\fR\*(T>\fR
381 Use Xft (anti-aliased font and stuff)
382
383 .TP 
384 \fB\*(T<\fBxftalpha\fR\*(T>\fR
385 Alpha of Xft font. Must be a value at or between 1 and 0.
386
387 .TP 
388 \fB\*(T<\fBxftfont\fR\*(T>\fR
389 Xft font to use.
390
391 .TP 
392 \fB\*(T<\fBTEXT\fR\*(T>\fR
393 After this begins text to be formatted on screen
394
395 .SH VARIABLES
396 Colors are parsed using XParsecolor(), there might be a list of them:
397 /usr/X11R6/lib/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
398 Color can be also in #rrggbb format (hex).
399 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
400 means 1024*1024 bytes and not 1000*1000.
401 .TP 
402 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> 
403 IP address for an interface
404
405 .TP 
406 \fB\*(T<\fBaddrs\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> 
407 IP addresses for an interface (if one - works like addr). Linux only.
408
409 .TP 
410 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR 
411 ACPI ac adapter state.
412
413 .TP 
414 \fB\*(T<\fBacpifan\fR\*(T>\fR 
415 ACPI fan state
416
417 .TP 
418 \fB\*(T<\fBacpitemp\fR\*(T>\fR 
419 ACPI temperature in C.
420
421 .TP 
422 \fB\*(T<\fBacpitempf\fR\*(T>\fR 
423 ACPI temperature in F.
424
425 .TP 
426 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR 
427 CPU temperature from therm_adt746x
428
429 .TP 
430 \fB\*(T<\fBadt746xfan\fR\*(T>\fR 
431 Fan speed from therm_adt746x
432
433 .TP 
434 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
435 Right-justify text, with space of N
436
437 .TP 
438 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
439 Align text to centre
440
441 .TP 
442 \fB\*(T<\fBapm_adapter\fR\*(T>\fR 
443 Display APM AC adapter status (FreeBSD only)
444
445 .TP 
446 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR 
447 Display APM battery life in percent (FreeBSD only)
448
449 .TP 
450 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR 
451 Display remaining APM battery life in hh:mm:ss or "unknown" if
452 AC adapterstatus is on-line or charging (FreeBSD only)
453
454 .TP 
455 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
456 Progress bar
457
458 .TP 
459 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR 
460 Bitrate of current tune
461
462 .TP 
463 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR 
464 Number of audio channels of current tune
465
466 .TP 
467 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR 
468 Full path and filename of current tune
469
470 .TP 
471 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR 
472 Sampling frequency of current tune
473
474 .TP 
475 \fB\*(T<\fBaudacious_length\fR\*(T>\fR 
476 Total length of current tune as MM:SS
477
478 .TP 
479 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR 
480 Total length of current tune in seconds
481
482 .TP 
483 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR 
484 Playlist position of current tune
485
486 .TP 
487 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR 
488 Number of tunes in playlist
489
490 .TP 
491 \fB\*(T<\fBaudacious_position\fR\*(T>\fR 
492 Position of current tune (MM:SS)
493
494 .TP 
495 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR 
496 Position of current tune in seconds
497
498 .TP 
499 \fB\*(T<\fBaudacious_status\fR\*(T>\fR 
500 Player status (Playing/Paused/Stopped/Not running)
501
502 .TP 
503 \fB\*(T<\fBaudacious_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
504 Title of current tune with optional maximum length specifier
505
506 .TP 
507 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
508 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
509
510 .TP 
511 \fB\*(T<\fBbattery_bar\fR\*(T>\fR \*(T<\fB(height),(width) (num)\fR\*(T> 
512 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
513
514 .TP 
515 \fB\*(T<\fBbattery_percent\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
516 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
517
518 .TP 
519 \fB\*(T<\fBbattery_time\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
520 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
521
522 .TP 
523 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR 
524 Artist in current BMPx track
525
526 .TP 
527 \fB\*(T<\fBbmpx_album\fR\*(T>\fR 
528 Album in current BMPx track
529
530 .TP 
531 \fB\*(T<\fBbmpx_title\fR\*(T>\fR 
532 Title of the current BMPx track
533
534 .TP 
535 \fB\*(T<\fBbmpx_track\fR\*(T>\fR 
536 Track number of the current BMPx track
537
538 .TP 
539 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR 
540 Bitrate of the current BMPx track
541
542 .TP 
543 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR 
544 URI of the current BMPx track
545
546 .TP 
547 \fB\*(T<\fBbuffers\fR\*(T>\fR 
548 Amount of memory buffered
549
550 .TP 
551 \fB\*(T<\fBcached\fR\*(T>\fR 
552 Amount of memory cached
553
554 .TP 
555 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
556 Change drawing color to color
557
558 .TP 
559 \fB\*(T<\fBcolor0\fR\*(T>\fR 
560 Change drawing color to color0 configuration option
561
562 .TP 
563 \fB\*(T<\fBcolor1\fR\*(T>\fR 
564 Change drawing color to color1 configuration option
565
566 .TP 
567 \fB\*(T<\fBcolor2\fR\*(T>\fR 
568 Change drawing color to color2 configuration option
569
570 .TP 
571 \fB\*(T<\fBcolor3\fR\*(T>\fR 
572 Change drawing color to color3 configuration option
573
574 .TP 
575 \fB\*(T<\fBcolor4\fR\*(T>\fR 
576 Change drawing color to color4 configuration option
577
578 .TP 
579 \fB\*(T<\fBcolor5\fR\*(T>\fR 
580 Change drawing color to color5 configuration option
581
582 .TP 
583 \fB\*(T<\fBcolor6\fR\*(T>\fR 
584 Change drawing color to color6 configuration option
585
586 .TP 
587 \fB\*(T<\fBcolor7\fR\*(T>\fR 
588 Change drawing color to color7 configuration option
589
590 .TP 
591 \fB\*(T<\fBcolor8\fR\*(T>\fR 
592 Change drawing color to color8 configuration option
593
594 .TP 
595 \fB\*(T<\fBcolor9\fR\*(T>\fR 
596 Change drawing color to color9 configuration option
597
598 .TP 
599 \fB\*(T<\fBconky_version\fR\*(T>\fR 
600 Conky version
601
602 .TP 
603 \fB\*(T<\fBconky_build_date\fR\*(T>\fR 
604 Date Conky was built
605
606 .TP 
607 \fB\*(T<\fBconky_bulid_arch\fR\*(T>\fR 
608 CPU architecture Conky was built for
609
610 .TP 
611 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T> 
612 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.
613
614 .TP 
615 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T> 
616 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
617
618 .TP 
619 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T> 
620 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
621
622 .TP 
623 \fB\*(T<\fBdiskio\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
624 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
625
626 .TP 
627 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
628 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
629
630 .TP 
631 \fB\*(T<\fBdiskio_read\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
632 Displays current disk IO for reads. Device as in diskio.
633
634 .TP 
635 \fB\*(T<\fBdiskiograph_read\fR\*(T>\fR \*(T<\fB(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
636 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.
637
638 .TP 
639 \fB\*(T<\fBdiskio_write\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
640 Displays current disk IO for writes. Device as in diskio.
641
642 .TP 
643 \fB\*(T<\fBdiskiograph_write\fR\*(T>\fR \*(T<\fB(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
644 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.
645
646 .TP 
647 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
648 Download speed in kilobytes
649
650 .TP 
651 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
652 Download speed in kilobytes with one decimal
653
654 .TP 
655 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
656 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
657
658 .TP 
659 \fB\*(T<\fBelse\fR\*(T>\fR 
660 Text to show if any of the above are not true
661
662 .TP 
663 \fB\*(T<\fBentropy_avail\fR\*(T>\fR 
664 Current entropy available for crypto freaks
665
666 .TP 
667 \fB\*(T<\fBentropy_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
668 Normalized bar of available entropy for crypto freaks
669
670 .TP 
671 \fB\*(T<\fBentropy_poolsize\fR\*(T>\fR 
672 Total size of system entropy pool for crypto freaks
673
674 .TP 
675 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
676 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.
677
678 .TP 
679 \fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
680 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.
681 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.
682
683 .TP 
684 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
685 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 the bar is currently fixed, but that may change in the future.
686
687 .TP 
688 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
689 Same as execbar, but graphs values.
690
691 .TP 
692 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
693 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
694
695 .TP 
696 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
697 Same as execbar, except with an interval
698
699 .TP 
700 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
701 Same as execigraph, but takes an interval arg graphs values
702
703 .TP 
704 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T> 
705 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)
706
707 .TP 
708 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
709 Returns CPU #n's frequency in MHz. CPUs are
710 counted from 1. If omitted, the parameter
711 defaults to 1.
712
713 .TP 
714 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
715 Returns CPU #n's frequency in GHz. CPUs are
716 counted from 1. If omitted, the parameter
717 defaults to 1.
718
719 .TP 
720 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR 
721 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
722
723 .TP 
724 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR 
725 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
726
727 .TP 
728 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T> 
729 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.
730
731 .TP 
732 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
733 Free space on a file system available for users.
734
735 .TP 
736 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
737 Free percentage of space on a file system available for users.
738
739 .TP 
740 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
741 File system size
742
743 .TP 
744 \fB\*(T<\fBfs_type\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
745 File system type
746
747 .TP 
748 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
749 File system used space
750
751 .TP 
752 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T> 
753 The next element will be printed at position 'x'.
754
755 .TP 
756 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T> 
757 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
758 Default host is 127.0.0.1, default port is 7634.
759
760 .TP 
761 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
762 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.
763
764 .TP 
765 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T> 
766 Horizontal line, height is the height in pixels
767
768 .TP 
769 \fB\*(T<\fBhwmon\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
770 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' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
771
772 .TP 
773 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T> 
774 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
775
776 .TP 
777 \fB\*(T<\fBiconv_stop\fR\*(T>\fR 
778 Stop iconv codeset conversion.
779
780 .TP 
781 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
782 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' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
783
784 .TP 
785 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR 
786 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.
787
788 .TP 
789 \fB\*(T<\fBi8k_bios\fR\*(T>\fR 
790 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
791
792 .TP 
793 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR 
794 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
795
796 .TP 
797 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR 
798 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
799
800 .TP 
801 \fB\*(T<\fBi8k_cpu_tempf\fR\*(T>\fR 
802 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
803
804 .TP 
805 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR 
806 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.
807
808 .TP 
809 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR 
810 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.
811
812 .TP 
813 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR 
814 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.
815
816 .TP 
817 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR 
818 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.
819
820 .TP 
821 \fB\*(T<\fBi8k_serial\fR\*(T>\fR 
822 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
823
824 .TP 
825 \fB\*(T<\fBi8k_version\fR\*(T>\fR 
826 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
827
828 .TP 
829 \fB\*(T<\fBibm_fan\fR\*(T>\fR 
830 If running the IBM ACPI, displays the fan speed.
831
832 .TP 
833 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T> 
834 If running the IBM ACPI, displays the temperatures
835 from the IBM temperature sensors (N=0..7) Sensor 0 is
836 on the CPU, 3 is on the GPU.
837
838 .TP 
839 \fB\*(T<\fBibm_volume\fR\*(T>\fR 
840 If running the IBM ACPI, displays the "master" volume,
841 controlled by the volume keys (0-14).
842
843 .TP 
844 \fB\*(T<\fBibm_brightness\fR\*(T>\fR 
845 If running the IBM ACPI, displays the brigtness of the
846 laptops's LCD (0-7).
847
848 .TP 
849 \fB\*(T<\fBif_empty\fR\*(T>\fR \*(T<\fB(var)\fR\*(T> 
850 if conky variable VAR is empty, display everything between $if_empty and the matching $endif
851
852 .TP 
853 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T> 
854 if PROCESS is running, display everything $if_running and the matching $endif
855
856 .TP 
857 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fBfile (string)\fR\*(T> 
858 if FILE exists, display everything between if_existing and the matching $endif. The optional second paramater checks for FILE containing the specified string and prints everything between $if_existing and the matching $endif.
859
860 .TP 
861 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T> 
862 if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
863
864 .TP 
865 \fB\*(T<\fBif_smapi_bat_installed\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T> 
866 when using smapi, if the battery with index INDEX is installed, display everything between $if_smapi_bat_installed and the matching $endif
867
868 .TP 
869 \fB\*(T<\fBif_up\fR\*(T>\fR \*(T<\fB(interface)\fR\*(T> 
870 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
871
872 .TP 
873 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
874 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]". Default port is 143, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
875
876 .TP 
877 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
878 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]". Default port is 143, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
879
880 .TP 
881 \fB\*(T<\fBkernel\fR\*(T>\fR 
882 Kernel version
883
884 .TP 
885 \fB\*(T<\fBloadavg\fR\*(T>\fR 
886 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
887
888 .TP 
889 \fB\*(T<\fBmachine\fR\*(T>\fR 
890 Machine, i686 for example
891
892 .TP 
893 \fB\*(T<\fBmails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
894 Mail count in the specified mailbox or your mail spool if not.
895 Both mbox and maildir type mailboxes are supported. You can
896 use a program like fetchmail to get mails from some server
897 using your favourite protocol. See also new_mails.
898
899 .TP 
900 \fB\*(T<\fBmboxscan\fR\*(T>\fR \*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T> 
901 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"}
902
903 .TP 
904 \fB\*(T<\fBmem\fR\*(T>\fR 
905 Amount of memory in use
906
907 .TP 
908 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
909 Bar that shows amount of memory in use
910
911 .TP 
912 \fB\*(T<\fBmemmax\fR\*(T>\fR 
913 Total amount of memory
914
915 .TP 
916 \fB\*(T<\fBmemperc\fR\*(T>\fR 
917 Percentage of memory in use
918
919 .TP 
920 \fB\*(T<\fBmpd_artist\fR\*(T>\fR 
921 Artist in current MPD song must be enabled at compile
922
923 .TP 
924 \fB\*(T<\fBmpd_album\fR\*(T>\fR 
925 Album in current MPD song
926
927 .TP 
928 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
929 Bar of mpd's progress
930
931 .TP 
932 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR 
933 Bitrate of current song
934
935 .TP 
936 \fB\*(T<\fBmpd_status\fR\*(T>\fR 
937 Playing, stopped, et cetera.
938
939 .TP 
940 \fB\*(T<\fBmpd_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
941 Title of current MPD song
942
943 .TP 
944 \fB\*(T<\fBmpd_vol\fR\*(T>\fR 
945 MPD's volume
946
947 .TP 
948 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR 
949 Song's elapsed time
950
951 .TP 
952 \fB\*(T<\fBmpd_length\fR\*(T>\fR 
953 Song's length
954
955 .TP 
956 \fB\*(T<\fBmpd_percent\fR\*(T>\fR 
957 Percent of song's progress
958
959 .TP 
960 \fB\*(T<\fBmpd_random\fR\*(T>\fR 
961 Random status (On/Off)
962
963 .TP 
964 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR 
965 Repeat status (On/Off)
966
967 .TP 
968 \fB\*(T<\fBmpd_track\fR\*(T>\fR 
969 Prints the MPD track field
970
971 .TP 
972 \fB\*(T<\fBmpd_name\fR\*(T>\fR 
973 Prints the MPD name field
974
975 .TP 
976 \fB\*(T<\fBmpd_file\fR\*(T>\fR 
977 Prints the file name of the current MPD song
978
979 .TP 
980 \fB\*(T<\fBmpd_smart\fR\*(T>\fR 
981 Prints the song name in either the form "artist - title" or file name, depending on whats available
982
983 .TP 
984 \fB\*(T<\fBnew_mails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
985 Unread mail count in the specified mailbox or mail spool if
986 not. Both mbox and maildir type mailboxes are supported.
987
988 .TP 
989 \fB\*(T<\fBnodename\fR\*(T>\fR 
990 Hostname
991
992 .TP 
993 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
994 Change outline color
995
996 .TP 
997 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T> 
998 If running on Apple powerbook/ibook, display
999 information on battery status. The item parameter
1000 specifies, what information to display. Exactly one item
1001 must be specified. Valid items are:
1002
1003 \fBstatus\fR:
1004 Display if battery is fully charged, charging,
1005 discharging or absent (running on AC)
1006 .br
1007 \fBpercent\fR:
1008 Display charge of battery in percent, if
1009 charging or discharging. Nothing will be
1010 displayed, if battery is fully charged
1011 or absent.
1012 .br
1013 \fBtime\fR:
1014 Display the time remaining until the battery
1015 will be fully charged or discharged at current
1016 rate. Nothing is displayed, if battery is
1017 absent or if it's present but fully charged
1018 and not discharging.
1019
1020 .TP 
1021 \fB\*(T<\fBplatform\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
1022 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' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
1023
1024 .TP 
1025 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
1026 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]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1027
1028 .TP 
1029 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
1030 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]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1031
1032 .TP 
1033 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T> 
1034 Executes a shell command one time before conky displays anything and puts output as text.
1035
1036 .TP 
1037 \fB\*(T<\fBprocesses\fR\*(T>\fR 
1038 Total processes (sleeping and running)
1039
1040 .TP 
1041 \fB\*(T<\fBrunning_processes\fR\*(T>\fR 
1042 Running processes (not sleeping), requires Linux 2.6
1043
1044 .TP 
1045 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
1046 Change shading color
1047
1048 .TP 
1049 \fB\*(T<\fBsmapi\fR\*(T>\fR \*(T<\fB(ARGS)\fR\*(T> 
1050 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.
1051
1052 .TP 
1053 \fB\*(T<\fBsmapi_bat_perc\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T> 
1054 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.
1055
1056 .TP 
1057 \fB\*(T<\fBsmapi_bat_bar\fR\*(T>\fR \*(T<\fB(INDEX),(height),(width)\fR\*(T> 
1058 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1059
1060 .TP 
1061 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T> 
1062 Stippled (dashed) horizontal line
1063
1064 .TP 
1065 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1066 Bar that shows amount of swap in use
1067
1068 .TP 
1069 \fB\*(T<\fBswap\fR\*(T>\fR 
1070 Amount of swap in use
1071
1072 .TP 
1073 \fB\*(T<\fBswapmax\fR\*(T>\fR 
1074 Total amount of swap
1075
1076 .TP 
1077 \fB\*(T<\fBswapperc\fR\*(T>\fR 
1078 Percentage of swap in use
1079
1080 .TP 
1081 \fB\*(T<\fBsysname\fR\*(T>\fR 
1082 System name, Linux for example
1083
1084 .TP 
1085 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR 
1086 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1087
1088 \fBcount\fR - total number of connections in the range
1089 .br
1090 \fBrip\fR - remote ip address
1091 .br
1092 \fBrhost\fR - remote host name
1093 .br
1094 \fBrport\fR - remote port number
1095 .br
1096 \fBrservice\fR - remote service name from /etc/services
1097 .br
1098 \fBlip\fR - local ip address
1099 .br
1100 \fBlhost\fR - local host name
1101 .br
1102 \fBlport\fR - local port number
1103 .br
1104 \fBlservice\fR - local service name from /etc/services
1105
1106 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.
1107
1108 Examples:
1109 .br
1110 \fB${tcp_portmon 6881 6999 count}\fR -
1111 displays the number of connections in the bittorrent port range
1112 .br
1113 \fB${tcp_portmon 22 22 rip 0}\fR -
1114 displays the remote host ip of the first sshd connection
1115 .br
1116 \fB${tcp_portmon 22 22 rip 9}\fR -
1117 displays the remote host ip of the tenth sshd connection
1118 .br
1119 \fB${tcp_portmon 1 1024 rhost 0}\fR -
1120 displays the remote host name of the first connection on a privileged port
1121 .br
1122 \fB${tcp_portmon 1 1024 rport 4}\fR -
1123 displays the remote host port of the fifth connection on a privileged port
1124 .br
1125 \fB${tcp_portmon 1 65535 lservice 14}\fR -
1126 displays the local service name of the fifteenth connection in the range of all ports
1127
1128 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.
1129 .TP 
1130 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
1131 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.
1132
1133 .TP 
1134 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1135 Move text over by N pixels. See also $voffset.
1136
1137 .TP 
1138 \fB\*(T<\fBrss\fR\*(T>\fR \*(T<\fBurl delay_in_minutes action item_num\fR\*(T> 
1139 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.
1140
1141 .TP 
1142 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T> 
1143 Puts a tab of the specified width, starting from column 'start'.
1144
1145 .TP 
1146 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
1147 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.
1148
1149 .TP 
1150 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1151 Local time, see man strftime to get more information about format
1152
1153 .TP 
1154 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1155 Display time in UTC (universal coordinate time).
1156
1157 .TP 
1158 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T> 
1159 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.
1160
1161 .TP 
1162 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1163 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.
1164
1165 .TP 
1166 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1167 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", and "time". There can be a max of 10 processes listed.
1168
1169 .TP 
1170 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1171 Same as top, except sorted by mem usage instead of cpu
1172
1173 .TP 
1174 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1175 Total upload, this one too, may overflow
1176
1177 .TP 
1178 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T> 
1179 for debugging
1180
1181 .TP 
1182 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1183 Upload speed in kilobytes
1184
1185 .TP 
1186 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1187 Upload speed in kilobytes with one decimal
1188
1189 .TP 
1190 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
1191 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
1192
1193 .TP 
1194 \fB\*(T<\fBuptime\fR\*(T>\fR 
1195 Uptime
1196
1197 .TP 
1198 \fB\*(T<\fBuptime_short\fR\*(T>\fR 
1199 Uptime in a shorter format
1200
1201 .TP 
1202 \fB\*(T<\fBuser_number\fR\*(T>\fR 
1203 Number of users logged in
1204
1205 .TP 
1206 \fB\*(T<\fBuser_names\fR\*(T>\fR 
1207 Lists the names of the users logged in
1208
1209 .TP 
1210 \fB\*(T<\fBuser_terms\fR\*(T>\fR 
1211 Lists the consoles in use
1212
1213 .TP 
1214 \fB\*(T<\fBuser_times\fR\*(T>\fR 
1215 Lists how long users have been logged in for
1216
1217 .TP 
1218 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1219 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1220
1221 .TP 
1222 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1223 Returns CPU #n's voltage in mV. CPUs are
1224 counted from 1. If omitted, the parameter
1225 defaults to 1.
1226
1227 .TP 
1228 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1229 Returns CPU #n's voltage in V. CPUs are
1230 counted from 1. If omitted, the parameter
1231 defaults to 1.
1232
1233 .TP 
1234 \fB\*(T<\fBwireless_essid\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1235 Wireless access point ESSID (Linux only)
1236
1237 .TP 
1238 \fB\*(T<\fBwireless_mode\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1239 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1240
1241 .TP 
1242 \fB\*(T<\fBwireless_bitrate\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1243 Wireless bitrate (ie 11 Mb/s) (Linux only)
1244
1245 .TP 
1246 \fB\*(T<\fBwireless_ap\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1247 Wireless access point MAC address (Linux only)
1248
1249 .TP 
1250 \fB\*(T<\fBwireless_link_qual\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1251 Wireless link quality (Linux only)
1252
1253 .TP 
1254 \fB\*(T<\fBwireless_link_qual_max\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1255 Wireless link quality maximum value (Linux only)
1256
1257 .TP 
1258 \fB\*(T<\fBwireless_link_qual_perc\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1259 Wireless link quality in percents (Linux only)
1260
1261 .TP 
1262 \fB\*(T<\fBwireless_link_bar\fR\*(T>\fR \*(T<\fB(height), (width) net\fR\*(T> 
1263 Wireless link quality bar (Linux only)
1264
1265 .TP 
1266 \fB\*(T<\fBxmms2_artist\fR\*(T>\fR 
1267 Artist in current XMMS2 song
1268
1269 .TP 
1270 \fB\*(T<\fBxmms2_album\fR\*(T>\fR 
1271 Album in current XMMS2 song
1272
1273 .TP 
1274 \fB\*(T<\fBxmms2_title\fR\*(T>\fR 
1275 Title in current XMMS2 song
1276
1277 .TP 
1278 \fB\*(T<\fBxmms2_genre\fR\*(T>\fR 
1279 Genre in current XMMS2 song
1280
1281 .TP 
1282 \fB\*(T<\fBxmms2_comment\fR\*(T>\fR 
1283 Comment in current XMMS2 song
1284
1285 .TP 
1286 \fB\*(T<\fBxmms2_decoder\fR\*(T>\fR 
1287 Decoder plugin used
1288
1289 .TP 
1290 \fB\*(T<\fBxmms2_transport\fR\*(T>\fR 
1291 Transport plugin used
1292
1293 .TP 
1294 \fB\*(T<\fBxmms2_url\fR\*(T>\fR 
1295 Full path to current song
1296
1297 .TP 
1298 \fB\*(T<\fBxmms2_tracknr\fR\*(T>\fR 
1299 Track number in current XMMS2 song
1300
1301 .TP 
1302 \fB\*(T<\fBxmms2_bitrate\fR\*(T>\fR 
1303 Bitrate of current song
1304
1305 .TP 
1306 \fB\*(T<\fBxmms2_id\fR\*(T>\fR 
1307 XMMS2 id of current song
1308
1309 .TP 
1310 \fB\*(T<\fBxmms2_duration\fR\*(T>\fR 
1311 Duration of current song
1312
1313 .TP 
1314 \fB\*(T<\fBxmms2_elapsed\fR\*(T>\fR 
1315 Song's elapsed time
1316
1317 .TP 
1318 \fB\*(T<\fBxmms2_size\fR\*(T>\fR 
1319 Size of current song
1320
1321 .TP 
1322 \fB\*(T<\fBxmms2_percent\fR\*(T>\fR 
1323 Percent of song's progress
1324
1325 .TP 
1326 \fB\*(T<\fBxmms2_status\fR\*(T>\fR 
1327 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1328
1329 .TP 
1330 \fB\*(T<\fBxmms2_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1331 Bar of XMMS2's progress
1332
1333 .TP 
1334 \fB\*(T<\fBxmms2_smart\fR\*(T>\fR 
1335 Prints the song name in either the form "artist - title" or file name, depending on whats available
1336
1337 .SH EXAMPLES
1338 .TP 
1339 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%M}' \-o \-u 30\fR\*(T>
1340 Start Conky in its own window with date and clock as text and 30 sec update interval.
1341 .TP 
1342 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1343 Start Conky to background at coordinates (5, 500).
1344 .SH FILES
1345 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1346 .SH BUGS
1347 Drawing to root or some other desktop window directly doesn't work with
1348 all window managers. Especially doesn't work well with Gnome and it has
1349 been reported that it doesn't work with KDE either. Nautilus can be
1350 disabled from drawing to desktop with program gconf-editor. Uncheck
1351 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1352 to set some specific window id. You might find xwininfo -tree useful to
1353 find the window to draw to. You can also use -o argument which makes
1354 Conky to create its own window.
1355 .SH "SEE ALSO"
1356 \(lahttp://conky.sourceforge.net\(ra
1357 .PP
1358 \(lahttp://www.sourceforge.net/projects/conky\(ra
1359 .PP
1360 #conky on irc.freenode.net
1361 .SH AUTHORS
1362 The Conky dev team. What's up now!