conky 1.3.5
[monky] / doc / conky.1
1 .\" -*- coding: us-ascii -*-
2 .TH conky 1 2006-01-01  
3 .SH NAME
4 conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
5 .SH SYNOPSIS
6 .ad l
7 \fBconky\fR \kx
8 .if (\nxu > (\n(.lu / 2)) .nr x (\n(.lu / 5)
9 'in \n(.iu+\nxu
10 [\fBoptions\fR]
11 'in \n(.iu-\nxu
12 .ad b
13 .SH DESCRIPTION
14 Conky is a system monitor for X originally based on the torsmo code. 
15 Since it's original conception, Conky has changed a fair bit from it's predecessor. 
16 Conky can display just about anything, either on your root desktop or in it's own window. 
17 Conky has many built-in objects, as well as the ability to execute programs and scripts, 
18 then display the output from stdout.
19 .PP
20 We are always looking for help, and anyone interested in becoming a developer is welcome. 
21 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
22 .PP
23 Thanks for your interest in Conky.
24 .SH COMPILING
25 For users compiling from source, make sure you have the X development libraries installed. 
26 This should be a package along the lines of "libx11-dev or xorg-x11-dev". 
27 .PP
28 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
29 There is also usually an up-to-date ebuild within Conky's package or in CVS.
30 .PP
31 Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then 
32 Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install. 
33 .PP
34 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
35 .TP 
36 \fBsh autogen.sh\fR \fB# Only required if building from CVS\fR 
37 .TP 
38 \fB\&./configure \fR\fB\-\-prefix=/usr \-\-mandir=/usr/share/man \-\-infodir=/usr/share/info \-\-datadir=/usr/share \-\-sysconfdir=/etc \-\-localstatedir=/var/lib \-\-enable\-xft \-\-enable\-seti \-\-enable\-double\-buffer \-\-enable\-own\-window \-\-enable\-proc\-uptime \-\-enable\-mpd \-\-enable\-mldonkey \-\-enable\-x11 \-\-enable\-portmon\fR 
39 .TP 
40 \fBmake\fR 
41 .TP 
42 \fBmake install\fR \fB# Optional\fR 
43 .TP 
44 \fBsrc/conky\fR 
45 .PP
46 Conky probably doesn't compile with compilers other than gcc and icc. 
47 It doesn't compile with C89 compiler and not even with pure C99.
48 It uses a few things that might not exist: strdup(), strcasecmp(), strncasecmp(), 
49 optarg variable with getopt() and long long (not in C89). Crashes in file system
50 statistics stuff when compiled with icc, I don't know exactly why.
51 .PP
52 You can disable 'drawing to own window' feature in case you don't need it by passing 
53 --disable-own-window to configure -script.
54 .PP
55 .SH "YOU SHOULD KNOW"
56 Conky is generally very good on resources. However, certain objects in
57 Conky are harder on resources then others. In particular, the $tail,
58 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
59 .PP
60 If you do use them, please do not complain about memory or CPU usage, 
61 unless you think something's seriously wrong (mem leak, etc.).
62 .PP
63 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
64 Saves you the trouble of having to kill and then restart.
65 .PP
66 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff. 
67 mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
68 .SH OPTIONS
69 Command line options override configurations defined in configuration file.
70 .TP 
71 \fB\-v | \-V\fR
72 Prints version and exits
73
74 .TP 
75 \fB\-a \fR\fBALIGNMENT\fR
76 Text alignment on screen, {top,bottom}_{left,right} or none
77
78 .TP 
79 \fB\-b\fR
80 Use double buffering (eliminates "flicker")
81
82 .TP 
83 \fB\-c \fR\fBFILE\fR
84 Config file to load instead of $HOME/.conkyrc
85
86 .TP 
87 \fB\-d\fR
88 Daemonize Conky, aka fork to background
89
90 .TP 
91 \fB\-f \fR\fBFONT\fR
92 Font to use
93
94 .TP 
95 \fB\-h\fR
96 Prints command line help and exits
97
98 .TP 
99 \fB\-o\fR
100 Create own window to draw
101
102 .TP 
103 \fB\-t \fR\fBTEXT\fR
104 Text to render, remember single quotes, like -t ' $uptime '
105
106 .TP 
107 \fB\-u \fR\fBSECONDS\fR
108 Update interval
109
110 .TP 
111 \fB\-w \fR\fBWIN_ID\fR
112 Window id to draw
113
114 .TP 
115 \fB\-x \fR\fBX_COORDINATE\fR
116 X position
117
118 .TP 
119 \fB\-y \fR\fBY_COORDINATE\fR
120 Y position
121
122 .SH "CONFIGURATION SETTINGS"
123 Default configuration file is $HOME/.conkyrc (can be changed from
124 conky.c among other things). See conkyrc.sample. If installing from Debian package, 
125 this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
126 .PP
127 You might want to copy it to $HOME/.conkyrc and then start modifying it.
128 Other configs can be found at http://conky.sf.net
129 .TP 
130 \fBalignment\fR
131 Aligned position on screen, may be top_left, top_right, bottom_left, bottom_right, or none
132
133 .TP 
134 \fBbackground\fR
135 Boolean value, if true, Conky will be forked to background when started
136
137 .TP 
138 \fBon_bottom\fR
139 Set conky on the bottom of all other applications
140
141 .TP 
142 \fBborder_margin\fR
143 Border margin in pixels
144
145 .TP 
146 \fBborder_width\fR
147 Border width in pixels
148
149 .TP 
150 \fBcpu_avg_samples\fR
151 The number of samples to average for CPU monitoring
152
153 .TP 
154 \fBdefault_color\fR
155 Default color and border color
156
157 .TP 
158 \fBdefault_shade_color\fR
159 Default shading color and border's shading color
160
161 .TP 
162 \fBdefault_outline_color\fR
163 Default outline color
164
165 .TP 
166 \fBdouble_buffer\fR
167 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.
168
169 .TP 
170 \fBdraw_borders\fR
171 Draw borders around text?
172
173 .TP 
174 \fBdraw_shades\fR
175 Draw shades?
176
177 .TP 
178 \fBdraw_outline\fR
179 Draw outlines?
180
181 .TP 
182 \fBfont\fR
183 Font name in X, xfontsel can be used to get a nice font
184
185 .TP 
186 \fBgap_x\fR
187 Gap between right or left border of screen, same as passing -x at command line
188
189 .TP 
190 \fBgap_y\fR
191 Gap between top or bottom border of screen, same as passing -y at command line
192
193 .TP 
194 \fBno_buffers\fR
195 Substract (file system) buffers from used memory?
196
197 .TP 
198 \fBmail_spool\fR
199 Mail spool for mail checking
200
201 .TP 
202 \fBmaximum_width\fR \fBpixels\fR 
203 Maximum width of window
204
205 .TP 
206 \fBminimum_size\fR \fBwidth (height)\fR 
207 Minimum size of window
208
209 .TP 
210 \fBmldonkey_hostname\fR
211 Hostname for mldonkey stuff, defaults to localhost
212
213 .TP 
214 \fBmldonkey_port\fR
215 Mldonkey port, 4001 default
216
217 .TP 
218 \fBmldonkey_login\fR
219 Mldonkey login, default none
220
221 .TP 
222 \fBmldonkey_password\fR
223 Mldonkey password, default none
224
225 .TP 
226 \fBmpd_host\fR
227 Host of MPD server
228
229 .TP 
230 \fBmpd_port\fR
231 Port of MPD server
232
233 .TP 
234 \fBmpd_password\fR
235 MPD server password
236
237 .TP 
238 \fBnet_avg_samples\fR
239 The number of samples to average for net data
240
241 .TP 
242 \fBoverride_utf8_locale\fR
243 Force UTF8? requires XFT
244
245 .TP 
246 \fBown_window\fR
247 Boolean, create own window to draw?
248
249 .TP 
250 \fBown_window_transparent\fR
251 Boolean, set pseudo-transparency?
252
253 .TP 
254 \fBown_window_colour\fR \fBcolour\fR 
255 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)
256
257 .TP 
258 \fBout_to_console\fR 
259 Print text to stdout.
260
261 .TP 
262 \fBpad_percents\fR
263 Pad percentages to this many decimals (0 = no padding)
264
265 .TP 
266 \fBstippled_borders\fR
267 Border stippling (dashing) in pixels
268
269 .TP 
270 \fBtotal_run_times\fR
271 Total number of times for Conky to update before quitting. Zero makes Conky run forever
272
273 .TP 
274 \fBupdate_interval\fR
275 Update interval in seconds
276
277 .TP 
278 \fBuppercase\fR
279 Boolean value, if true, text is rendered in upper case
280
281 .TP 
282 \fBuse_spacer\fR
283 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.
284
285 .TP 
286 \fBuse_xft\fR
287 Use Xft (anti-aliased font and stuff)
288
289 .TP 
290 \fBmin_port_monitors\fR
291 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16) 
292
293 .TP 
294 \fBmin_port_monitor_connections\fR
295 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
296
297 .TP 
298 \fBTEXT\fR
299 After this begins text to be formatted on screen
300
301 .SH VARIABLES
302 Colors are parsed using XParsecolor(), there might be a list of them:
303 /usr/X11R6/lib/X11/rgb.txt. Also, 
304 http://sedition.com/perl/rgb.html [http://sedition.com/perl/rgb.html].
305 Color can be also in #rrggbb format (hex).
306 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
307 means 1024*1024 bytes and not 1000*1000.
308 .TP 
309 \fBaddr\fR \fBinterface\fR 
310 IP address for an interface
311
312 .TP 
313 \fBacpiacadapter\fR 
314 ACPI ac adapter state.
315
316 .TP 
317 \fBacpifan\fR 
318 ACPI fan state
319
320 .TP 
321 \fBacpitemp\fR 
322 ACPI temperature in C.
323
324 .TP 
325 \fBacpitempf\fR 
326 ACPI temperature in F.
327
328 .TP 
329 \fBadt746xcpu\fR 
330 CPU temperature from therm_adt746x
331
332 .TP 
333 \fBadt746xfan\fR 
334 Fan speed from therm_adt746x
335
336 .TP 
337 \fBalignr\fR \fB(num)\fR 
338 Right-justify text, with space of N
339
340 .TP 
341 \fBalignc\fR \fB(num)\fR 
342 Align text to centre
343
344 .TP 
345 \fBapm_adapter\fR 
346 Display APM AC adapter status (FreeBSD only)
347
348 .TP 
349 \fBapm_battery_life\fR 
350 Display APM battery life in percent (FreeBSD only)
351
352 .TP 
353 \fBapm_battery_time\fR 
354 Display remaining APM battery life in hh:mm:ss or "unknown" if
355 AC adapterstatus is on-line or charging (FreeBSD only)
356
357 .TP 
358 \fBbattery\fR \fB(num)\fR 
359 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
360
361 .TP 
362 \fBbmpx_artist\fR 
363 Artist in current BMPx track
364
365 .TP 
366 \fBbmpx_album\fR 
367 Album in current BMPx track
368
369 .TP 
370 \fBbmpx_title\fR 
371 Title of the current BMPx track
372
373 .TP 
374 \fBbmpx_track\fR 
375 Track number of the current BMPx track
376
377 .TP 
378 \fBbmpx_bitrate\fR 
379 Bitrate of the current BMPx track
380
381 .TP 
382 \fBbmpx_uri\fR 
383 URI of the current BMPx track
384
385 .TP 
386 \fBbuffers\fR 
387 Amount of memory buffered
388
389 .TP 
390 \fBcached\fR 
391 Amount of memory cached
392
393 .TP 
394 \fBcolor\fR \fB(color)\fR 
395 Change drawing color to color
396
397 .TP 
398 \fBcpu\fR \fB(cpuN)\fR 
399 CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. cpu0 is the total usage, and >=cpu1 are individual CPUs. 
400
401 .TP 
402 \fBcpubar\fR \fB(cpu number) (height),(width)\fR 
403 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
404
405 .TP 
406 \fBcpugraph\fR \fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR 
407 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
408
409 .TP 
410 \fBdiskio\fR 
411 Displays current disk IO.
412
413 .TP 
414 \fBdiskiograph\fR \fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
415 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
416
417 .TP 
418 \fBdownspeed\fR \fBnet\fR 
419 Download speed in kilobytes
420
421 .TP 
422 \fBdownspeedf\fR \fBnet\fR 
423 Download speed in kilobytes with one decimal
424
425 .TP 
426 \fBdownspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
427 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
428
429 .TP 
430 \fBelse\fR 
431 Text to show if any of the above are not true
432
433 .TP 
434 \fBexec\fR \fBcommand\fR 
435 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.
436
437 .TP 
438 \fBexecbar\fR \fBcommand\fR 
439 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.
440
441 .TP 
442 \fBexecgraph\fR \fBcommand\fR 
443 Same as execbar, but graphs values.
444
445 .TP 
446 \fBexeci\fR \fBinterval command\fR 
447 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
448
449 .TP 
450 \fBexecibar\fR \fBinterval command\fR 
451 Same as execbar, except with an interval
452
453 .TP 
454 \fBexecigraph\fR \fBinterval command\fR 
455 Same as execigraph, but takes an interval arg graphs values
456
457 .TP 
458 \fBfont\fR \fBfont\fR 
459 Specify a different font. Only applies to one line.
460
461 .TP 
462 \fBfreq\fR 
463 Returns CPU frequency in MHz
464
465 .TP 
466 \fBfreq_g\fR 
467 Returns CPU frequency in GHz
468
469 .TP 
470 \fBfreq_dyn\fR 
471 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
472
473 .TP 
474 \fBfreq_dyn_g\fR 
475 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
476
477 .TP 
478 \fBfs_bar\fR \fB(height),(width) fs\fR 
479 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.
480
481 .TP 
482 \fBfs_free\fR \fB(fs)\fR 
483 Free space on a file system available for users.
484
485 .TP 
486 \fBfs_free_perc\fR \fB(fs)\fR 
487 Free percentage of space on a file system available for users.
488
489 .TP 
490 \fBfs_size\fR \fB(fs)\fR 
491 File system size
492
493 .TP 
494 \fBfs_used\fR \fB(fs)\fR 
495 File system used space
496
497 .TP 
498 \fBhead\fR \fBlogfile lines (interval)\fR 
499 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.
500
501 .TP 
502 \fBhr\fR \fB(height)\fR 
503 Horizontal line, height is the height in pixels
504
505 .TP 
506 \fBi2c\fR \fB(dev), type, n\fR 
507 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
508
509 .TP 
510 \fBi8k_ac_status\fR \fB\fR
511 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.
512
513 .TP 
514 \fBi8k_bios\fR \fB\fR
515 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
516
517 .TP 
518 \fBi8k_buttons_status\fR \fB\fR
519 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
520
521 .TP 
522 \fBi8k_cpu_temp\fR \fB\fR
523 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in celsius, as reported by /proc/i8k.
524
525 .TP 
526 \fBi8k_cpu_tempf\fR \fB\fR
527 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in farenheit, as reported by /proc/i8k.
528
529 .TP 
530 \fBi8k_left_fan_rpm\fR \fB\fR
531 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.
532
533 .TP 
534 \fBi8k_left_fan_status\fR \fB\fR
535 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.
536
537 .TP 
538 \fBi8k_right_fan_rpm\fR \fB\fR
539 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.
540
541 .TP 
542 \fBi8k_right_fan_status\fR \fB\fR
543 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.
544
545 .TP 
546 \fBi8k_serial\fR \fB\fR
547 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
548
549 .TP 
550 \fBi8k_version\fR \fB\fR
551 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
552
553 .TP 
554 \fBif_running\fR \fB(process)\fR 
555 if PROCESS is running, display everything if_running and the matching $endif
556
557 .TP 
558 \fBif_existing\fR \fB(file)\fR 
559 if FILE exists, display everything between if_existing and the matching $endif
560
561 .TP 
562 \fBif_mounted\fR \fB(mountpoint)\fR 
563 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
564
565 .TP 
566 \fBkernel\fR 
567 Kernel version
568
569 .TP 
570 \fBlinkstatus\fR \fBinterface\fR 
571 Get the link status for wireless connections
572
573 .TP 
574 \fBloadavg\fR 
575 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
576
577 .TP 
578 \fBmachine\fR 
579 Machine, i686 for example
580
581 .TP 
582 \fBmails\fR 
583 Mail count in mail spool. You can use program like fetchmail to get mails from some server using your favourite protocol. See also new_mails.
584
585 .TP 
586 \fBmem\fR 
587 Amount of memory in use
588
589 .TP 
590 \fBmembar\fR \fB(height),(width)\fR 
591 Bar that shows amount of memory in use
592
593 .TP 
594 \fBmemmax\fR 
595 Total amount of memory
596
597 .TP 
598 \fBmemperc\fR 
599 Percentage of memory in use
600
601 .TP 
602 \fBmpd_artist\fR 
603 Artist in current MPD song must be enabled at compile
604
605 .TP 
606 \fBmpd_album\fR 
607 Album in current MPD song
608
609 .TP 
610 \fBmpd_bar\fR \fB(height),(width)\fR 
611 Bar of mpd's progress
612
613 .TP 
614 \fBmpd_bitrate\fR 
615 Bitrate of current song
616
617 .TP 
618 \fBmpd_status\fR 
619 Playing, stopped, et cetera.
620
621 .TP 
622 \fBmpd_title\fR 
623 Title of current MPD song
624
625 .TP 
626 \fBmpd_vol\fR 
627 MPD's volume
628
629 .TP 
630 \fBmpd_elapsed\fR 
631 Song's elapsed time
632
633 .TP 
634 \fBmpd_length\fR 
635 Song's length
636
637 .TP 
638 \fBmpd_percent\fR 
639 Percent of song's progress
640
641 .TP 
642 \fBmpd_random\fR 
643 Random status (On/Off)
644
645 .TP 
646 \fBmpd_repeat\fR 
647 Repeat status (On/Off)
648
649 .TP 
650 \fBmpd_track\fR 
651 Prints the MPD track field
652
653 .TP 
654 \fBnew_mails\fR 
655 Unread mail count in mail spool.
656
657 .TP 
658 \fBnodename\fR 
659 Hostname
660
661 .TP 
662 \fBoutlinecolor\fR \fB(color)\fR 
663 Change outline color
664
665 .TP 
666 \fBpre_exec\fR \fBshell command\fR 
667 Executes a shell command one time before conky displays anything and puts output as text.
668
669 .TP 
670 \fBprocesses\fR 
671 Total processes (sleeping and running)
672
673 .TP 
674 \fBrunning_processes\fR 
675 Running processes (not sleeping), requires Linux 2.6
676
677 .TP 
678 \fBshadecolor\fR \fB(color)\fR 
679 Change shading color
680
681 .TP 
682 \fBstippled_hr\fR \fB(space)\fR 
683 Stippled (dashed) horizontal line
684
685 .TP 
686 \fBswapbar\fR \fB(height),(width)\fR 
687 Bar that shows amount of swap in use
688
689 .TP 
690 \fBswap\fR 
691 Amount of swap in use
692
693 .TP 
694 \fBswapmax\fR 
695 Total amount of swap
696
697 .TP 
698 \fBswapperc\fR 
699 Percentage of swap in use
700
701 .TP 
702 \fBsysname\fR 
703 System name, Linux for example
704
705 .TP 
706 \fBtcp_portmon\fR \fBport_begin port_end item (index)\fR \fI(ip4 only at present)\fR 
707 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
708
709 count - total number of connections in the range
710
711 rip - remote ip address
712
713 rhost - remote host name 
714
715 rport - remote port number
716
717 lip - local ip address
718
719 lhost - local host name
720
721 lservice - local service name from /etc/services
722
723 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.
724
725 Examples:
726
727 ${tcp_portmon 6881 6999 count} -
728 displays the number of connections in the bittorrent port range
729
730 ${tcp_portmon 22 22 rip 0} -
731 displays the remote host ip of the first sshd connection
732
733 ${tcp_portmon 22 22 rip 9} -
734 displays the remote host ip of the tenth sshd connection
735
736 ${tcp_portmon 1 1024 rhost 0} -
737 displays the remote host name of the first connection on a privileged port
738
739 ${tcp_portmon 1 1024 rport 4} -
740 displays the remote host port of the fifth connection on a privileged port
741
742 ${tcp_portmon 1 65535 lservice 14} -
743 displays the local service name of the fifteenth connection in the range of all ports
744
745 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. 
746 .TP 
747 \fBtexeci\fR \fBinterval command\fR 
748 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.
749
750 .TP 
751 \fBoffset\fR \fB(pixels)\fR 
752 Move text over by N pixels. See also $voffset.
753
754 .TP 
755 \fBtail\fR \fBlogfile lines (interval)\fR 
756 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.
757
758 .TP 
759 \fBtime\fR \fB(format)\fR 
760 Local time, see man strftime to get more information about format
761
762 .TP 
763 \fBtotaldown\fR \fBnet\fR 
764 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.
765
766 .TP 
767 \fBtop\fR \fBtype, num\fR 
768 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", and mem". There can be a max of 10 processes listed.
769
770 .TP 
771 \fBtop_mem\fR \fBtype, num\fR 
772 Same as top, except sorted by mem usage instead of cpu
773
774 .TP 
775 \fBtotalup\fR \fBnet\fR 
776 Total upload, this one too, may overflow
777
778 .TP 
779 \fBupdates\fR \fBNumber of updates\fR 
780 for debugging
781
782 .TP 
783 \fBupspeed\fR \fBnet\fR 
784 Upload speed in kilobytes
785
786 .TP 
787 \fBupspeedf\fR \fBnet\fR 
788 Upload speed in kilobytes with one decimal
789
790 .TP 
791 \fBupspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
792 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
793
794 .TP 
795 \fBuptime\fR 
796 Uptime
797
798 .TP 
799 \fBuptime_short\fR 
800 Uptime in a shorter format
801
802 .TP 
803 \fBseti_prog\fR 
804 Seti@home current progress
805
806 .TP 
807 \fBseti_progbar\fR \fB(height),(width)\fR 
808 Seti@home current progress bar
809
810 .TP 
811 \fBseti_credit\fR 
812 Seti@home total user credit
813
814 .TP 
815 \fBvoffset\fR \fB(pixels)\fR 
816 Change verticle offset by N pixels. Negative values will cause text to overlap. See also $offset.
817
818 .SH EXAMPLES
819 .TP 
820 conky \fB\-t '${time %D %H:%m}' \-o \-u 30\fR
821 Start Conky in its own window with date and clock as text and 30 sec update interval.
822 .TP 
823 conky \fB\-a top_left \-x 5 \-y 500 \-d\fR
824 Start Conky to background at coordinates (5, 500).
825 .SH FILES
826 \fB~/.conkyrc\fR default configuration file
827 .SH BUGS
828 Drawing to root or some other desktop window directly doesn't work with 
829 all window managers. Especially doesn't work well with Gnome and it has 
830 been reported that it doesn't work with KDE either. Nautilus can be 
831 disabled from drawing to desktop with program gconf-editor. Uncheck 
832 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky 
833 to set some specific window id. You might find xwininfo -tree useful to 
834 find the window to draw to. You can also use -o argument which makes
835 Conky to create its own window.
836 .SH "SEE ALSO"
837 http://conky.sourceforge.net [http://conky.sourceforge.net]
838 .PP
839 http://www.sourceforge.net/projects/conky [http://www.sourceforge.net/projects/conky]
840 .PP
841 #conky on irc.freenode.net
842 .SH AUTHORS
843 The Conky dev team. What's up now!