documentation
[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-own-window --enable-proc-uptime
47        --enable-audacious  --enable-bmpx  --enable-hddtemp  --enable-mpd --en-
48        able-xmms2  --enable-imlib2   --enable-portmon   --enable-debug   --en-
49        able-double-buffer --enable-xdamage --enable-x11
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        border_margin
156               Border margin in pixels
157
158
159        border_width
160               Border width in pixels
161
162
163        cpu_avg_samples
164               The number of samples to average for CPU monitoring
165
166
167        default_color
168               Default color and border color
169
170
171        default_outline_color
172               Default outline color
173
174
175        default_shade_color
176               Default shading color and border's shading color
177
178
179        double_buffer
180               Use the Xdbe extension? (eliminates flicker) It is highly recom-
181               mended to use own window with this one so double buffer won't be
182               so big.
183
184
185        draw_borders
186               Draw borders around text?
187
188
189        draw_graph_borders
190               Draw borders around graphs?
191
192
193        draw_outline
194               Draw outlines?
195
196
197        draw_shades
198               Draw shades?
199
200
201        font   Font name in X, xfontsel can be used to get a nice font
202
203
204        gap_x  Gap between right or left border of screen, same as  passing  -x
205               at command line
206
207
208        gap_y  Gap  between  top or bottom border of screen, same as passing -y
209               at command line
210
211
212        imap   Default global IMAP server. Arguments are: "host user  pass  [-i
213               interval]  [-f  folder] [-p port] [-e command]". Default port is
214               143, default folder is 'INBOX', default interval is  5  minutes.
215               If  the password is supplied as '*', you will be prompted to en-
216               ter the password when Conky starts.
217
218
219        mail_spool
220               Mail spool for mail checking
221
222
223        max_user_text bytes
224               Maximum size of user text buffer, i.e. layout below TEXT line in
225               config file (default is 16384 bytes)
226
227
228        maximum_width pixels
229               Maximum width of window
230
231
232        minimum_size width (height)
233               Minimum size of window
234
235
236        min_port_monitors
237               Allow  for the creation of at least this number of port monitors
238               (if 0 or not set, default is 16)
239
240
241        min_port_monitor_connections
242               Allow each port monitor to track at least this many  connections
243               (if 0 or not set, default is 256)
244
245
246        mpd_host
247               Host of MPD server
248
249
250        mpd_port
251               Port of MPD server
252
253
254        mpd_password
255               MPD server password
256
257
258        net_avg_samples
259               The number of samples to average for net data
260
261
262        no_buffers
263               Substract (file system) buffers from used memory?
264
265
266        override_utf8_locale
267               Force UTF8? requires XFT
268
269
270        own_window
271               Boolean, create own window to draw?
272
273
274        own_window_transparent
275               Boolean, set pseudo-transparency?
276
277
278        own_window_type
279               if  own_window  is  yes, you may specify type normal, desktop or
280               override (default: normal).  Desktop windows are special windows
281               that  have  no  window  decorations;  are always visible on your
282               desktop; do not appear in your pager or taskbar; and are  sticky
283               across  all workspaces.  Override windows are not under the con-
284               trol of the window manager. Hints are ignored. This type of win-
285               dow can be useful for certain situations.
286
287
288        own_window_colour colour
289               If  own_window_transparent no, set a specified background colour
290               (defaults to black). Takes either a hex  value  (#ffffff)  or  a
291               valid RGB name (see /usr/lib/X11/rgb.txt)
292
293
294        own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
295               If  own_window is yes, you may use these window manager hints to
296               affect the way Conky displays.  Notes: Use own_window_type desk-
297               top  as another way to implement many of these hints implicitly.
298               If you use own_window_type override, window manager  hints  have
299               no meaning and are ignored.
300
301
302        out_to_console
303               Print text to stdout.
304
305
306        pad_percents
307               Pad percentages to this many decimals (0 = no padding)
308
309
310        pop3   Default  global  POP3 server. Arguments are: "host user pass [-i
311               interval] [-p port] [-e command]". Default port is 110,  default
312               interval  is  5 minutes. If the password is supplied as '*', you
313               will be prompted to enter the password when Conky starts.
314
315
316        stippled_borders
317               Border stippling (dashing) in pixels
318
319
320        total_run_times
321               Total number of times for Conky to update before quitting.  Zero
322               makes Conky run forever
323
324
325        update_interval
326               Update interval in seconds
327
328
329        uppercase
330               Boolean value, if true, text is rendered in upper case
331
332
333        use_spacer
334               Adds spaces after certain objects to stop them from moving other
335               things around. Note that this only helps if you are using a mono
336               font, such as Bitstream Vera Sans Mono.
337
338
339        use_xft
340               Use Xft (anti-aliased font and stuff)
341
342
343        wm_class_name
344               Manually set the WM_CLASS name. Defaults to "conky".
345
346
347        xftalpha
348               Alpha of Xft font. Must be a value at or between 1 and 0.
349
350
351        xftfont
352               Xft font to use.
353
354
355        TEXT   After this begins text to be formatted on screen
356
357
358 VARIABLES
359        Colors  are  parsed using XParsecolor(), there might be a list of them:
360        /usr/X11R6/lib/X11/rgb.txt. Also,  <http://sedition.com/perl/rgb.html>.
361        Color  can  be also in #rrggbb format (hex).  Note that when displaying
362        bytes, power is 1024 and not 1000 so 1M really  means  1024*1024  bytes
363        and not 1000*1000.
364
365        addr interface
366               IP address for an interface
367
368
369        acpiacadapter
370               ACPI ac adapter state.
371
372
373        acpifan
374               ACPI fan state
375
376
377        acpitemp
378               ACPI temperature in C.
379
380
381        acpitempf
382               ACPI temperature in F.
383
384
385        adt746xcpu
386               CPU temperature from therm_adt746x
387
388
389        adt746xfan
390               Fan speed from therm_adt746x
391
392
393        alignr (num)
394               Right-justify text, with space of N
395
396
397        alignc (num)
398               Align text to centre
399
400
401        apm_adapter
402               Display APM AC adapter status (FreeBSD only)
403
404
405        apm_battery_life
406               Display APM battery life in percent (FreeBSD only)
407
408
409        apm_battery_time
410               Display  remaining  APM battery life in hh:mm:ss or "unknown" if
411               AC adapterstatus is on-line or charging (FreeBSD only)
412
413
414        audacious_bar (height),(width)
415               Progress bar
416
417
418        audacious_bitrate
419               Bitrate of current tune
420
421
422        audacious_channels
423               Number of audio channels of current tune
424
425
426        audacious_filename
427               Full path and filename of current tune
428
429
430        audacious_frequency
431               Sampling frequency of current tune
432
433
434        audacious_length
435               Total length of current tune as MM:SS
436
437
438        audacious_length_seconds
439               Total length of current tune in seconds
440
441
442        audacious_playlist_position
443               Playlist position of current tune
444
445
446        audacious_playlist_length
447               Number of tunes in playlist
448
449
450        audacious_position
451               Position of current tune (MM:SS)
452
453
454        audacious_position_seconds
455               Position of current tune in seconds
456
457
458        audacious_status
459               Player status (Playing/Paused/Stopped/Not running)
460
461
462        audacious_title
463               Title of current tune
464
465
466        battery (num)
467               Remaining capacity in ACPI or APM battery. ACPI  battery  number
468               can be given as argument (default is BAT0).
469
470
471        bmpx_artist
472               Artist in current BMPx track
473
474
475        bmpx_album
476               Album in current BMPx track
477
478
479        bmpx_title
480               Title of the current BMPx track
481
482
483        bmpx_track
484               Track number of the current BMPx track
485
486
487        bmpx_bitrate
488               Bitrate of the current BMPx track
489
490
491        bmpx_uri
492               URI of the current BMPx track
493
494
495        buffers
496               Amount of memory buffered
497
498
499        cached Amount of memory cached
500
501
502        color (color)
503               Change drawing color to color
504
505
506        cpu (cpuN)
507               CPU  usage  in percents. For SMP machines, the CPU number can be
508               provided as an argument. ${cpu 0} is the total usage, and  ${cpu
509               X} (X >= 1) are individual CPUs.
510
511
512        cpubar (cpu number) (height),(width)
513               Bar  that shows CPU usage, height is bar's height in pixels. See
514               $cpu for more info on SMP.
515
516
517        cpugraph (cpu number) (height),(width) (gradient  colour  1)  (gradient
518        colour 2)
519               CPU usage graph, with optional colours in hex, minus the #.  See
520               $cpu for more info on SMP.
521
522
523        diskio Displays current disk IO.
524
525
526        diskiograph  (height),(width)  (gradient  colour 1) (gradient colour 2)
527        (scale)
528               Disk  IO graph, colours defined in hex, minus the #. If scale is
529               non-zero, it becomes the scale for the graph.
530
531
532        downspeed net
533               Download speed in kilobytes
534
535
536        downspeedf net
537               Download speed in kilobytes with one decimal
538
539
540        downspeedgraph  net  (height),(width)  (gradient  colour  1)  (gradient
541        colour 2) (scale)
542               Download speed graph, colours defined in hex, minus  the  #.  If
543               scale is non-zero, it becomes the scale for the graph.
544
545
546        else   Text to show if any of the above are not true
547
548
549        exec command
550               Executes a shell command and displays the output in conky. warn-
551               ing: this takes a lot more resources than other  variables.  I'd
552               recommend coding wanted behaviour in C and posting a patch.
553
554
555        execbar command
556               Same  as  exec,  except if the first value return is a value be-
557               tween 0-100, it will use that number for a bar. The size for the
558               bar is currently fixed, but that may change in the future.
559
560
561        execgraph command
562               Same as execbar, but graphs values.
563
564
565        execi interval command
566               Same  as exec but with specific interval. Interval can't be less
567               than update_interval in configuration. See also $texeci
568
569
570        execibar interval command
571               Same as execbar, except with an interval
572
573
574        execigraph interval command
575               Same as execigraph, but takes an interval arg graphs values
576
577
578        font (font)
579               Specify a different font. This new font will apply to  the  cur-
580               rent  line and everything following. You can use a $font with no
581               arguments to change back to the default  font  (much  like  with
582               $color)
583
584
585        freq (n)
586               Returns  CPU  #n's frequency in MHz. CPUs are counted from 1. If
587               omitted, the parameter defaults to 1.
588
589
590        freq_g (n)
591               Returns CPU #n's frequency in GHz. CPUs are counted from  1.  If
592               omitted, the parameter defaults to 1.
593
594
595        freq_dyn
596               Returns  CPU  frequency in MHz, but is calculated by counting to
597               clock cycles to complete  an  instruction.  Only  available  for
598               x86/amd64.
599
600
601        freq_dyn_g
602               Returns  CPU  frequency in GHz, but is calculated by counting to
603               clock cycles to complete  an  instruction.  Only  available  for
604               x86/amd64.
605
606
607        fs_bar (height),(width) fs
608               Bar  that  shows how much space is used on a file system. height
609               is the height in pixels. fs is any file on that file system.
610
611
612        fs_free (fs)
613               Free space on a file system available for users.
614
615
616        fs_free_perc (fs)
617               Free percentage of space on a file system available for users.
618
619
620        fs_size (fs)
621               File system size
622
623
624        fs_used (fs)
625               File system used space
626
627
628        goto x The next element will be printed at position 'x'.
629
630
631        hddtemp dev, (host,(port))
632               Displays temperature of a selected hard disk drive  as  reported
633               by  the  hddtemp  daemon  running on host:port.  Default host is
634               127.0.0.1, default port is 7634.
635
636
637        head logfile lines (interval)
638               Displays first N lines of supplied text text file.  If  interval
639               is  not  supplied,  Conky assumes 2x Conky's interval. Max of 30
640               lines can be displayed, or until the text buffer is filled.
641
642
643        hr (height)
644               Horizontal line, height is the height in pixels
645
646
647        iconv_start codeset_from codeset_to
648               Convert text from one codeset to another using GNU iconv.  Needs
649               to be stopped with iconv_stop.
650
651
652        iconv_stop
653               Stop iconv codeset conversion.
654
655
656        i2c (dev) type n
657               I2C  sensor  from  sysfs  (Linux 2.6). dev may be omitted if you
658               have only one I2C device. type is either  in  (or  vol)  meaning
659               voltage, fan meaning fan or temp/tempf (first in C, second in F)
660               meaning  temperature.  n  is   number   of   the   sensor.   See
661               /sys/bus/i2c/devices/ on your local computer.
662
663
664        i8k_ac_status
665               If  running the i8k kernel driver for Inspiron laptops, displays
666               whether ac power is on, as listed in  /proc/i8k  (translated  to
667               human-readable).  Beware  that this is by default not enabled by
668               i8k itself.
669
670
671        i8k_bios
672               If running the i8k kernel driver for Inspiron laptops,  displays
673               the bios version as listed in /proc/i8k.
674
675
676        i8k_buttons_status
677               If  running the i8k kernel driver for Inspiron laptops, displays
678               the volume buttons status as listed in /proc/i8k.
679
680
681        i8k_cpu_temp
682               If running the i8k kernel driver for Inspiron laptops,  displays
683               the cpu temperature in Celsius, as reported by /proc/i8k.
684
685
686        i8k_cpu_tempf
687               If  running the i8k kernel driver for Inspiron laptops, displays
688               the cpu temperature in Farenheit, as reported by /proc/i8k.
689
690
691        i8k_left_fan_rpm
692               If running the i8k kernel driver for Inspiron laptops,  displays
693               the  left  fan's  rate of rotation, in revolutions per minute as
694               listed in /proc/i8k. Beware, some laptops i8k reports these fans
695               in reverse order.
696
697
698        i8k_left_fan_status
699               If  running the i8k kernel driver for Inspiron laptops, displays
700               the left fan status as listed in /proc/i8k (translated to human-
701               readable).  Beware,  some  laptops i8k reports these fans in re-
702               verse order.
703
704
705        i8k_right_fan_rpm
706               If running the i8k kernel driver for Inspiron laptops,  displays
707               the  right  fan's rate of rotation, in revolutions per minute as
708               listed in /proc/i8k. Beware, some laptops i8k reports these fans
709               in reverse order.
710
711
712        i8k_right_fan_status
713               If  running the i8k kernel driver for Inspiron laptops, displays
714               the right fan status as listed in /proc/i8k (translated  to  hu-
715               man-readable).  Beware,  some  laptops i8k reports these fans in
716               reverse order.
717
718
719        i8k_serial
720               If running the i8k kernel driver for Inspiron laptops,  displays
721               your laptop serial number as listed in /proc/i8k.
722
723
724        i8k_version
725               If  running the i8k kernel driver for Inspiron laptops, displays
726               the version formatting of /proc/i8k.
727
728
729        ibm_fan
730               If running the IBM ACPI, displays the fan speed.
731
732
733        ibm_temps N
734               If running the IBM ACPI, displays the temperatures from the  IBM
735               temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
736               GPU.
737
738
739        ibm_volume
740               If running the IBM ACPI,  displays  the  "master"  volume,  con-
741               trolled by the volume keys (0-14).
742
743
744        ibm_brightness
745               If running the IBM ACPI, displays the brigtness of the laptops's
746               LCD (0-7).
747
748
749        if_running (process)
750               if PROCESS is running, display  everything  if_running  and  the
751               matching $endif
752
753
754        if_existing (file)
755               if  FILE  exists, display everything between if_existing and the
756               matching $endif
757
758
759        if_mounted (mountpoint)
760               if MOUNTPOINT is mounted, display everything between  if_mounted
761               and the matching $endif
762
763
764        imap_messages (args)
765               Displays the number of messages in your global IMAP inbox by de-
766               fault. You can define  individual  IMAP  inboxes  seperately  by
767               passing arguments to this object. Arguments are: "host user pass
768               [-i interval] [-p port] [-e command]". Default port is 110,  de-
769               fault interval is 5 minutes. If the password is supplied as '*',
770               you will be prompted to enter the password when Conky starts.
771
772
773        imap_unseen (args)
774               Displays the number of unseen messages in your global IMAP inbox
775               by default. You can define individual IMAP inboxes seperately by
776               passing arguments to this object. Arguments are: "host user pass
777               [-i  interval] [-p port] [-e command]". Default port is 110, de-
778               fault interval is 5 minutes. If the password is supplied as '*',
779               you will be prompted to enter the password when Conky starts.
780
781
782        kernel Kernel version
783
784
785        linkstatus interface
786               Get the link status for wireless connections
787
788
789        loadavg
790               (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
791               5 minutes and 3 for past 15 minutes.
792
793
794        machine
795               Machine, i686 for example
796
797
798        mails  Mail count in mail spool. You can use program like fetchmail  to
799               get  mails  from  some server using your favourite protocol. See
800               also new_mails.
801
802
803        mem    Amount of memory in use
804
805
806        membar (height),(width)
807               Bar that shows amount of memory in use
808
809
810        memmax Total amount of memory
811
812
813        memperc
814               Percentage of memory in use
815
816
817        mpd_artist
818               Artist in current MPD song must be enabled at compile
819
820
821        mpd_album
822               Album in current MPD song
823
824
825        mpd_bar (height),(width)
826               Bar of mpd's progress
827
828
829        mpd_bitrate
830               Bitrate of current song
831
832
833        mpd_status
834               Playing, stopped, et cetera.
835
836
837        mpd_title
838               Title of current MPD song
839
840
841        mpd_vol
842               MPD's volume
843
844
845        mpd_elapsed
846               Song's elapsed time
847
848
849        mpd_length
850               Song's length
851
852
853        mpd_percent
854               Percent of song's progress
855
856
857        mpd_random
858               Random status (On/Off)
859
860
861        mpd_repeat
862               Repeat status (On/Off)
863
864
865        mpd_track
866               Prints the MPD track field
867
868
869        mpd_name
870               Prints the MPD name field
871
872
873        mpd_file
874               Prints the file name of the current MPD song
875
876
877        mpd_smart
878               Prints the song name in either the form "artist - title" or file
879               name, depending on whats available
880
881
882        new_mails
883               Unread mail count in mail spool.
884
885
886        nodename
887               Hostname
888
889
890        outlinecolor (color)
891               Change outline color
892
893
894        pb_battery item
895               If running on Apple powerbook/ibook, display information on bat-
896               tery status. The item parameter specifies, what  information  to
897               display. Exactly one item must be specified. Valid items are:
898
899               status: Display if battery is fully charged, charging, discharg-
900               ing or absent (running on AC)
901               percent: Display charge of battery in percent,  if  charging  or
902               discharging.  Nothing  will  be  displayed,  if battery is fully
903               charged or absent.
904               time: Display the time remaining until the battery will be fully
905               charged  or discharged at current rate. Nothing is displayed, if
906               battery is absent or if it's present but fully charged  and  not
907               discharging.
908
909
910        pop3_unseen (args)
911               Displays the number of unseen messages in your global POP3 inbox
912               by default. You can define individual POP3 inboxes seperately by
913               passing arguments to this object. Arguments are: "host user pass
914               [-i interval] [-p port] [-e command]". Default port is 110,  de-
915               fault interval is 5 minutes. If the password is supplied as '*',
916               you will be prompted to enter the password when Conky starts.
917
918
919        pop3_used (args)
920               Displays the amount of space (in MiB, 2^20) used in your  global
921               POP3  inbox  by  default. You can define individual POP3 inboxes
922               seperately by passing arguments to this object.  Arguments  are:
923               "host  user  pass [-i interval] [-p port] [-e command]". Default
924               port is 110, default interval is 5 minutes. If the  password  is
925               supplied as '*', you will be prompted to enter the password when
926               Conky starts.
927
928
929        pre_exec shell command
930               Executes a shell command one time before conky displays anything
931               and puts output as text.
932
933
934        processes
935               Total processes (sleeping and running)
936
937
938        running_processes
939               Running processes (not sleeping), requires Linux 2.6
940
941
942        shadecolor (color)
943               Change shading color
944
945
946        stippled_hr (space)
947               Stippled (dashed) horizontal line
948
949
950        swapbar (height),(width)
951               Bar that shows amount of swap in use
952
953
954        swap   Amount of swap in use
955
956
957        swapmax
958               Total amount of swap
959
960
961        swapperc
962               Percentage of swap in use
963
964
965        sysname
966               System name, Linux for example
967
968
969        tcp_portmon port_begin port_end item (index) (ip4 only at present)
970               TCP port monitor for specified local ports. Port numbers must be
971               in the range 1 to 65535. Valid items are:
972
973               count - total number of connections in the range
974               rip - remote ip address
975               rhost - remote host name
976               rport - remote port number
977               rservice - remote service name from /etc/services
978               lip - local ip address
979               lhost - local host name
980               lport - local port number
981               lservice - local service name from /etc/services
982
983               The connection index provides you with access to each connection
984               in the port monitor. The monitor will return information for in-
985               dex values from 0 to n-1 connections. Values higher than n-1 are
986               simply  ignored. For the "count" item, the connection index must
987               be omitted. It is required for all other items.
988
989               Examples:
990               ${tcp_portmon 6881 6999 count} - displays the number of  connec-
991               tions in the bittorrent port range
992               ${tcp_portmon  22 22 rip 0} - displays the remote host ip of the
993               first sshd connection
994               ${tcp_portmon 22 22 rip 9} - displays the remote host ip of  the
995               tenth sshd connection
996               ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
997               the first connection on a privileged port
998               ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
999               the fifth connection on a privileged port
1000               ${tcp_portmon  1 65535 lservice 14} - displays the local service
1001               name of the fifteenth connection in the range of all ports
1002
1003               Note that port monitor variables which share the same port range
1004               actually refer to the same monitor, so many references to a sin-
1005               gle port range for different items and different indexes all use
1006               the  same monitor internally. In other words, the program avoids
1007               creating redundant monitors.
1008
1009        texeci interval command
1010               Runs a command at an interval inside a thread and  displays  the
1011               output.  Same  as  $execi,  except  the  command is run inside a
1012               thread. Use this if you have a slow script to keep Conky  updat-
1013               ing.  You should make the interval slightly longer then the time
1014               it takes your script to execute. For  example,  if  you  have  a
1015               script  that  take 5 seconds to execute, you should make the in-
1016               terval at least 6 seconds. See also $execi.
1017
1018
1019        offset (pixels)
1020               Move text over by N pixels. See also $voffset.
1021
1022
1023        tab (width, (start))
1024               Puts a tab of the specified width, starting from column 'start'.
1025
1026
1027        tail logfile lines (interval)
1028               Displays last N lines of supplied text text file. If interval is
1029               not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1030               can be displayed, or until the text buffer is filled.
1031
1032
1033        time (format)
1034               Local  time, see man strftime to get more information about for-
1035               mat
1036
1037
1038        utime (format)
1039               Display time in UTC (universal coordinate time).
1040
1041
1042        tztime (timezone) (format)
1043               Local time for specified timezone, see man strftime to get  more
1044               information  about format. The timezone argument is specified in
1045               similar fashion as TZ environment variable. For hints,  look  in
1046               /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1047
1048
1049        totaldown net
1050               Total  download, overflows at 4 GB on Linux with 32-bit arch and
1051               there doesn't seem to be a way to know how many times it has al-
1052               ready done that before conky has started.
1053
1054
1055        top type, num
1056               This  takes arguments in the form:top (name) (number) Basically,
1057               processes are ranked from highest to lowest in terms of cpu  us-
1058               age,  which  is  what  (num)  represents. The types are: "name",
1059               "pid", "cpu", and "mem". There can be  a  max  of  10  processes
1060               listed.
1061
1062
1063        top_mem type, num
1064               Same as top, except sorted by mem usage instead of cpu
1065
1066
1067        totalup net
1068               Total upload, this one too, may overflow
1069
1070
1071        updates Number of updates
1072               for debugging
1073
1074
1075        upspeed net
1076               Upload speed in kilobytes
1077
1078
1079        upspeedf net
1080               Upload speed in kilobytes with one decimal
1081
1082
1083        upspeedgraph  net (height),(width) (gradient colour 1) (gradient colour
1084        2) (scale)
1085               Upload  speed  graph,  colours  defined  in hex, minus the #. If
1086               scale is non-zero, it becomes the scale for the graph.
1087
1088
1089        uptime Uptime
1090
1091
1092        uptime_short
1093               Uptime in a shorter format
1094
1095
1096        voffset (pixels)
1097               Change vertical offset by N pixels. Negative values  will  cause
1098               text to overlap. See also $offset.
1099
1100
1101        voltage_mv (n)
1102               Returns  CPU  #n's  voltage  in  mV. CPUs are counted from 1. If
1103               omitted, the parameter defaults to 1.
1104
1105
1106        voltage_v (n)
1107               Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1108               ted, the parameter defaults to 1.
1109
1110
1111 EXAMPLES
1112        conky -t '${time %D %H:%m}' -o -u 30
1113               Start Conky in its own window with date and clock as text and 30
1114               sec update interval.
1115
1116        conky -a top_left -x 5 -y 500 -d
1117               Start Conky to background at coordinates (5, 500).
1118
1119 FILES
1120        ~/.conkyrc default configuration file
1121
1122 BUGS
1123        Drawing to root or some other desktop window directly doesn't work with
1124        all window managers. Especially doesn't work well with Gnome and it has
1125        been reported that it doesn't work with KDE  either.  Nautilus  can  be
1126        disabled  from  drawing  to  desktop with program gconf-editor. Uncheck
1127        show_desktop in /apps/nautilus/preferences/.  There  is  -w  switch  in
1128        Conky  to  set  some  specific window id. You might find xwininfo -tree
1129        useful to find the window to draw to. You  can  also  use  -o  argument
1130        which makes Conky to create its own window.
1131
1132 SEE ALSO
1133        <http://conky.sourceforge.net>
1134
1135        <http://www.sourceforge.net/projects/conky>
1136
1137        #conky on irc.freenode.net
1138
1139 AUTHORS
1140        The Conky dev team. What's up now!
1141
1142
1143
1144                                   2006-05-13                          conky(1)