smp support for freq stuff
[monky] / README
1 conky(1)                                                              conky(1)
2
3
4
5 NAME
6        conky - A system monitor for X originally based on the torsmo code, but
7        more kickass. It just keeps on given'er. Yeah.
8
9 SYNOPSIS
10        conky [options]
11
12 DESCRIPTION
13        Conky is a system monitor for X originally based on  the  torsmo  code.
14        Since  it's original conception, Conky has changed a fair bit from it's
15        predecessor.  Conky can display just about  anything,  either  on  your
16        root  desktop  or in it's own window.  Conky has many built-in objects,
17        as well as the ability to execute programs and  scripts,  then  display
18        the output from stdout.
19
20        We  are  always  looking  for help, and anyone interested in becoming a
21        developer is welcome.  Please use the facilities at SourceForge to make
22        bug reports, feature requests, and submit patches.
23
24        Thanks for your interest in Conky.
25
26 COMPILING
27        For  users  compiling from source, make sure you have the X development
28        libraries installed.  This should be  a  package  along  the  lines  of
29        "libx11-dev or xorg-x11-dev".
30
31        Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
32        admin/conky" for installation.  There is  also  usually  an  up-to-date
33        ebuild within Conky's package or in Svn.
34
35        Debian,etc.  users  --  Conky will be in Debian's repositories soon (by
36        mid-September, hopefully), and then Ubuntu  shortly  thereafter.  Until
37        then, "dpkg -i" the .deb package to install.
38
39        Example  to  compile  and  run Conky with all optional components (note
40        that some configure options may differ for your system):
41
42        sh autogen.sh # Only required if building from Svn
43
44        ./configure            --prefix=/usr            --mandir=/usr/share/man
45        --infodir=/usr/share/info     --datadir=/usr/share    --sysconfdir=/etc
46        --localstatedir=/var/lib   --enable-xft   --enable-seti   --enable-dou-
47        ble-buffer    --enable-own-window   --enable-proc-uptime   --enable-mpd
48        --enable-mldonkey    --enable-x11    --enable-portmon     --enable-xmms
49        --enable-bmp --enable-audacious --enable-infopipe --enable-bmpx
50
51        make
52
53        make install # Optional
54
55        src/conky
56
57        Conky probably doesn't compile with compilers other than gcc  and  icc.
58        It  doesn't  compile  with C89 compiler and not even with pure C99.  It
59        uses a few things that might not exist: strdup(),  strcasecmp(),  strn-
60        casecmp(),  optarg  variable  with getopt() and long long (not in C89).
61        Crashes in file system statistics stuff when compiled with icc, I don't
62        know exactly why.
63
64        You  can disable 'drawing to own window' feature in case you don't need
65        it by passing --disable-own-window to configure -script.
66
67
68 YOU SHOULD KNOW
69        Conky is generally very good on resources. However, certain objects  in
70        Conky  are  harder  on resources then others. In particular, the $tail,
71        $top, $font, and $graph objects are quite costly in comparison  to  the
72        rest of Conky.
73
74        If  you  do use them, please do not complain about memory or CPU usage,
75        unless you think something's seriously wrong (mem leak, etc.).
76
77        An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
78        conky".  Saves you the trouble of having to kill and then restart.
79
80        IMPORTANT:  For  previous Conky users, Conky 1.3 no longer supports the
81        metar stuff.  mdsplib was causing  way  too  many  problems.  Hopefully
82        there'll be a better solution in Conky 2.x...
83
84 OPTIONS
85        Command  line  options override configurations defined in configuration
86        file.
87
88        -v | -V
89               Prints version and exits
90
91
92        -a ALIGNMENT
93               Text alignment on screen, {top,bottom}_{left,right} or none
94
95
96        -b     Use double buffering (eliminates "flicker")
97
98
99        -c FILE
100               Config file to load instead of $HOME/.conkyrc
101
102
103        -d     Daemonize Conky, aka fork to background
104
105
106        -f FONT
107               Font to use
108
109
110        -h     Prints command line help and exits
111
112
113        -o     Create own window to draw
114
115
116        -t TEXT
117               Text to render, remember single quotes, like -t ' $uptime '
118
119
120        -u SECONDS
121               Update interval
122
123
124        -w WIN_ID
125               Window id to draw
126
127
128        -x X_COORDINATE
129               X position
130
131
132        -y Y_COORDINATE
133               Y position
134
135
136 CONFIGURATION SETTINGS
137        Default configuration file  is  $HOME/.conkyrc  (can  be  changed  from
138        conky.c  among  other  things).  See conkyrc.sample. If installing from
139        Debian package, this should be in /usr/share/doc/conky/examples  ("gun-
140        zip conkyrc.sample.gz" to get conkyrc.sample).
141
142        You  might  want  to copy it to $HOME/.conkyrc and then start modifying
143        it.  Other configs can be found at http://conky.sf.net
144
145        alignment
146               Aligned position on screen, may  be  top_left,  top_right,  bot-
147               tom_left, bottom_right, or none
148
149
150        background
151               Boolean  value, if true, Conky will be forked to background when
152               started
153
154
155        on_bottom
156               Set Conky on the bottom of all other applications
157
158
159        border_margin
160               Border margin in pixels
161
162
163        border_width
164               Border width in pixels
165
166
167        cpu_avg_samples
168               The number of samples to average for CPU monitoring
169
170
171        default_color
172               Default color and border color
173
174
175        default_shade_color
176               Default shading color and border's shading color
177
178
179        default_outline_color
180               Default outline color
181
182
183        double_buffer
184               Use the Xdbe extension? (eliminates flicker) It is highly recom-
185               mended to use own window with this one so double buffer won't be
186               so big.
187
188
189        draw_borders
190               Draw borders around text?
191
192
193        draw_graph_borders
194               Draw borders around graphs?
195
196
197        draw_shades
198               Draw shades?
199
200
201        draw_outline
202               Draw outlines?
203
204
205        font   Font name in X, xfontsel can be used to get a nice font
206
207
208        gap_x  Gap between right or left border of screen, same as  passing  -x
209               at command line
210
211
212        gap_y  Gap  between  top or bottom border of screen, same as passing -y
213               at command line
214
215
216        imap   Default global IMAP server. Arguments are: "host user  pass  [-i
217               interval]  [-f  folder] [-p port] [-e command]". Default port is
218               143, default folder is 'INBOX', default interval is  5  minutes.
219               If  the  password  is  supplied  as '*', you will be prompted to
220               enter the password when Conky starts.
221
222
223        no_buffers
224               Substract (file system) buffers from used memory?
225
226
227        mail_spool
228               Mail spool for mail checking
229
230
231        maximum_width pixels
232               Maximum width of window
233
234
235        minimum_size width (height)
236               Minimum size of window
237
238
239        min_port_monitors
240               Allow for the creation of at least this number of port  monitors
241               (if 0 or not set, default is 16)
242
243
244        min_port_monitor_connections
245               Allow  each port monitor to track at least this many connections
246               (if 0 or not set, default is 256)
247
248
249        mldonkey_hostname
250               Hostname for mldonkey stuff, defaults to localhost
251
252
253        mldonkey_port
254               Mldonkey port, 4001 default
255
256
257        mldonkey_login
258               Mldonkey login, default none
259
260
261        mldonkey_password
262               Mldonkey password, default none
263
264
265        mpd_host
266               Host of MPD server
267
268
269        mpd_port
270               Port of MPD server
271
272
273        mpd_password
274               MPD server password
275
276
277        net_avg_samples
278               The number of samples to average for net data
279
280
281        override_utf8_locale
282               Force UTF8? requires XFT
283
284
285        own_window
286               Boolean, create own window to draw?
287
288
289        own_window_transparent
290               Boolean, set pseudo-transparency?
291
292
293        own_window_type
294               if own_window is yes, you may specify type  normal,  desktop  or
295               override (default: normal).  Desktop windows are special windows
296               that have no window decorations;  are  always  visible  on  your
297               desktop;  do not appear in your pager or taskbar; and are sticky
298               across all workspaces.  Override windows are not under the  con-
299               trol of the window manager. Hints are ignored. This type of win-
300               dow can be useful for certain situations.
301
302
303        own_window_colour colour
304               If own_window_transparent no, set a specified background  colour
305               (defaults  to  black).  Takes  either a hex value (#ffffff) or a
306               valid RGB name (see /usr/lib/X11/rgb.txt)
307
308
309        own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
310               If own_window is yes, you may use these window manager hints  to
311               affect the way Conky displays.  Notes: Use own_window_type desk-
312               top as another way to implement many of these hints  implicitly.
313               If  you  use own_window_type override, window manager hints have
314               no meaning and are ignored.
315
316
317        out_to_console
318               Print text to stdout.
319
320
321        pad_percents
322               Pad percentages to this many decimals (0 = no padding)
323
324
325        pop3   Default global POP3 server. Arguments are: "host user  pass  [-i
326               interval]  [-p port] [-e command]". Default port is 110, default
327               interval is 5 minutes. If the password is supplied as  '*',  you
328               will be prompted to enter the password when Conky starts.
329
330
331        stippled_borders
332               Border stippling (dashing) in pixels
333
334
335        total_run_times
336               Total  number of times for Conky to update before quitting. Zero
337               makes Conky run forever
338
339
340        update_interval
341               Update interval in seconds
342
343
344        uppercase
345               Boolean value, if true, text is rendered in upper case
346
347
348        use_spacer
349               Adds spaces after certain objects to stop them from moving other
350               things around. Note that this only helps if you are using a mono
351               font, such as Bitstream Vera Sans Mono.
352
353
354        use_xft
355               Use Xft (anti-aliased font and stuff)
356
357
358        wm_class_name
359               Manually set the WM_CLASS name. Defaults to "conky".
360
361
362        xftalpha
363               Alpha of Xft font. Must be a value at or between 1 and 0.
364
365
366        xftfont
367               Xft font to use.
368
369
370        xmms_player
371               Use specified player/plugin for the xmms status variables. Valid
372               items  are: none, xmms, bmp, audacious and infopipe. (default is
373               none). Note that bmpx is currently handled separately.
374
375
376        TEXT   After this begins text to be formatted on screen
377
378
379 VARIABLES
380        Colors are parsed using XParsecolor(), there might be a list  of  them:
381        /usr/X11R6/lib/X11/rgb.txt.   Also,   http://sedition.com/perl/rgb.html
382        [http://sedition.com/perl/rgb.html].  Color can be also in #rrggbb for-
383        mat (hex).  Note that when displaying bytes, power is 1024 and not 1000
384        so 1M really means 1024*1024 bytes and not 1000*1000.
385
386        addr interface
387               IP address for an interface
388
389
390        acpiacadapter
391               ACPI ac adapter state.
392
393
394        acpifan
395               ACPI fan state
396
397
398        acpitemp
399               ACPI temperature in C.
400
401
402        acpitempf
403               ACPI temperature in F.
404
405
406        adt746xcpu
407               CPU temperature from therm_adt746x
408
409
410        adt746xfan
411               Fan speed from therm_adt746x
412
413
414        alignr (num)
415               Right-justify text, with space of N
416
417
418        alignc (num)
419               Align text to centre
420
421
422        apm_adapter
423               Display APM AC adapter status (FreeBSD only)
424
425
426        apm_battery_life
427               Display APM battery life in percent (FreeBSD only)
428
429
430        apm_battery_time
431               Display remaining APM battery life in hh:mm:ss or  "unknown"  if
432               AC adapterstatus is on-line or charging (FreeBSD only)
433
434
435        battery (num)
436               Remaining  capacity  in ACPI or APM battery. ACPI battery number
437               can be given as argument (default is BAT0).
438
439
440        bmpx_artist
441               Artist in current BMPx track
442
443
444        bmpx_album
445               Album in current BMPx track
446
447
448        bmpx_title
449               Title of the current BMPx track
450
451
452        bmpx_track
453               Track number of the current BMPx track
454
455
456        bmpx_bitrate
457               Bitrate of the current BMPx track
458
459
460        bmpx_uri
461               URI of the current BMPx track
462
463
464        buffers
465               Amount of memory buffered
466
467
468        cached Amount of memory cached
469
470
471        color (color)
472               Change drawing color to color
473
474
475        cpu (cpuN)
476               CPU usage in percents. For SMP machines, the CPU number  can  be
477               provided as an argument. cpu0 is the total usage, and >=cpu1 are
478               individual CPUs.
479
480
481        cpubar (cpu number) (height),(width)
482               Bar that shows CPU usage, height is bar's height in pixels.  See
483               $cpu for more info on SMP.
484
485
486        cpugraph  (cpu  number)  (height),(width) (gradient colour 1) (gradient
487        colour 2)
488               CPU  usage graph, with optional colours in hex, minus the #. See
489               $cpu for more info on SMP.
490
491
492        diskio Displays current disk IO.
493
494
495        diskiograph (height),(width) (gradient colour 1)  (gradient  colour  2)
496        (scale)
497               Disk IO graph, colours defined in hex, minus the #. If scale  is
498               non-zero, it becomes the scale for the graph.
499
500
501        downspeed net
502               Download speed in kilobytes
503
504
505        downspeedf net
506               Download speed in kilobytes with one decimal
507
508
509        downspeedgraph  net  (height),(width)  (gradient  colour  1)  (gradient
510        colour 2) (scale)
511               Download  speed  graph,  colours defined in hex, minus the #. If
512               scale is non-zero, it becomes the scale for the graph.
513
514
515        else   Text to show if any of the above are not true
516
517
518        exec command
519               Executes a shell command and displays the output in conky. warn-
520               ing:  this  takes a lot more resources than other variables. I'd
521               recommend coding wanted behaviour in C and posting a patch.
522
523
524        execbar command
525               Same as exec, except if  the  first  value  return  is  a  value
526               between  0-100,  it will use that number for a bar. The size for
527               the bar is currently fixed, but that may change in the future.
528
529
530        execgraph command
531               Same as execbar, but graphs values.
532
533
534        execi interval command
535               Same as exec but with specific interval. Interval can't be  less
536               than update_interval in configuration. See also $texeci
537
538
539        execibar interval command
540               Same as execbar, except with an interval
541
542
543        execigraph interval command
544               Same as execigraph, but takes an interval arg graphs values
545
546
547        font (font)
548               Specify  a  different font. This new font will apply to the cur-
549               rent line and everything following. You can use a $font with  no
550               arguments  to  change  back  to the default font (much like with
551               $color)
552
553
554        freq (n)
555               Returns CPU #n's frequency in MHz. CPUs are counted from  1.  If
556               omitted, the parameter defaults to 1.
557
558
559        freq_g (n)
560               Returns  CPU  #n's frequency in GHz. CPUs are counted from 1. If
561               omitted, the parameter defaults to 1.
562
563
564        freq_dyn
565               Returns CPU frequency in MHz, but is calculated by  counting  to
566               clock  cycles  to  complete  an  instruction. Only available for
567               x86/amd64.
568
569
570        freq_dyn_g
571               Returns CPU frequency in GHz, but is calculated by  counting  to
572               clock  cycles  to  complete  an  instruction. Only available for
573               x86/amd64.
574
575
576        fs_bar (height),(width) fs
577               Bar that shows how much space is used on a file  system.  height
578               is the height in pixels. fs is any file on that file system.
579
580
581        fs_free (fs)
582               Free space on a file system available for users.
583
584
585        fs_free_perc (fs)
586               Free percentage of space on a file system available for users.
587
588
589        fs_size (fs)
590               File system size
591
592
593        fs_used (fs)
594               File system used space
595
596
597        head logfile lines (interval)
598               Displays  first  N lines of supplied text text file. If interval
599               is not supplied, Conky assumes 2x Conky's interval.  Max  of  30
600               lines can be displayed, or until the text buffer is filled.
601
602
603        hr (height)
604               Horizontal line, height is the height in pixels
605
606
607        iconv_start codeset_from codeset_to
608               Convert  text from one codeset to another using GNU iconv. Needs
609               to be stopped with iconv_stop.
610
611
612        iconv_stop
613               Stop iconv codeset conversion.
614
615
616        i2c (dev) type n
617               I2C sensor from sysfs (Linux 2.6). dev may  be  omitted  if  you
618               have  only  one  I2C  device. type is either in (or vol) meaning
619               voltage, fan meaning fan or temp/tempf (first in C, second in F)
620               meaning   temperature.   n   is   number   of  the  sensor.  See
621               /sys/bus/i2c/devices/ on your local computer.
622
623
624        i8k_ac_status
625               If running the i8k kernel driver for Inspiron laptops,  displays
626               whether  ac  power  is on, as listed in /proc/i8k (translated to
627               human-readable). Beware that this is by default not  enabled  by
628               i8k itself.
629
630
631        i8k_bios
632               If  running the i8k kernel driver for Inspiron laptops, displays
633               the bios version as listed in /proc/i8k.
634
635
636        i8k_buttons_status
637               If running the i8k kernel driver for Inspiron laptops,  displays
638               the volume buttons status as listed in /proc/i8k.
639
640
641        i8k_cpu_temp
642               If  running the i8k kernel driver for Inspiron laptops, displays
643               the cpu temperature in Celsius, as reported by /proc/i8k.
644
645
646        i8k_cpu_tempf
647               If running the i8k kernel driver for Inspiron laptops,  displays
648               the cpu temperature in Farenheit, as reported by /proc/i8k.
649
650
651        i8k_left_fan_rpm
652               If  running the i8k kernel driver for Inspiron laptops, displays
653               the left fan's rate of rotation, in revolutions  per  minute  as
654               listed in /proc/i8k. Beware, some laptops i8k reports these fans
655               in reverse order.
656
657
658        i8k_left_fan_status
659               If running the i8k kernel driver for Inspiron laptops,  displays
660               the left fan status as listed in /proc/i8k (translated to human-
661               readable). Beware,  some  laptops  i8k  reports  these  fans  in
662               reverse order.
663
664
665        i8k_right_fan_rpm
666               If  running the i8k kernel driver for Inspiron laptops, displays
667               the right fan's rate of rotation, in revolutions per  minute  as
668               listed in /proc/i8k. Beware, some laptops i8k reports these fans
669               in reverse order.
670
671
672        i8k_right_fan_status
673               If running the i8k kernel driver for Inspiron laptops,  displays
674               the  right  fan  status  as  listed  in /proc/i8k (translated to
675               human-readable). Beware, some laptops i8k reports these fans  in
676               reverse order.
677
678
679        i8k_serial
680               If  running the i8k kernel driver for Inspiron laptops, displays
681               your laptop serial number as listed in /proc/i8k.
682
683
684        i8k_version
685               If running the i8k kernel driver for Inspiron laptops,  displays
686               the version formatting of /proc/i8k.
687
688
689        if_running (process)
690               if  PROCESS  is  running,  display everything if_running and the
691               matching $endif
692
693
694        if_existing (file)
695               if FILE exists, display everything between if_existing  and  the
696               matching $endif
697
698
699        if_mounted (mountpoint)
700               if  MOUNTPOINT is mounted, display everything between if_mounted
701               and the matching $endif
702
703
704        imap_messages (args)
705               Displays the number of messages in your  global  IMAP  inbox  by
706               default.  You  can  define individual IMAP inboxes seperately by
707               passing arguments to this object. Arguments are: "host user pass
708               [-i  interval]  [-p  port]  [-e  command]". Default port is 110,
709               default interval is 5 minutes. If the password  is  supplied  as
710               '*',  you  will  be  prompted  to  enter the password when Conky
711               starts.
712
713
714        imap_unseen (args)
715               Displays the number of unseen messages in your global IMAP inbox
716               by default. You can define individual IMAP inboxes seperately by
717               passing arguments to this object. Arguments are: "host user pass
718               [-i  interval]  [-p  port]  [-e  command]". Default port is 110,
719               default interval is 5 minutes. If the password  is  supplied  as
720               '*',  you  will  be  prompted  to  enter the password when Conky
721               starts.
722
723
724        kernel Kernel version
725
726
727        linkstatus interface
728               Get the link status for wireless connections
729
730
731        loadavg
732               (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
733               5 minutes and 3 for past 15 minutes.
734
735
736        machine
737               Machine, i686 for example
738
739
740        mails  Mail  count in mail spool. You can use program like fetchmail to
741               get mails from some server using your  favourite  protocol.  See
742               also new_mails.
743
744
745        mem    Amount of memory in use
746
747
748        membar (height),(width)
749               Bar that shows amount of memory in use
750
751
752        memmax Total amount of memory
753
754
755        memperc
756               Percentage of memory in use
757
758
759        mpd_artist
760               Artist in current MPD song must be enabled at compile
761
762
763        mpd_album
764               Album in current MPD song
765
766
767        mpd_bar (height),(width)
768               Bar of mpd's progress
769
770
771        mpd_bitrate
772               Bitrate of current song
773
774
775        mpd_status
776               Playing, stopped, et cetera.
777
778
779        mpd_title
780               Title of current MPD song
781
782
783        mpd_vol
784               MPD's volume
785
786
787        mpd_elapsed
788               Song's elapsed time
789
790
791        mpd_length
792               Song's length
793
794
795        mpd_percent
796               Percent of song's progress
797
798
799        mpd_random
800               Random status (On/Off)
801
802
803        mpd_repeat
804               Repeat status (On/Off)
805
806
807        mpd_track
808               Prints the MPD track field
809
810
811        mpd_name
812               Prints the MPD name field
813
814
815        mpd_file
816               Prints the file name of the current MPD song
817
818
819        mpd_smart
820               Prints the song name in either the form "artist - title" or file
821               name, depending on whats available
822
823
824        new_mails
825               Unread mail count in mail spool.
826
827
828        nodename
829               Hostname
830
831
832        outlinecolor (color)
833               Change outline color
834
835
836        pb_battery item
837               If running on Apple powerbook/ibook, display information on bat-
838               tery  status.  The item parameter specifies, what information to
839               display. Exactly one item must be specified. Valid items are:
840
841               status: Display if battery is fully charged, charging, discharg-
842               ing or absent (running on AC)
843
844               percent:  Display  charge  of battery in percent, if charging or
845               discharging. Nothing will be  displayed,  if  battery  is  fully
846               charged or absent.
847
848               time: Display the time remaining until the battery will be fully
849               charged or discharged at current rate. Nothing is displayed,  if
850               battery  is  absent or if it's present but fully charged and not
851               discharging.
852
853
854        pop3_unseen (args)
855               Displays the number of unseen messages in your global POP3 inbox
856               by default. You can define individual POP3 inboxes seperately by
857               passing arguments to this object. Arguments are: "host user pass
858               [-i  interval]  [-p  port]  [-e  command]". Default port is 110,
859               default interval is 5 minutes. If the password  is  supplied  as
860               '*',  you  will  be  prompted  to  enter the password when Conky
861               starts.
862
863
864        pop3_used (args)
865               Displays the amount of space (in MiB, 2^20) used in your  global
866               POP3  inbox  by  default. You can define individual POP3 inboxes
867               seperately by passing arguments to this object.  Arguments  are:
868               "host  user  pass [-i interval] [-p port] [-e command]". Default
869               port is 110, default interval is 5 minutes. If the  password  is
870               supplied as '*', you will be prompted to enter the password when
871               Conky starts.
872
873
874        pre_exec shell command
875               Executes a shell command one time before conky displays anything
876               and puts output as text.
877
878
879        processes
880               Total processes (sleeping and running)
881
882
883        running_processes
884               Running processes (not sleeping), requires Linux 2.6
885
886
887        shadecolor (color)
888               Change shading color
889
890
891        stippled_hr (space)
892               Stippled (dashed) horizontal line
893
894
895        swapbar (height),(width)
896               Bar that shows amount of swap in use
897
898
899        swap   Amount of swap in use
900
901
902        swapmax
903               Total amount of swap
904
905
906        swapperc
907               Percentage of swap in use
908
909
910        sysname
911               System name, Linux for example
912
913
914        tcp_portmon port_begin port_end item (index) (ip4 only at present)
915               TCP port monitor for specified local ports. Port numbers must be
916               in the range 1 to 65535. Valid items are:
917
918               count - total number of connections in the range
919
920               rip - remote ip address
921
922               rhost - remote host name
923
924               rport - remote port number
925
926               rservice - remote service name from /etc/services
927
928               lip - local ip address
929
930               lhost - local host name
931
932               lport - local port number
933
934               lservice - local service name from /etc/services
935
936               The connection index provides you with access to each connection
937               in  the  port  monitor.  The monitor will return information for
938               index values from 0 to n-1 connections. Values higher  than  n-1
939               are  simply  ignored. For the "count" item, the connection index
940               must be omitted. It is required for all other items.
941
942               Examples:
943
944               ${tcp_portmon 6881 6999 count} - displays the number of  connec-
945               tions in the bittorrent port range
946
947               ${tcp_portmon  22 22 rip 0} - displays the remote host ip of the
948               first sshd connection
949
950               ${tcp_portmon 22 22 rip 9} - displays the remote host ip of  the
951               tenth sshd connection
952
953               ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
954               the first connection on a privileged port
955
956               ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
957               the fifth connection on a privileged port
958
959               ${tcp_portmon  1 65535 lservice 14} - displays the local service
960               name of the fifteenth connection in the range of all ports
961
962               Note that port monitor variables which share the same port range
963               actually refer to the same monitor, so many references to a sin-
964               gle port range for different items and different indexes all use
965               the  same monitor internally. In other words, the program avoids
966               creating redundant monitors.
967
968        texeci interval command
969               Runs a command at an interval inside a thread and  displays  the
970               output.  Same  as  $execi,  except  the  command is run inside a
971               thread. Use this if you have a slow script to keep Conky  updat-
972               ing.  You should make the interval slightly longer then the time
973               it takes your script to execute. For  example,  if  you  have  a
974               script  that  take  5  seconds  to  execute, you should make the
975               interval at least 6 seconds. See also $execi.
976
977
978        offset (pixels)
979               Move text over by N pixels. See also $voffset.
980
981
982        tail logfile lines (interval)
983               Displays last N lines of supplied text text file. If interval is
984               not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
985               can be displayed, or until the text buffer is filled.
986
987
988        time (format)
989               Local time, see man strftime to get more information about  for-
990               mat
991
992
993        totaldown net
994               Total  download, overflows at 4 GB on Linux with 32-bit arch and
995               there doesn't seem to be a way to know how  many  times  it  has
996               already done that before conky has started.
997
998
999        top type, num
1000               This  takes arguments in the form:top (name) (number) Basically,
1001               processes are ranked from highest to  lowest  in  terms  of  cpu
1002               usage,  which  is  what (num) represents. The types are: "name",
1003               "pid", "cpu", and "mem". There can be  a  max  of  10  processes
1004               listed.
1005
1006
1007        top_mem type, num
1008               Same as top, except sorted by mem usage instead of cpu
1009
1010
1011        totalup net
1012               Total upload, this one too, may overflow
1013
1014
1015        updates Number of updates
1016               for debugging
1017
1018
1019        upspeed net
1020               Upload speed in kilobytes
1021
1022
1023        upspeedf net
1024               Upload speed in kilobytes with one decimal
1025
1026
1027        upspeedgraph  net (height),(width) (gradient colour 1) (gradient colour
1028        2) (scale)
1029               Upload  speed  graph,  colours  defined  in hex, minus the #. If
1030               scale is non-zero, it becomes the scale for the graph.
1031
1032
1033        uptime Uptime
1034
1035
1036        uptime_short
1037               Uptime in a shorter format
1038
1039
1040        seti_prog
1041               Seti@home current progress
1042
1043
1044        seti_progbar (height),(width)
1045               Seti@home current progress bar
1046
1047
1048        seti_credit
1049               Seti@home total user credit
1050
1051
1052        voffset (pixels)
1053               Change vertical offset by N pixels. Negative values  will  cause
1054               text to overlap. See also $offset.
1055
1056
1057        xmms_bar (height),(width)
1058               xmms / bmp / audacious / infopipe: progress bar
1059
1060
1061        xmms_bitrate
1062               xmms / bmp / audacious / infopipe: bitrate of current tune
1063
1064
1065        xmms_channels
1066               xmms  /  bmp / audacious / infopipe: number of audio channels of
1067               current tune
1068
1069
1070        xmms_filename
1071               xmms / bmp / audacious / infopipe: full  path  and  filename  of
1072               current tune
1073
1074
1075        xmms_frequency
1076               xmms / bmp / audacious / infopipe: sampling frequency of current
1077               tune
1078
1079
1080        xmms_length
1081               xmms / bmp / audacious / infopipe: total length of current  tune
1082               as MM:SS
1083
1084
1085        xmms_length_seconds
1086               xmms  / bmp / audacious / infopipe: total length of current tune
1087               in seconds
1088
1089
1090        xmms_playlist_position
1091               xmms / bmp / audacious / infopipe: playlist position of  current
1092               tune
1093
1094
1095        xmms_playlist_length
1096               xmms / bmp / audacious / infopipe: number of tunes in playlist
1097
1098
1099        xmms_position
1100               xmms  /  bmp  /  audacious / infopipe: MM:SS position of current
1101               tune
1102
1103
1104        xmms_position_seconds
1105               xmms / bmp / audacious / infopipe: position of current  tune  in
1106               seconds
1107
1108
1109        xmms_status
1110               xmms  /  bmp  /  audacious  /  infopipe:  player  status  (Play-
1111               ing/Paused/Stopped/Not running)
1112
1113
1114        xmms_title
1115               xmms / bmp / audacious / infopipe: title of current tune
1116
1117
1118        ibm_fan
1119               If running the IBM ACPI, displays the fan speed.
1120
1121
1122        ibm_temps N
1123               If running the IBM ACPI, displays the temperatures from the  IBM
1124               temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
1125               GPU.
1126
1127
1128        ibm_volume
1129               If running the IBM ACPI,  displays  the  "master"  volume,  con-
1130               trolled by the volume keys (0-14).
1131
1132
1133        ibm_brightness
1134               If running the IBM ACPI, displays the brigtness of the laptops's
1135               LCD (0-7).
1136
1137
1138 EXAMPLES
1139        conky -t '${time %D %H:%m}' -o -u 30
1140               Start Conky in its own window with date and clock as text and 30
1141               sec update interval.
1142
1143        conky -a top_left -x 5 -y 500 -d
1144               Start Conky to background at coordinates (5, 500).
1145
1146 FILES
1147        ~/.conkyrc default configuration file
1148
1149 BUGS
1150        Drawing to root or some other desktop window directly doesn't work with
1151        all window managers. Especially doesn't work well with Gnome and it has
1152        been  reported  that  it  doesn't work with KDE either. Nautilus can be
1153        disabled from drawing to desktop  with  program  gconf-editor.  Uncheck
1154        show_desktop  in  /apps/nautilus/preferences/.  There  is  -w switch in
1155        Conky to set some specific window id. You  might  find  xwininfo  -tree
1156        useful  to  find  the  window  to draw to. You can also use -o argument
1157        which makes Conky to create its own window.
1158
1159 SEE ALSO
1160        http://conky.sourceforge.net [http://conky.sourceforge.net]
1161
1162        http://www.sourceforge.net/projects/conky           [http://www.source-
1163        forge.net/projects/conky]
1164
1165        #conky on irc.freenode.net
1166
1167 AUTHORS
1168        The Conky dev team. What's up now!
1169
1170
1171
1172                                   2006-05-13                          conky(1)