docs
[monky] / doc / conky.1
1 .\" -*- coding: us-ascii -*-
2 .TH conky 1 2006-02-12  
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 \-\-enable\-xmms \-\-enable\-bmp \-\-enable\-audacious \-\-enable\-infopipe \-\-enable\-bmpx \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_graph_borders\fR
175 Draw borders around graphs?
176
177 .TP 
178 \fBdraw_shades\fR
179 Draw shades?
180
181 .TP 
182 \fBdraw_outline\fR
183 Draw outlines?
184
185 .TP 
186 \fBfont\fR
187 Font name in X, xfontsel can be used to get a nice font
188
189 .TP 
190 \fBgap_x\fR
191 Gap between right or left border of screen, same as passing -x at command line
192
193 .TP 
194 \fBgap_y\fR
195 Gap between top or bottom border of screen, same as passing -y at command line
196
197 .TP 
198 \fBno_buffers\fR
199 Substract (file system) buffers from used memory?
200
201 .TP 
202 \fBmail_spool\fR
203 Mail spool for mail checking
204
205 .TP 
206 \fBmaximum_width\fR \fBpixels\fR 
207 Maximum width of window
208
209 .TP 
210 \fBminimum_size\fR \fBwidth (height)\fR 
211 Minimum size of window
212
213 .TP 
214 \fBmin_port_monitors\fR
215 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16) 
216
217 .TP 
218 \fBmin_port_monitor_connections\fR
219 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
220
221 .TP 
222 \fBmldonkey_hostname\fR
223 Hostname for mldonkey stuff, defaults to localhost
224
225 .TP 
226 \fBmldonkey_port\fR
227 Mldonkey port, 4001 default
228
229 .TP 
230 \fBmldonkey_login\fR
231 Mldonkey login, default none
232
233 .TP 
234 \fBmldonkey_password\fR
235 Mldonkey password, default none
236
237 .TP 
238 \fBmpd_host\fR
239 Host of MPD server
240
241 .TP 
242 \fBmpd_port\fR
243 Port of MPD server
244
245 .TP 
246 \fBmpd_password\fR
247 MPD server password
248
249 .TP 
250 \fBnet_avg_samples\fR
251 The number of samples to average for net data
252
253 .TP 
254 \fBoverride_utf8_locale\fR
255 Force UTF8? requires XFT
256
257 .TP 
258 \fBown_window\fR
259 Boolean, create own window to draw?
260
261 .TP 
262 \fBown_window_transparent\fR
263 Boolean, set pseudo-transparency?
264
265 .TP 
266 \fBown_window_type\fR
267 if own_window is yes, you may specify type normal, desktop or override (default: normal).
268 Desktop windows are special windows that have no window decorations; are always visible 
269 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
270 Override windows are not under the control of the window manager. Hints are ignored. This type
271 of window can be useful for certain situations.
272
273 .TP 
274 \fBown_window_colour\fR \fBcolour\fR 
275 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)
276
277 .TP 
278 \fBown_window_hints\fR \fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR 
279 If own_window is yes, you may use these window manager hints to affect the way conky displays. 
280 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
281 If you use own_window_type override, window manager hints have no meaning and are ignored.
282
283 .TP 
284 \fBout_to_console\fR 
285 Print text to stdout.
286
287 .TP 
288 \fBpad_percents\fR
289 Pad percentages to this many decimals (0 = no padding)
290
291 .TP 
292 \fBstippled_borders\fR
293 Border stippling (dashing) in pixels
294
295 .TP 
296 \fBtotal_run_times\fR
297 Total number of times for Conky to update before quitting. Zero makes Conky run forever
298
299 .TP 
300 \fBupdate_interval\fR
301 Update interval in seconds
302
303 .TP 
304 \fBuppercase\fR
305 Boolean value, if true, text is rendered in upper case
306
307 .TP 
308 \fBuse_spacer\fR
309 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.
310
311 .TP 
312 \fBuse_xft\fR
313 Use Xft (anti-aliased font and stuff)
314
315 .TP 
316 \fBwm_class_name\fR
317 Manually set the WM_CLASS name. Defaults to "conky".
318
319 .TP 
320 \fBxmms_player\fR
321 Use specified player/plugin for the xmms status variables. Valid items are: none, xmms, bmp, audacious and infopipe. (default is none). Note that bmpx is currently handled separately.
322
323 .TP 
324 \fBTEXT\fR
325 After this begins text to be formatted on screen
326
327 .SH VARIABLES
328 Colors are parsed using XParsecolor(), there might be a list of them:
329 /usr/X11R6/lib/X11/rgb.txt. Also, 
330 http://sedition.com/perl/rgb.html [http://sedition.com/perl/rgb.html].
331 Color can be also in #rrggbb format (hex).
332 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
333 means 1024*1024 bytes and not 1000*1000.
334 .TP 
335 \fBaddr\fR \fBinterface\fR 
336 IP address for an interface
337
338 .TP 
339 \fBacpiacadapter\fR 
340 ACPI ac adapter state.
341
342 .TP 
343 \fBacpifan\fR 
344 ACPI fan state
345
346 .TP 
347 \fBacpitemp\fR 
348 ACPI temperature in C.
349
350 .TP 
351 \fBacpitempf\fR 
352 ACPI temperature in F.
353
354 .TP 
355 \fBadt746xcpu\fR 
356 CPU temperature from therm_adt746x
357
358 .TP 
359 \fBadt746xfan\fR 
360 Fan speed from therm_adt746x
361
362 .TP 
363 \fBalignr\fR \fB(num)\fR 
364 Right-justify text, with space of N
365
366 .TP 
367 \fBalignc\fR \fB(num)\fR 
368 Align text to centre
369
370 .TP 
371 \fBapm_adapter\fR 
372 Display APM AC adapter status (FreeBSD only)
373
374 .TP 
375 \fBapm_battery_life\fR 
376 Display APM battery life in percent (FreeBSD only)
377
378 .TP 
379 \fBapm_battery_time\fR 
380 Display remaining APM battery life in hh:mm:ss or "unknown" if
381 AC adapterstatus is on-line or charging (FreeBSD only)
382
383 .TP 
384 \fBbattery\fR \fB(num)\fR 
385 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
386
387 .TP 
388 \fBbmpx_artist\fR 
389 Artist in current BMPx track
390
391 .TP 
392 \fBbmpx_album\fR 
393 Album in current BMPx track
394
395 .TP 
396 \fBbmpx_title\fR 
397 Title of the current BMPx track
398
399 .TP 
400 \fBbmpx_track\fR 
401 Track number of the current BMPx track
402
403 .TP 
404 \fBbmpx_bitrate\fR 
405 Bitrate of the current BMPx track
406
407 .TP 
408 \fBbmpx_uri\fR 
409 URI of the current BMPx track
410
411 .TP 
412 \fBbuffers\fR 
413 Amount of memory buffered
414
415 .TP 
416 \fBcached\fR 
417 Amount of memory cached
418
419 .TP 
420 \fBcolor\fR \fB(color)\fR 
421 Change drawing color to color
422
423 .TP 
424 \fBcpu\fR \fB(cpuN)\fR 
425 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. 
426
427 .TP 
428 \fBcpubar\fR \fB(cpu number) (height),(width)\fR 
429 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
430
431 .TP 
432 \fBcpugraph\fR \fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR 
433 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
434
435 .TP 
436 \fBdiskio\fR 
437 Displays current disk IO.
438
439 .TP 
440 \fBdiskiograph\fR \fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
441 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
442
443 .TP 
444 \fBdownspeed\fR \fBnet\fR 
445 Download speed in kilobytes
446
447 .TP 
448 \fBdownspeedf\fR \fBnet\fR 
449 Download speed in kilobytes with one decimal
450
451 .TP 
452 \fBdownspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
453 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
454
455 .TP 
456 \fBelse\fR 
457 Text to show if any of the above are not true
458
459 .TP 
460 \fBexec\fR \fBcommand\fR 
461 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.
462
463 .TP 
464 \fBexecbar\fR \fBcommand\fR 
465 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.
466
467 .TP 
468 \fBexecgraph\fR \fBcommand\fR 
469 Same as execbar, but graphs values.
470
471 .TP 
472 \fBexeci\fR \fBinterval command\fR 
473 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
474
475 .TP 
476 \fBexecibar\fR \fBinterval command\fR 
477 Same as execbar, except with an interval
478
479 .TP 
480 \fBexecigraph\fR \fBinterval command\fR 
481 Same as execigraph, but takes an interval arg graphs values
482
483 .TP 
484 \fBfont\fR \fBfont\fR 
485 Specify a different font. Only applies to one line.
486
487 .TP 
488 \fBfreq\fR 
489 Returns CPU frequency in MHz
490
491 .TP 
492 \fBfreq_g\fR 
493 Returns CPU frequency in GHz
494
495 .TP 
496 \fBfreq_dyn\fR 
497 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
498
499 .TP 
500 \fBfreq_dyn_g\fR 
501 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
502
503 .TP 
504 \fBfs_bar\fR \fB(height),(width) fs\fR 
505 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.
506
507 .TP 
508 \fBfs_free\fR \fB(fs)\fR 
509 Free space on a file system available for users.
510
511 .TP 
512 \fBfs_free_perc\fR \fB(fs)\fR 
513 Free percentage of space on a file system available for users.
514
515 .TP 
516 \fBfs_size\fR \fB(fs)\fR 
517 File system size
518
519 .TP 
520 \fBfs_used\fR \fB(fs)\fR 
521 File system used space
522
523 .TP 
524 \fBhead\fR \fBlogfile lines (interval)\fR 
525 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.
526
527 .TP 
528 \fBhr\fR \fB(height)\fR 
529 Horizontal line, height is the height in pixels
530
531 .TP 
532 \fBi2c\fR \fB(dev) type n\fR 
533 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.
534
535 .TP 
536 \fBi8k_ac_status\fR \fB\fR
537 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.
538
539 .TP 
540 \fBi8k_bios\fR \fB\fR
541 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
542
543 .TP 
544 \fBi8k_buttons_status\fR \fB\fR
545 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
546
547 .TP 
548 \fBi8k_cpu_temp\fR \fB\fR
549 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
550
551 .TP 
552 \fBi8k_cpu_tempf\fR \fB\fR
553 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
554
555 .TP 
556 \fBi8k_left_fan_rpm\fR \fB\fR
557 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.
558
559 .TP 
560 \fBi8k_left_fan_status\fR \fB\fR
561 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.
562
563 .TP 
564 \fBi8k_right_fan_rpm\fR \fB\fR
565 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.
566
567 .TP 
568 \fBi8k_right_fan_status\fR \fB\fR
569 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.
570
571 .TP 
572 \fBi8k_serial\fR \fB\fR
573 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
574
575 .TP 
576 \fBi8k_version\fR \fB\fR
577 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
578
579 .TP 
580 \fBif_running\fR \fB(process)\fR 
581 if PROCESS is running, display everything if_running and the matching $endif
582
583 .TP 
584 \fBif_existing\fR \fB(file)\fR 
585 if FILE exists, display everything between if_existing and the matching $endif
586
587 .TP 
588 \fBif_mounted\fR \fB(mountpoint)\fR 
589 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
590
591 .TP 
592 \fBkernel\fR 
593 Kernel version
594
595 .TP 
596 \fBlinkstatus\fR \fBinterface\fR 
597 Get the link status for wireless connections
598
599 .TP 
600 \fBloadavg\fR 
601 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
602
603 .TP 
604 \fBmachine\fR 
605 Machine, i686 for example
606
607 .TP 
608 \fBmails\fR 
609 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.
610
611 .TP 
612 \fBmem\fR 
613 Amount of memory in use
614
615 .TP 
616 \fBmembar\fR \fB(height),(width)\fR 
617 Bar that shows amount of memory in use
618
619 .TP 
620 \fBmemmax\fR 
621 Total amount of memory
622
623 .TP 
624 \fBmemperc\fR 
625 Percentage of memory in use
626
627 .TP 
628 \fBmpd_artist\fR 
629 Artist in current MPD song must be enabled at compile
630
631 .TP 
632 \fBmpd_album\fR 
633 Album in current MPD song
634
635 .TP 
636 \fBmpd_bar\fR \fB(height),(width)\fR 
637 Bar of mpd's progress
638
639 .TP 
640 \fBmpd_bitrate\fR 
641 Bitrate of current song
642
643 .TP 
644 \fBmpd_status\fR 
645 Playing, stopped, et cetera.
646
647 .TP 
648 \fBmpd_title\fR 
649 Title of current MPD song
650
651 .TP 
652 \fBmpd_vol\fR 
653 MPD's volume
654
655 .TP 
656 \fBmpd_elapsed\fR 
657 Song's elapsed time
658
659 .TP 
660 \fBmpd_length\fR 
661 Song's length
662
663 .TP 
664 \fBmpd_percent\fR 
665 Percent of song's progress
666
667 .TP 
668 \fBmpd_random\fR 
669 Random status (On/Off)
670
671 .TP 
672 \fBmpd_repeat\fR 
673 Repeat status (On/Off)
674
675 .TP 
676 \fBmpd_track\fR 
677 Prints the MPD track field
678
679 .TP 
680 \fBmpd_name\fR 
681 Prints the MPD name field
682
683 .TP 
684 \fBmpd_file\fR 
685 Prints the file name of the current MPD song
686
687 .TP 
688 \fBmpd_smart\fR 
689 Prints the song name in either the form "artist - title" or file name, depending on whats available
690
691 .TP 
692 \fBnew_mails\fR 
693 Unread mail count in mail spool.
694
695 .TP 
696 \fBnodename\fR 
697 Hostname
698
699 .TP 
700 \fBoutlinecolor\fR \fB(color)\fR 
701 Change outline color
702
703 .TP 
704 \fBpre_exec\fR \fBshell command\fR 
705 Executes a shell command one time before conky displays anything and puts output as text.
706
707 .TP 
708 \fBprocesses\fR 
709 Total processes (sleeping and running)
710
711 .TP 
712 \fBrunning_processes\fR 
713 Running processes (not sleeping), requires Linux 2.6
714
715 .TP 
716 \fBshadecolor\fR \fB(color)\fR 
717 Change shading color
718
719 .TP 
720 \fBstippled_hr\fR \fB(space)\fR 
721 Stippled (dashed) horizontal line
722
723 .TP 
724 \fBswapbar\fR \fB(height),(width)\fR 
725 Bar that shows amount of swap in use
726
727 .TP 
728 \fBswap\fR 
729 Amount of swap in use
730
731 .TP 
732 \fBswapmax\fR 
733 Total amount of swap
734
735 .TP 
736 \fBswapperc\fR 
737 Percentage of swap in use
738
739 .TP 
740 \fBsysname\fR 
741 System name, Linux for example
742
743 .TP 
744 \fBtcp_portmon\fR \fBport_begin port_end item (index)\fR \fI(ip4 only at present)\fR 
745 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
746
747 count - total number of connections in the range
748
749 rip - remote ip address
750
751 rhost - remote host name 
752
753 rport - remote port number
754
755 lip - local ip address
756
757 lhost - local host name
758
759 lservice - local service name from /etc/services
760
761 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.
762
763 Examples:
764
765 ${tcp_portmon 6881 6999 count} -
766 displays the number of connections in the bittorrent port range
767
768 ${tcp_portmon 22 22 rip 0} -
769 displays the remote host ip of the first sshd connection
770
771 ${tcp_portmon 22 22 rip 9} -
772 displays the remote host ip of the tenth sshd connection
773
774 ${tcp_portmon 1 1024 rhost 0} -
775 displays the remote host name of the first connection on a privileged port
776
777 ${tcp_portmon 1 1024 rport 4} -
778 displays the remote host port of the fifth connection on a privileged port
779
780 ${tcp_portmon 1 65535 lservice 14} -
781 displays the local service name of the fifteenth connection in the range of all ports
782
783 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. 
784 .TP 
785 \fBtexeci\fR \fBinterval command\fR 
786 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.
787
788 .TP 
789 \fBoffset\fR \fB(pixels)\fR 
790 Move text over by N pixels. See also $voffset.
791
792 .TP 
793 \fBtail\fR \fBlogfile lines (interval)\fR 
794 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.
795
796 .TP 
797 \fBtime\fR \fB(format)\fR 
798 Local time, see man strftime to get more information about format
799
800 .TP 
801 \fBtotaldown\fR \fBnet\fR 
802 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.
803
804 .TP 
805 \fBtop\fR \fBtype, num\fR 
806 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.
807
808 .TP 
809 \fBtop_mem\fR \fBtype, num\fR 
810 Same as top, except sorted by mem usage instead of cpu
811
812 .TP 
813 \fBtotalup\fR \fBnet\fR 
814 Total upload, this one too, may overflow
815
816 .TP 
817 \fBupdates\fR \fBNumber of updates\fR 
818 for debugging
819
820 .TP 
821 \fBupspeed\fR \fBnet\fR 
822 Upload speed in kilobytes
823
824 .TP 
825 \fBupspeedf\fR \fBnet\fR 
826 Upload speed in kilobytes with one decimal
827
828 .TP 
829 \fBupspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR 
830 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
831
832 .TP 
833 \fBuptime\fR 
834 Uptime
835
836 .TP 
837 \fBuptime_short\fR 
838 Uptime in a shorter format
839
840 .TP 
841 \fBseti_prog\fR 
842 Seti@home current progress
843
844 .TP 
845 \fBseti_progbar\fR \fB(height),(width)\fR 
846 Seti@home current progress bar
847
848 .TP 
849 \fBseti_credit\fR 
850 Seti@home total user credit
851
852 .TP 
853 \fBvoffset\fR \fB(pixels)\fR 
854 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
855
856 .TP 
857 \fBxmms_bar\fR \fB(height),(width)\fR 
858 xmms / bmp / audacious / infopipe: progress bar
859
860 .TP 
861 \fBxmms_bitrate\fR 
862 xmms / bmp / audacious / infopipe: bitrate of current tune
863
864 .TP 
865 \fBxmms_channels\fR 
866 xmms / bmp / audacious / infopipe: number of audio channels of current tune
867
868 .TP 
869 \fBxmms_filename\fR 
870 xmms / bmp / audacious / infopipe: full path and filename of current tune
871
872 .TP 
873 \fBxmms_frequency\fR 
874 xmms / bmp / audacious / infopipe: sampling frequency of current tune
875
876 .TP 
877 \fBxmms_length\fR 
878 xmms / bmp / audacious / infopipe: total length of current tune as MM:SS
879
880 .TP 
881 \fBxmms_length_seconds\fR 
882 xmms / bmp / audacious / infopipe: total length of current tune in seconds
883
884 .TP 
885 \fBxmms_playlist_position\fR 
886 xmms / bmp / audacious / infopipe: playlist position of current tune
887
888 .TP 
889 \fBxmms_playlist_length\fR 
890 xmms / bmp / audacious / infopipe: number of tunes in playlist
891
892 .TP 
893 \fBxmms_position\fR 
894 xmms / bmp / audacious / infopipe: MM:SS position of current tune
895
896 .TP 
897 \fBxmms_position_seconds\fR 
898 xmms / bmp / audacious / infopipe: position of current tune in seconds
899
900 .TP 
901 \fBxmms_status\fR 
902 xmms / bmp / audacious / infopipe: player status (Playing/Paused/Stopped/Not running)
903
904 .TP 
905 \fBxmms_title\fR 
906 xmms / bmp / audacious / infopipe: title of current tune
907
908 .SH EXAMPLES
909 .TP 
910 conky \fB\-t '${time %D %H:%m}' \-o \-u 30\fR
911 Start Conky in its own window with date and clock as text and 30 sec update interval.
912 .TP 
913 conky \fB\-a top_left \-x 5 \-y 500 \-d\fR
914 Start Conky to background at coordinates (5, 500).
915 .SH FILES
916 \fB~/.conkyrc\fR default configuration file
917 .SH BUGS
918 Drawing to root or some other desktop window directly doesn't work with 
919 all window managers. Especially doesn't work well with Gnome and it has 
920 been reported that it doesn't work with KDE either. Nautilus can be 
921 disabled from drawing to desktop with program gconf-editor. Uncheck 
922 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky 
923 to set some specific window id. You might find xwininfo -tree useful to 
924 find the window to draw to. You can also use -o argument which makes
925 Conky to create its own window.
926 .SH "SEE ALSO"
927 http://conky.sourceforge.net [http://conky.sourceforge.net]
928 .PP
929 http://www.sourceforge.net/projects/conky [http://www.sourceforge.net/projects/conky]
930 .PP
931 #conky on irc.freenode.net
932 .SH AUTHORS
933 The Conky dev team. What's up now!