spock's hddtemp & goto patches
[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 de-
21        veloper 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       --in-
45        fodir=/usr/share/info  --datadir=/usr/share  --sysconfdir=/etc --local-
46        statedir=/var/lib  --enable-xft  --enable-seti   --enable-double-buffer
47        --enable-own-window --enable-proc-uptime --enable-mpd --enable-mldonkey
48        --enable-x11 --enable-portmon --enable-xmms --enable-bmp --enable-auda-
49        cious --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 De-
139        bian package, this should be in /usr/share/doc/conky/examples  ("gunzip
140        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 en-
220               ter 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        Color can be also in #rrggbb format (hex).  Note that  when  displaying
383        bytes,  power  is  1024 and not 1000 so 1M really means 1024*1024 bytes
384        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  be-
526               tween 0-100, it will use that number for a bar. The size for the
527               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        goto x The next element will be printed at position 'x'.
598
599
600        hddtemp dev, (host,(port))
601               Displays  temperature  of a selected hard disk drive as reported
602               by the hddtemp daemon running on  host:port.   Default  host  is
603               127.0.0.1, default port is 7634.
604
605
606        head logfile lines (interval)
607               Displays  first  N lines of supplied text text file. If interval
608               is not supplied, Conky assumes 2x Conky's interval.  Max  of  30
609               lines can be displayed, or until the text buffer is filled.
610
611
612        hr (height)
613               Horizontal line, height is the height in pixels
614
615
616        iconv_start codeset_from codeset_to
617               Convert  text from one codeset to another using GNU iconv. Needs
618               to be stopped with iconv_stop.
619
620
621        iconv_stop
622               Stop iconv codeset conversion.
623
624
625        i2c (dev) type n
626               I2C sensor from sysfs (Linux 2.6). dev may  be  omitted  if  you
627               have  only  one  I2C  device. type is either in (or vol) meaning
628               voltage, fan meaning fan or temp/tempf (first in C, second in F)
629               meaning   temperature.   n   is   number   of  the  sensor.  See
630               /sys/bus/i2c/devices/ on your local computer.
631
632
633        i8k_ac_status
634               If running the i8k kernel driver for Inspiron laptops,  displays
635               whether  ac  power  is on, as listed in /proc/i8k (translated to
636               human-readable). Beware that this is by default not  enabled  by
637               i8k itself.
638
639
640        i8k_bios
641               If  running the i8k kernel driver for Inspiron laptops, displays
642               the bios version as listed in /proc/i8k.
643
644
645        i8k_buttons_status
646               If running the i8k kernel driver for Inspiron laptops,  displays
647               the volume buttons status as listed in /proc/i8k.
648
649
650        i8k_cpu_temp
651               If  running the i8k kernel driver for Inspiron laptops, displays
652               the cpu temperature in Celsius, as reported by /proc/i8k.
653
654
655        i8k_cpu_tempf
656               If running the i8k kernel driver for Inspiron laptops,  displays
657               the cpu temperature in Farenheit, as reported by /proc/i8k.
658
659
660        i8k_left_fan_rpm
661               If  running the i8k kernel driver for Inspiron laptops, displays
662               the left fan's rate of rotation, in revolutions  per  minute  as
663               listed in /proc/i8k. Beware, some laptops i8k reports these fans
664               in reverse order.
665
666
667        i8k_left_fan_status
668               If running the i8k kernel driver for Inspiron laptops,  displays
669               the left fan status as listed in /proc/i8k (translated to human-
670               readable). Beware, some laptops i8k reports these  fans  in  re-
671               verse order.
672
673
674        i8k_right_fan_rpm
675               If  running the i8k kernel driver for Inspiron laptops, displays
676               the right fan's rate of rotation, in revolutions per  minute  as
677               listed in /proc/i8k. Beware, some laptops i8k reports these fans
678               in reverse order.
679
680
681        i8k_right_fan_status
682               If running the i8k kernel driver for Inspiron laptops,  displays
683               the  right  fan status as listed in /proc/i8k (translated to hu-
684               man-readable). Beware, some laptops i8k reports  these  fans  in
685               reverse order.
686
687
688        i8k_serial
689               If  running the i8k kernel driver for Inspiron laptops, displays
690               your laptop serial number as listed in /proc/i8k.
691
692
693        i8k_version
694               If running the i8k kernel driver for Inspiron laptops,  displays
695               the version formatting of /proc/i8k.
696
697
698        ibm_fan
699               If running the IBM ACPI, displays the fan speed.
700
701
702        ibm_temps N
703               If  running the IBM ACPI, displays the temperatures from the IBM
704               temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
705               GPU.
706
707
708        ibm_volume
709               If  running  the  IBM  ACPI,  displays the "master" volume, con-
710               trolled by the volume keys (0-14).
711
712
713        ibm_brightness
714               If running the IBM ACPI, displays the brigtness of the laptops's
715               LCD (0-7).
716
717
718        if_running (process)
719               if  PROCESS  is  running,  display everything if_running and the
720               matching $endif
721
722
723        if_existing (file)
724               if FILE exists, display everything between if_existing  and  the
725               matching $endif
726
727
728        if_mounted (mountpoint)
729               if  MOUNTPOINT is mounted, display everything between if_mounted
730               and the matching $endif
731
732
733        imap_messages (args)
734               Displays the number of messages in your global IMAP inbox by de-
735               fault.  You  can  define  individual  IMAP inboxes seperately by
736               passing arguments to this object. Arguments are: "host user pass
737               [-i  interval] [-p port] [-e command]". Default port is 110, de-
738               fault interval is 5 minutes. If the password is supplied as '*',
739               you will be prompted to enter the password when Conky starts.
740
741
742        imap_unseen (args)
743               Displays the number of unseen messages in your global IMAP inbox
744               by default. You can define individual IMAP inboxes seperately by
745               passing arguments to this object. Arguments are: "host user pass
746               [-i interval] [-p port] [-e command]". Default port is 110,  de-
747               fault interval is 5 minutes. If the password is supplied as '*',
748               you will be prompted to enter the password when Conky starts.
749
750
751        kernel Kernel version
752
753
754        linkstatus interface
755               Get the link status for wireless connections
756
757
758        loadavg
759               (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
760               5 minutes and 3 for past 15 minutes.
761
762
763        machine
764               Machine, i686 for example
765
766
767        mails  Mail  count in mail spool. You can use program like fetchmail to
768               get mails from some server using your  favourite  protocol.  See
769               also new_mails.
770
771
772        mem    Amount of memory in use
773
774
775        membar (height),(width)
776               Bar that shows amount of memory in use
777
778
779        memmax Total amount of memory
780
781
782        memperc
783               Percentage of memory in use
784
785
786        mpd_artist
787               Artist in current MPD song must be enabled at compile
788
789
790        mpd_album
791               Album in current MPD song
792
793
794        mpd_bar (height),(width)
795               Bar of mpd's progress
796
797
798        mpd_bitrate
799               Bitrate of current song
800
801
802        mpd_status
803               Playing, stopped, et cetera.
804
805
806        mpd_title
807               Title of current MPD song
808
809
810        mpd_vol
811               MPD's volume
812
813
814        mpd_elapsed
815               Song's elapsed time
816
817
818        mpd_length
819               Song's length
820
821
822        mpd_percent
823               Percent of song's progress
824
825
826        mpd_random
827               Random status (On/Off)
828
829
830        mpd_repeat
831               Repeat status (On/Off)
832
833
834        mpd_track
835               Prints the MPD track field
836
837
838        mpd_name
839               Prints the MPD name field
840
841
842        mpd_file
843               Prints the file name of the current MPD song
844
845
846        mpd_smart
847               Prints the song name in either the form "artist - title" or file
848               name, depending on whats available
849
850
851        new_mails
852               Unread mail count in mail spool.
853
854
855        nodename
856               Hostname
857
858
859        outlinecolor (color)
860               Change outline color
861
862
863        pb_battery item
864               If running on Apple powerbook/ibook, display information on bat-
865               tery  status.  The item parameter specifies, what information to
866               display. Exactly one item must be specified. Valid items are:
867
868               status: Display if battery is fully charged, charging, discharg-
869               ing or absent (running on AC)
870               percent:  Display  charge  of battery in percent, if charging or
871               discharging. Nothing will be  displayed,  if  battery  is  fully
872               charged or absent.
873               time: Display the time remaining until the battery will be fully
874               charged or discharged at current rate. Nothing is displayed,  if
875               battery  is  absent or if it's present but fully charged and not
876               discharging.
877
878
879        pop3_unseen (args)
880               Displays the number of unseen messages in your global POP3 inbox
881               by default. You can define individual POP3 inboxes seperately by
882               passing arguments to this object. Arguments are: "host user pass
883               [-i  interval] [-p port] [-e command]". Default port is 110, de-
884               fault interval is 5 minutes. If the password is supplied as '*',
885               you will be prompted to enter the password when Conky starts.
886
887
888        pop3_used (args)
889               Displays  the amount of space (in MiB, 2^20) used in your global
890               POP3 inbox by default. You can define  individual  POP3  inboxes
891               seperately  by  passing arguments to this object. Arguments are:
892               "host user pass [-i interval] [-p port] [-e  command]".  Default
893               port  is  110, default interval is 5 minutes. If the password is
894               supplied as '*', you will be prompted to enter the password when
895               Conky starts.
896
897
898        pre_exec shell command
899               Executes a shell command one time before conky displays anything
900               and puts output as text.
901
902
903        processes
904               Total processes (sleeping and running)
905
906
907        running_processes
908               Running processes (not sleeping), requires Linux 2.6
909
910
911        shadecolor (color)
912               Change shading color
913
914
915        stippled_hr (space)
916               Stippled (dashed) horizontal line
917
918
919        swapbar (height),(width)
920               Bar that shows amount of swap in use
921
922
923        swap   Amount of swap in use
924
925
926        swapmax
927               Total amount of swap
928
929
930        swapperc
931               Percentage of swap in use
932
933
934        sysname
935               System name, Linux for example
936
937
938        tcp_portmon port_begin port_end item (index) (ip4 only at present)
939               TCP port monitor for specified local ports. Port numbers must be
940               in the range 1 to 65535. Valid items are:
941
942               count - total number of connections in the range
943               rip - remote ip address
944               rhost - remote host name
945               rport - remote port number
946               rservice - remote service name from /etc/services
947               lip - local ip address
948               lhost - local host name
949               lport - local port number
950               lservice - local service name from /etc/services
951
952               The connection index provides you with access to each connection
953               in the port monitor. The monitor will return information for in-
954               dex values from 0 to n-1 connections. Values higher than n-1 are
955               simply ignored. For the "count" item, the connection index  must
956               be omitted. It is required for all other items.
957
958               Examples:
959               ${tcp_portmon  6881 6999 count} - displays the number of connec-
960               tions in the bittorrent port range
961               ${tcp_portmon 22 22 rip 0} - displays the remote host ip of  the
962               first sshd connection
963               ${tcp_portmon  22 22 rip 9} - displays the remote host ip of the
964               tenth sshd connection
965               ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
966               the first connection on a privileged port
967               ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
968               the fifth connection on a privileged port
969               ${tcp_portmon 1 65535 lservice 14} - displays the local  service
970               name of the fifteenth connection in the range of all ports
971
972               Note that port monitor variables which share the same port range
973               actually refer to the same monitor, so many references to a sin-
974               gle port range for different items and different indexes all use
975               the same monitor internally. In other words, the program  avoids
976               creating redundant monitors.
977
978        texeci interval command
979               Runs  a  command at an interval inside a thread and displays the
980               output. Same as $execi, except  the  command  is  run  inside  a
981               thread.  Use this if you have a slow script to keep Conky updat-
982               ing. You should make the interval slightly longer then the  time
983               it  takes  your  script  to  execute. For example, if you have a
984               script that take 5 seconds to execute, you should make  the  in-
985               terval at least 6 seconds. See also $execi.
986
987
988        offset (pixels)
989               Move text over by N pixels. See also $voffset.
990
991
992        tab (width, (start))
993               Puts a tab of the specified width, starting from column 'start'.
994
995
996        tail logfile lines (interval)
997               Displays last N lines of supplied text text file. If interval is
998               not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
999               can be displayed, or until the text buffer is filled.
1000
1001
1002        time (format)
1003               Local time, see man strftime to get more information about  for-
1004               mat
1005
1006
1007        utime (format)
1008               Display time in UTC (universal coordinate time).
1009
1010
1011        tztime (timezone) (format)
1012               Local  time for specified timezone, see man strftime to get more
1013               information about format. The timezone argument is specified  in
1014               similar  fashion  as TZ environment variable. For hints, look in
1015               /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1016
1017
1018        totaldown net
1019               Total download, overflows at 4 GB on Linux with 32-bit arch  and
1020               there doesn't seem to be a way to know how many times it has al-
1021               ready done that before conky has started.
1022
1023
1024        top type, num
1025               This takes arguments in the form:top (name) (number)  Basically,
1026               processes  are ranked from highest to lowest in terms of cpu us-
1027               age, which is what (num)  represents.  The  types  are:  "name",
1028               "pid",  "cpu",  and  "mem".  There  can be a max of 10 processes
1029               listed.
1030
1031
1032        top_mem type, num
1033               Same as top, except sorted by mem usage instead of cpu
1034
1035
1036        totalup net
1037               Total upload, this one too, may overflow
1038
1039
1040        updates Number of updates
1041               for debugging
1042
1043
1044        upspeed net
1045               Upload speed in kilobytes
1046
1047
1048        upspeedf net
1049               Upload speed in kilobytes with one decimal
1050
1051
1052        upspeedgraph net (height),(width) (gradient colour 1) (gradient  colour
1053        2) (scale)
1054               Upload speed graph, colours defined in  hex,  minus  the  #.  If
1055               scale is non-zero, it becomes the scale for the graph.
1056
1057
1058        uptime Uptime
1059
1060
1061        uptime_short
1062               Uptime in a shorter format
1063
1064
1065        seti_prog
1066               Seti@home current progress
1067
1068
1069        seti_progbar (height),(width)
1070               Seti@home current progress bar
1071
1072
1073        seti_credit
1074               Seti@home total user credit
1075
1076
1077        voffset (pixels)
1078               Change  vertical  offset by N pixels. Negative values will cause
1079               text to overlap. See also $offset.
1080
1081
1082        voltage_mv (n)
1083               Returns CPU #n's voltage in mV. CPUs  are  counted  from  1.  If
1084               omitted, the parameter defaults to 1.
1085
1086
1087        voltage_v (n)
1088               Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1089               ted, the parameter defaults to 1.
1090
1091
1092        xmms_bar (height),(width)
1093               xmms / bmp / audacious / infopipe: progress bar
1094
1095
1096        xmms_bitrate
1097               xmms / bmp / audacious / infopipe: bitrate of current tune
1098
1099
1100        xmms_channels
1101               xmms / bmp / audacious / infopipe: number of audio  channels  of
1102               current tune
1103
1104
1105        xmms_filename
1106               xmms  /  bmp  /  audacious / infopipe: full path and filename of
1107               current tune
1108
1109
1110        xmms_frequency
1111               xmms / bmp / audacious / infopipe: sampling frequency of current
1112               tune
1113
1114
1115        xmms_length
1116               xmms  / bmp / audacious / infopipe: total length of current tune
1117               as MM:SS
1118
1119
1120        xmms_length_seconds
1121               xmms / bmp / audacious / infopipe: total length of current  tune
1122               in seconds
1123
1124
1125        xmms_playlist_position
1126               xmms  / bmp / audacious / infopipe: playlist position of current
1127               tune
1128
1129
1130        xmms_playlist_length
1131               xmms / bmp / audacious / infopipe: number of tunes in playlist
1132
1133
1134        xmms_position
1135               xmms / bmp / audacious / infopipe:  MM:SS  position  of  current
1136               tune
1137
1138
1139        xmms_position_seconds
1140               xmms  /  bmp / audacious / infopipe: position of current tune in
1141               seconds
1142
1143
1144        xmms_status
1145               xmms  /  bmp  /  audacious  /  infopipe:  player  status  (Play-
1146               ing/Paused/Stopped/Not running)
1147
1148
1149        xmms_title
1150               xmms / bmp / audacious / infopipe: title of current tune
1151
1152
1153 EXAMPLES
1154        conky -t '${time %D %H:%m}' -o -u 30
1155               Start Conky in its own window with date and clock as text and 30
1156               sec update interval.
1157
1158        conky -a top_left -x 5 -y 500 -d
1159               Start Conky to background at coordinates (5, 500).
1160
1161 FILES
1162        ~/.conkyrc default configuration file
1163
1164 BUGS
1165        Drawing to root or some other desktop window directly doesn't work with
1166        all window managers. Especially doesn't work well with Gnome and it has
1167        been reported that it doesn't work with KDE  either.  Nautilus  can  be
1168        disabled  from  drawing  to  desktop with program gconf-editor. Uncheck
1169        show_desktop in /apps/nautilus/preferences/.  There  is  -w  switch  in
1170        Conky  to  set  some  specific window id. You might find xwininfo -tree
1171        useful to find the window to draw to. You  can  also  use  -o  argument
1172        which makes Conky to create its own window.
1173
1174 SEE ALSO
1175        <http://conky.sourceforge.net>
1176
1177        <http://www.sourceforge.net/projects/conky>
1178
1179        #conky on irc.freenode.net
1180
1181 AUTHORS
1182        The Conky dev team. What's up now!
1183
1184
1185
1186                                   2006-05-13                          conky(1)