91e5e7a2f5c7434ac0d5d6901a0aacfefd18a5b3
[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.
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, bottom_left, bottom_right, or none
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 1280 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<\fBstippled_borders\fR\*(T>\fR
357 Border stippling (dashing) in pixels
358
359 .TP 
360 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
361 Total number of times for Conky to update before quitting. Zero makes Conky run forever
362
363 .TP 
364 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
365 Update interval in seconds
366
367 .TP 
368 \fB\*(T<\fBuppercase\fR\*(T>\fR
369 Boolean value, if true, text is rendered in upper case
370
371 .TP 
372 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
373 Adds spaces after certain objects to stop them from moving other things around. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
374
375 .TP 
376 \fB\*(T<\fBuse_xft\fR\*(T>\fR
377 Use Xft (anti-aliased font and stuff)
378
379 .TP 
380 \fB\*(T<\fBxftalpha\fR\*(T>\fR
381 Alpha of Xft font. Must be a value at or between 1 and 0.
382
383 .TP 
384 \fB\*(T<\fBxftfont\fR\*(T>\fR
385 Xft font to use.
386
387 .TP 
388 \fB\*(T<\fBTEXT\fR\*(T>\fR
389 After this begins text to be formatted on screen
390
391 .SH VARIABLES
392 Colors are parsed using XParsecolor(), there might be a list of them:
393 /usr/X11R6/lib/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
394 Color can be also in #rrggbb format (hex).
395 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
396 means 1024*1024 bytes and not 1000*1000.
397 .TP 
398 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> 
399 IP address for an interface
400
401 .TP 
402 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR 
403 ACPI ac adapter state.
404
405 .TP 
406 \fB\*(T<\fBacpifan\fR\*(T>\fR 
407 ACPI fan state
408
409 .TP 
410 \fB\*(T<\fBacpitemp\fR\*(T>\fR 
411 ACPI temperature in C.
412
413 .TP 
414 \fB\*(T<\fBacpitempf\fR\*(T>\fR 
415 ACPI temperature in F.
416
417 .TP 
418 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR 
419 CPU temperature from therm_adt746x
420
421 .TP 
422 \fB\*(T<\fBadt746xfan\fR\*(T>\fR 
423 Fan speed from therm_adt746x
424
425 .TP 
426 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
427 Right-justify text, with space of N
428
429 .TP 
430 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
431 Align text to centre
432
433 .TP 
434 \fB\*(T<\fBapm_adapter\fR\*(T>\fR 
435 Display APM AC adapter status (FreeBSD only)
436
437 .TP 
438 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR 
439 Display APM battery life in percent (FreeBSD only)
440
441 .TP 
442 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR 
443 Display remaining APM battery life in hh:mm:ss or "unknown" if
444 AC adapterstatus is on-line or charging (FreeBSD only)
445
446 .TP 
447 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
448 Progress bar
449
450 .TP 
451 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR 
452 Bitrate of current tune
453
454 .TP 
455 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR 
456 Number of audio channels of current tune
457
458 .TP 
459 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR 
460 Full path and filename of current tune
461
462 .TP 
463 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR 
464 Sampling frequency of current tune
465
466 .TP 
467 \fB\*(T<\fBaudacious_length\fR\*(T>\fR 
468 Total length of current tune as MM:SS
469
470 .TP 
471 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR 
472 Total length of current tune in seconds
473
474 .TP 
475 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR 
476 Playlist position of current tune
477
478 .TP 
479 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR 
480 Number of tunes in playlist
481
482 .TP 
483 \fB\*(T<\fBaudacious_position\fR\*(T>\fR 
484 Position of current tune (MM:SS)
485
486 .TP 
487 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR 
488 Position of current tune in seconds
489
490 .TP 
491 \fB\*(T<\fBaudacious_status\fR\*(T>\fR 
492 Player status (Playing/Paused/Stopped/Not running)
493
494 .TP 
495 \fB\*(T<\fBaudacious_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
496 Title of current tune with optional maximum length specifier
497
498 .TP 
499 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
500 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
501
502 .TP 
503 \fB\*(T<\fBbattery_bar\fR\*(T>\fR \*(T<\fB(height),(width) (num)\fR\*(T> 
504 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
505
506 .TP 
507 \fB\*(T<\fBbattery_percent\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
508 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
509
510 .TP 
511 \fB\*(T<\fBbattery_time\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
512 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
513
514 .TP 
515 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR 
516 Artist in current BMPx track
517
518 .TP 
519 \fB\*(T<\fBbmpx_album\fR\*(T>\fR 
520 Album in current BMPx track
521
522 .TP 
523 \fB\*(T<\fBbmpx_title\fR\*(T>\fR 
524 Title of the current BMPx track
525
526 .TP 
527 \fB\*(T<\fBbmpx_track\fR\*(T>\fR 
528 Track number of the current BMPx track
529
530 .TP 
531 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR 
532 Bitrate of the current BMPx track
533
534 .TP 
535 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR 
536 URI of the current BMPx track
537
538 .TP 
539 \fB\*(T<\fBbuffers\fR\*(T>\fR 
540 Amount of memory buffered
541
542 .TP 
543 \fB\*(T<\fBcached\fR\*(T>\fR 
544 Amount of memory cached
545
546 .TP 
547 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
548 Change drawing color to color
549
550 .TP 
551 \fB\*(T<\fBcolor0\fR\*(T>\fR 
552 Change drawing color to color0 configuration option
553
554 .TP 
555 \fB\*(T<\fBcolor1\fR\*(T>\fR 
556 Change drawing color to color1 configuration option
557
558 .TP 
559 \fB\*(T<\fBcolor2\fR\*(T>\fR 
560 Change drawing color to color2 configuration option
561
562 .TP 
563 \fB\*(T<\fBcolor3\fR\*(T>\fR 
564 Change drawing color to color3 configuration option
565
566 .TP 
567 \fB\*(T<\fBcolor4\fR\*(T>\fR 
568 Change drawing color to color4 configuration option
569
570 .TP 
571 \fB\*(T<\fBcolor5\fR\*(T>\fR 
572 Change drawing color to color5 configuration option
573
574 .TP 
575 \fB\*(T<\fBcolor6\fR\*(T>\fR 
576 Change drawing color to color6 configuration option
577
578 .TP 
579 \fB\*(T<\fBcolor7\fR\*(T>\fR 
580 Change drawing color to color7 configuration option
581
582 .TP 
583 \fB\*(T<\fBcolor8\fR\*(T>\fR 
584 Change drawing color to color8 configuration option
585
586 .TP 
587 \fB\*(T<\fBcolor9\fR\*(T>\fR 
588 Change drawing color to color9 configuration option
589
590 .TP 
591 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T> 
592 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.
593
594 .TP 
595 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T> 
596 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
597
598 .TP 
599 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T> 
600 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
601
602 .TP 
603 \fB\*(T<\fBdiskio\fR\*(T>\fR 
604 Displays current disk IO.
605
606 .TP 
607 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
608 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
609
610 .TP 
611 \fB\*(T<\fBdiskio_read\fR\*(T>\fR 
612 Displays current disk IO for reads.
613
614 .TP 
615 \fB\*(T<\fBdiskiograph_read\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
616 Disk IO graph for reads, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
617
618 .TP 
619 \fB\*(T<\fBdiskio_write\fR\*(T>\fR 
620 Displays current disk IO for writes.
621
622 .TP 
623 \fB\*(T<\fBdiskiograph_write\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
624 Disk IO graph for writes, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
625
626 .TP 
627 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
628 Download speed in kilobytes
629
630 .TP 
631 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
632 Download speed in kilobytes with one decimal
633
634 .TP 
635 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
636 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
637
638 .TP 
639 \fB\*(T<\fBelse\fR\*(T>\fR 
640 Text to show if any of the above are not true
641
642 .TP 
643 \fB\*(T<\fBentropy_avail\fR\*(T>\fR 
644 Current entropy available for crypto freaks
645
646 .TP 
647 \fB\*(T<\fBentropy_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
648 Normalized bar of available entropy for crypto freaks
649
650 .TP 
651 \fB\*(T<\fBentropy_poolsize\fR\*(T>\fR 
652 Total size of system entropy pool for crypto freaks
653
654 .TP 
655 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
656 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.
657
658 .TP 
659 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
660 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.
661
662 .TP 
663 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
664 Same as execbar, but graphs values.
665
666 .TP 
667 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
668 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
669
670 .TP 
671 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
672 Same as execbar, except with an interval
673
674 .TP 
675 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
676 Same as execigraph, but takes an interval arg graphs values
677
678 .TP 
679 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T> 
680 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)
681
682 .TP 
683 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
684 Returns CPU #n's frequency in MHz. CPUs are
685 counted from 1. If omitted, the parameter
686 defaults to 1.
687
688 .TP 
689 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
690 Returns CPU #n's frequency in GHz. CPUs are
691 counted from 1. If omitted, the parameter
692 defaults to 1.
693
694 .TP 
695 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR 
696 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
697
698 .TP 
699 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR 
700 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
701
702 .TP 
703 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T> 
704 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.
705
706 .TP 
707 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
708 Free space on a file system available for users.
709
710 .TP 
711 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
712 Free percentage of space on a file system available for users.
713
714 .TP 
715 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
716 File system size
717
718 .TP 
719 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
720 File system used space
721
722 .TP 
723 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T> 
724 The next element will be printed at position 'x'.
725
726 .TP 
727 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T> 
728 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
729 Default host is 127.0.0.1, default port is 7634.
730
731 .TP 
732 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
733 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.
734
735 .TP 
736 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T> 
737 Horizontal line, height is the height in pixels
738
739 .TP 
740 \fB\*(T<\fBhwmon\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
741 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.
742
743 .TP 
744 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T> 
745 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
746
747 .TP 
748 \fB\*(T<\fBiconv_stop\fR\*(T>\fR 
749 Stop iconv codeset conversion.
750
751 .TP 
752 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
753 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.
754
755 .TP 
756 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR 
757 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.
758
759 .TP 
760 \fB\*(T<\fBi8k_bios\fR\*(T>\fR 
761 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
762
763 .TP 
764 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR 
765 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
766
767 .TP 
768 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR 
769 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
770
771 .TP 
772 \fB\*(T<\fBi8k_cpu_tempf\fR\*(T>\fR 
773 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
774
775 .TP 
776 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR 
777 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.
778
779 .TP 
780 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR 
781 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.
782
783 .TP 
784 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR 
785 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.
786
787 .TP 
788 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR 
789 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.
790
791 .TP 
792 \fB\*(T<\fBi8k_serial\fR\*(T>\fR 
793 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
794
795 .TP 
796 \fB\*(T<\fBi8k_version\fR\*(T>\fR 
797 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
798
799 .TP 
800 \fB\*(T<\fBibm_fan\fR\*(T>\fR 
801 If running the IBM ACPI, displays the fan speed.
802
803 .TP 
804 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T> 
805 If running the IBM ACPI, displays the temperatures
806 from the IBM temperature sensors (N=0..7) Sensor 0 is
807 on the CPU, 3 is on the GPU.
808
809 .TP 
810 \fB\*(T<\fBibm_volume\fR\*(T>\fR 
811 If running the IBM ACPI, displays the "master" volume,
812 controlled by the volume keys (0-14).
813
814 .TP 
815 \fB\*(T<\fBibm_brightness\fR\*(T>\fR 
816 If running the IBM ACPI, displays the brigtness of the
817 laptops's LCD (0-7).
818
819 .TP 
820 \fB\*(T<\fBif_empty\fR\*(T>\fR \*(T<\fB(var)\fR\*(T> 
821 if conky variable VAR is empty, display everything between $if_empty and the matching $endif
822
823 .TP 
824 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T> 
825 if PROCESS is running, display everything $if_running and the matching $endif
826
827 .TP 
828 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fBfile (string)\fR\*(T> 
829 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.
830
831 .TP 
832 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T> 
833 if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
834
835 .TP 
836 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
837 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.
838
839 .TP 
840 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
841 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.
842
843 .TP 
844 \fB\*(T<\fBkernel\fR\*(T>\fR 
845 Kernel version
846
847 .TP 
848 \fB\*(T<\fBloadavg\fR\*(T>\fR 
849 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
850
851 .TP 
852 \fB\*(T<\fBmachine\fR\*(T>\fR 
853 Machine, i686 for example
854
855 .TP 
856 \fB\*(T<\fBmails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
857 Mail count in the specified mailbox or your mail spool if not.
858 Both mbox and maildir type mailboxes are supported. You can
859 use a program like fetchmail to get mails from some server
860 using your favourite protocol. See also new_mails.
861
862 .TP 
863 \fB\*(T<\fBmboxscan\fR\*(T>\fR \*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T> 
864 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"}
865
866 .TP 
867 \fB\*(T<\fBmem\fR\*(T>\fR 
868 Amount of memory in use
869
870 .TP 
871 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
872 Bar that shows amount of memory in use
873
874 .TP 
875 \fB\*(T<\fBmemmax\fR\*(T>\fR 
876 Total amount of memory
877
878 .TP 
879 \fB\*(T<\fBmemperc\fR\*(T>\fR 
880 Percentage of memory in use
881
882 .TP 
883 \fB\*(T<\fBmpd_artist\fR\*(T>\fR 
884 Artist in current MPD song must be enabled at compile
885
886 .TP 
887 \fB\*(T<\fBmpd_album\fR\*(T>\fR 
888 Album in current MPD song
889
890 .TP 
891 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
892 Bar of mpd's progress
893
894 .TP 
895 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR 
896 Bitrate of current song
897
898 .TP 
899 \fB\*(T<\fBmpd_status\fR\*(T>\fR 
900 Playing, stopped, et cetera.
901
902 .TP 
903 \fB\*(T<\fBmpd_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
904 Title of current MPD song
905
906 .TP 
907 \fB\*(T<\fBmpd_vol\fR\*(T>\fR 
908 MPD's volume
909
910 .TP 
911 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR 
912 Song's elapsed time
913
914 .TP 
915 \fB\*(T<\fBmpd_length\fR\*(T>\fR 
916 Song's length
917
918 .TP 
919 \fB\*(T<\fBmpd_percent\fR\*(T>\fR 
920 Percent of song's progress
921
922 .TP 
923 \fB\*(T<\fBmpd_random\fR\*(T>\fR 
924 Random status (On/Off)
925
926 .TP 
927 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR 
928 Repeat status (On/Off)
929
930 .TP 
931 \fB\*(T<\fBmpd_track\fR\*(T>\fR 
932 Prints the MPD track field
933
934 .TP 
935 \fB\*(T<\fBmpd_name\fR\*(T>\fR 
936 Prints the MPD name field
937
938 .TP 
939 \fB\*(T<\fBmpd_file\fR\*(T>\fR 
940 Prints the file name of the current MPD song
941
942 .TP 
943 \fB\*(T<\fBmpd_smart\fR\*(T>\fR 
944 Prints the song name in either the form "artist - title" or file name, depending on whats available
945
946 .TP 
947 \fB\*(T<\fBnew_mails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
948 Unread mail count in the specified mailbox or mail spool if
949 not. Both mbox and maildir type mailboxes are supported.
950
951 .TP 
952 \fB\*(T<\fBnodename\fR\*(T>\fR 
953 Hostname
954
955 .TP 
956 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
957 Change outline color
958
959 .TP 
960 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T> 
961 If running on Apple powerbook/ibook, display
962 information on battery status. The item parameter
963 specifies, what information to display. Exactly one item
964 must be specified. Valid items are:
965
966 \fBstatus\fR:
967 Display if battery is fully charged, charging,
968 discharging or absent (running on AC)
969 .br
970 \fBpercent\fR:
971 Display charge of battery in percent, if
972 charging or discharging. Nothing will be
973 displayed, if battery is fully charged
974 or absent.
975 .br
976 \fBtime\fR:
977 Display the time remaining until the battery
978 will be fully charged or discharged at current
979 rate. Nothing is displayed, if battery is
980 absent or if it's present but fully charged
981 and not discharging.
982
983 .TP 
984 \fB\*(T<\fBplatform\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
985 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.
986
987 .TP 
988 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
989 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.
990
991 .TP 
992 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
993 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.
994
995 .TP 
996 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T> 
997 Executes a shell command one time before conky displays anything and puts output as text.
998
999 .TP 
1000 \fB\*(T<\fBprocesses\fR\*(T>\fR 
1001 Total processes (sleeping and running)
1002
1003 .TP 
1004 \fB\*(T<\fBrunning_processes\fR\*(T>\fR 
1005 Running processes (not sleeping), requires Linux 2.6
1006
1007 .TP 
1008 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
1009 Change shading color
1010
1011 .TP 
1012 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T> 
1013 Stippled (dashed) horizontal line
1014
1015 .TP 
1016 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1017 Bar that shows amount of swap in use
1018
1019 .TP 
1020 \fB\*(T<\fBswap\fR\*(T>\fR 
1021 Amount of swap in use
1022
1023 .TP 
1024 \fB\*(T<\fBswapmax\fR\*(T>\fR 
1025 Total amount of swap
1026
1027 .TP 
1028 \fB\*(T<\fBswapperc\fR\*(T>\fR 
1029 Percentage of swap in use
1030
1031 .TP 
1032 \fB\*(T<\fBsysname\fR\*(T>\fR 
1033 System name, Linux for example
1034
1035 .TP 
1036 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR 
1037 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1038
1039 \fBcount\fR - total number of connections in the range
1040 .br
1041 \fBrip\fR - remote ip address
1042 .br
1043 \fBrhost\fR - remote host name 
1044 .br
1045 \fBrport\fR - remote port number
1046 .br
1047 \fBrservice\fR - remote service name from /etc/services
1048 .br
1049 \fBlip\fR - local ip address
1050 .br
1051 \fBlhost\fR - local host name
1052 .br
1053 \fBlport\fR - local port number
1054 .br
1055 \fBlservice\fR - local service name from /etc/services
1056
1057 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.
1058
1059 Examples:
1060 .br
1061 \fB${tcp_portmon 6881 6999 count}\fR -
1062 displays the number of connections in the bittorrent port range
1063 .br
1064 \fB${tcp_portmon 22 22 rip 0}\fR -
1065 displays the remote host ip of the first sshd connection
1066 .br
1067 \fB${tcp_portmon 22 22 rip 9}\fR -
1068 displays the remote host ip of the tenth sshd connection
1069 .br
1070 \fB${tcp_portmon 1 1024 rhost 0}\fR -
1071 displays the remote host name of the first connection on a privileged port
1072 .br
1073 \fB${tcp_portmon 1 1024 rport 4}\fR -
1074 displays the remote host port of the fifth connection on a privileged port
1075 .br
1076 \fB${tcp_portmon 1 65535 lservice 14}\fR -
1077 displays the local service name of the fifteenth connection in the range of all ports
1078
1079 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. 
1080 .TP 
1081 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
1082 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.
1083
1084 .TP 
1085 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1086 Move text over by N pixels. See also $voffset.
1087
1088 .TP 
1089 \fB\*(T<\fBrss\fR\*(T>\fR \*(T<\fBurl delay_in_minutes action item_num\fR\*(T> 
1090 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.
1091
1092 .TP 
1093 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T> 
1094 Puts a tab of the specified width, starting from column 'start'.
1095
1096 .TP 
1097 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
1098 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.
1099
1100 .TP 
1101 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1102 Local time, see man strftime to get more information about format
1103
1104 .TP 
1105 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1106 Display time in UTC (universal coordinate time).
1107
1108 .TP 
1109 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T> 
1110 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.
1111
1112 .TP 
1113 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1114 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.
1115
1116 .TP 
1117 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1118 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.
1119
1120 .TP 
1121 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1122 Same as top, except sorted by mem usage instead of cpu
1123
1124 .TP 
1125 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1126 Total upload, this one too, may overflow
1127
1128 .TP 
1129 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T> 
1130 for debugging
1131
1132 .TP 
1133 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1134 Upload speed in kilobytes
1135
1136 .TP 
1137 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1138 Upload speed in kilobytes with one decimal
1139
1140 .TP 
1141 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
1142 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
1143
1144 .TP 
1145 \fB\*(T<\fBuptime\fR\*(T>\fR 
1146 Uptime
1147
1148 .TP 
1149 \fB\*(T<\fBuptime_short\fR\*(T>\fR 
1150 Uptime in a shorter format
1151
1152 .TP 
1153 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1154 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1155
1156 .TP 
1157 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1158 Returns CPU #n's voltage in mV. CPUs are
1159 counted from 1. If omitted, the parameter
1160 defaults to 1. 
1161
1162 .TP 
1163 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1164 Returns CPU #n's voltage in V. CPUs are
1165 counted from 1. If omitted, the parameter
1166 defaults to 1.
1167
1168 .TP 
1169 \fB\*(T<\fBwireless_essid\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1170 Wireless access point ESSID (Linux only)
1171
1172 .TP 
1173 \fB\*(T<\fBwireless_mode\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1174 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1175
1176 .TP 
1177 \fB\*(T<\fBwireless_bitrate\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1178 Wireless bitrate (ie 11 Mb/s) (Linux only)
1179
1180 .TP 
1181 \fB\*(T<\fBwireless_ap\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1182 Wireless access point MAC address (Linux only)
1183
1184 .TP 
1185 \fB\*(T<\fBwireless_link_qual\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1186 Wireless link quality (Linux only)
1187
1188 .TP 
1189 \fB\*(T<\fBwireless_link_qual_max\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1190 Wireless link quality maximum value (Linux only)
1191
1192 .TP 
1193 \fB\*(T<\fBwireless_link_qual_perc\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1194 Wireless link quality in percents (Linux only)
1195
1196 .TP 
1197 \fB\*(T<\fBwireless_link_bar\fR\*(T>\fR \*(T<\fB(height), (width) net\fR\*(T> 
1198 Wireless link quality bar (Linux only)
1199
1200 .TP 
1201 \fB\*(T<\fBxmms2_artist\fR\*(T>\fR 
1202 Artist in current XMMS2 song
1203
1204 .TP 
1205 \fB\*(T<\fBxmms2_album\fR\*(T>\fR 
1206 Album in current XMMS2 song
1207
1208 .TP 
1209 \fB\*(T<\fBxmms2_title\fR\*(T>\fR 
1210 Title in current XMMS2 song
1211
1212 .TP 
1213 \fB\*(T<\fBxmms2_genre\fR\*(T>\fR 
1214 Genre in current XMMS2 song
1215
1216 .TP 
1217 \fB\*(T<\fBxmms2_comment\fR\*(T>\fR 
1218 Comment in current XMMS2 song
1219
1220 .TP 
1221 \fB\*(T<\fBxmms2_decoder\fR\*(T>\fR 
1222 Decoder plugin used
1223
1224 .TP 
1225 \fB\*(T<\fBxmms2_transport\fR\*(T>\fR 
1226 Transport plugin used
1227
1228 .TP 
1229 \fB\*(T<\fBxmms2_url\fR\*(T>\fR 
1230 Full path to current song
1231
1232 .TP 
1233 \fB\*(T<\fBxmms2_tracknr\fR\*(T>\fR 
1234 Track number in current XMMS2 song
1235
1236 .TP 
1237 \fB\*(T<\fBxmms2_bitrate\fR\*(T>\fR 
1238 Bitrate of current song
1239
1240 .TP 
1241 \fB\*(T<\fBxmms2_id\fR\*(T>\fR 
1242 XMMS2 id of current song
1243
1244 .TP 
1245 \fB\*(T<\fBxmms2_duration\fR\*(T>\fR 
1246 Duration of current song
1247
1248 .TP 
1249 \fB\*(T<\fBxmms2_elapsed\fR\*(T>\fR 
1250 Song's elapsed time
1251
1252 .TP 
1253 \fB\*(T<\fBxmms2_size\fR\*(T>\fR 
1254 Size of current song
1255
1256 .TP 
1257 \fB\*(T<\fBxmms2_percent\fR\*(T>\fR 
1258 Percent of song's progress
1259
1260 .TP 
1261 \fB\*(T<\fBxmms2_status\fR\*(T>\fR 
1262 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1263
1264 .TP 
1265 \fB\*(T<\fBxmms2_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1266 Bar of XMMS2's progress
1267
1268 .TP 
1269 \fB\*(T<\fBxmms2_smart\fR\*(T>\fR 
1270 Prints the song name in either the form "artist - title" or file name, depending on whats available
1271
1272 .SH EXAMPLES
1273 .TP 
1274 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%M}' \-o \-u 30\fR\*(T>
1275 Start Conky in its own window with date and clock as text and 30 sec update interval.
1276 .TP 
1277 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1278 Start Conky to background at coordinates (5, 500).
1279 .SH FILES
1280 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1281 .SH BUGS
1282 Drawing to root or some other desktop window directly doesn't work with 
1283 all window managers. Especially doesn't work well with Gnome and it has 
1284 been reported that it doesn't work with KDE either. Nautilus can be 
1285 disabled from drawing to desktop with program gconf-editor. Uncheck 
1286 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky 
1287 to set some specific window id. You might find xwininfo -tree useful to 
1288 find the window to draw to. You can also use -o argument which makes
1289 Conky to create its own window.
1290 .SH "SEE ALSO"
1291 \(lahttp://conky.sourceforge.net\(ra
1292 .PP
1293 \(lahttp://www.sourceforge.net/projects/conky\(ra
1294 .PP
1295 #conky on irc.freenode.net
1296 .SH AUTHORS
1297 The Conky dev team. What's up now!