* Applied 2 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 --disable-own-window --enable-audacious[=yes|no|lega-
47        cy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis-
48        able-portmon  --disable-network  --enable-debug  --disable-x11   --dis-
49        able-double-buffer --disable-xdamage --disable-xft
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 | --verbose
89               Prints version and exits
90
91
92        -a | --alignment=ALIGNMENT
93               Text alignment on screen, {top,bottom}_{left,right} or none
94
95
96        -b | --double-buffer
97               Use double buffering (eliminates "flicker")
98
99
100        -c | --config=FILE
101               Config file to load instead of $HOME/.conkyrc
102
103
104        -d | --daemonize
105               Daemonize Conky, aka fork to background
106
107
108        -f | --font=FONT
109               Font to use
110
111
112        -h | --help
113               Prints command line help and exits
114
115
116        -o | --own-window
117               Create own window to draw
118
119
120        -t | --text=TEXT
121               Text to render, remember single quotes, like -t ' $uptime '
122
123
124        -u | --interval=SECONDS
125               Update interval
126
127
128        -w | --window-id=WIN_ID
129               Window id to draw
130
131
132        -x X_COORDINATE
133               X position
134
135
136        -y Y_COORDINATE
137               Y position
138
139
140 CONFIGURATION SETTINGS
141        Default configuration file  is  $HOME/.conkyrc  (can  be  changed  from
142        conky.c among other things). See conkyrc.sample. If installing from De-
143        bian package, this should be in /usr/share/doc/conky/examples  ("gunzip
144        conkyrc.sample.gz" to get conkyrc.sample).
145
146        You  might  want  to copy it to $HOME/.conkyrc and then start modifying
147        it.  Other configs can be found at http://conky.sf.net
148
149        alignment
150               Aligned position on screen, may  be  top_left,  top_right,  bot-
151               tom_left, bottom_right, or none
152
153
154        background
155               Boolean  value, if true, Conky will be forked to background when
156               started
157
158
159        border_margin
160               Border margin in pixels
161
162
163        border_width
164               Border width in pixels
165
166
167        color0 A color variable for use inside TEXT segments
168
169
170        color1 A color variable for use inside TEXT segments
171
172
173        color2 A color variable for use inside TEXT segments
174
175
176        color3 A color variable for use inside TEXT segments
177
178
179        color4 A color variable for use inside TEXT segments
180
181
182        color5 A color variable for use inside TEXT segments
183
184
185        color6 A color variable for use inside TEXT segments
186
187
188        color7 A color variable for use inside TEXT segments
189
190
191        color8 A color variable for use inside TEXT segments
192
193
194        color9 A color variable for use inside TEXT segments
195
196
197        cpu_avg_samples
198               The number of samples to average for CPU monitoring
199
200
201        top_cpu_separate
202               If true, cpu in top will show usage of one processor's power. If
203               false,  cpu  in top will show the usage of all processors' power
204               combined.
205
206
207        default_color
208               Default color and border color
209
210
211        default_outline_color
212               Default outline color
213
214
215        default_shade_color
216               Default shading color and border's shading color
217
218
219        double_buffer
220               Use the Xdbe extension? (eliminates flicker) It is highly recom-
221               mended to use own window with this one so double buffer won't be
222               so big.
223
224
225        draw_borders
226               Draw borders around text?
227
228
229        draw_graph_borders
230               Draw borders around graphs?
231
232
233        draw_outline
234               Draw outlines?
235
236
237        draw_shades
238               Draw shades?
239
240
241        font   Font name in X, xfontsel can be used to get a nice font
242
243
244        gap_x  Gap, in pixels, between right or left border of screen, same  as
245               passing -x at command line, e.g. gap_x 10
246
247
248        gap_y  Gap,  in pixels, between top or bottom border of screen, same as
249               passing -y at command line, e.g. gap_y 10.
250
251
252        imap   Default global IMAP server. Arguments are: "host user  pass  [-i
253               interval]  [-f  folder] [-p port] [-e command]". Default port is
254               143, default folder is 'INBOX', default interval is  5  minutes.
255               If  the password is supplied as '*', you will be prompted to en-
256               ter the password when Conky starts.
257
258
259        mail_spool
260               Mail spool for mail checking
261
262
263        max_port_monitor_connections
264               Allow each port monitor to track at most this  many  connections
265               (if 0 or not set, default is 256)
266
267
268        max_specials
269               Maximum  number  of special things, e.g. fonts, offsets, aligns,
270               etc. (default is 512)
271
272
273        max_user_text bytes
274               Maximum size of user text buffer, i.e. layout below TEXT line in
275               config file (default is 16384 bytes)
276
277
278        text_buffer_size bytes
279               Size of the standard text buffer (default is 1280 bytes).
280
281
282        maximum_width pixels
283               Maximum width of window
284
285
286        minimum_size width (height)
287               Minimum size of window
288
289
290        mpd_host
291               Host of MPD server
292
293
294        mpd_port
295               Port of MPD server
296
297
298        mpd_password
299               MPD server password
300
301
302        music_player_interval
303               Music  player thread update interval (defaults to Conky's update
304               interval)
305
306
307        net_avg_samples
308               The number of samples to average for net data
309
310
311        no_buffers
312               Substract (file system) buffers from used memory?
313
314
315        override_utf8_locale
316               Force UTF8? requires XFT
317
318
319        own_window
320               Boolean, create own window to draw?
321
322
323        own_window_class
324               Manually set the WM_CLASS name. Defaults to "Conky".
325
326
327        own_window_colour colour
328               If own_window_transparent no, set a specified background  colour
329               (defaults  to  black).  Takes  either a hex value (#ffffff) or a
330               valid RGB name (see /usr/lib/X11/rgb.txt)
331
332
333        own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
334               If own_window is yes, you may use these window manager hints  to
335               affect the way Conky displays.  Notes: Use own_window_type desk-
336               top as another way to implement many of these hints  implicitly.
337               If  you  use own_window_type override, window manager hints have
338               no meaning and are ignored.
339
340
341        own_window_title
342               Manually set the window name. Defaults to "<hostname> -  conky".
343
344
345        own_window_transparent
346               Boolean, set pseudo-transparency?
347
348
349        own_window_type
350               if  own_window  is  yes, you may specify type normal, desktop or
351               override (default: normal).  Desktop windows are special windows
352               that  have  no  window  decorations;  are always visible on your
353               desktop; do not appear in your pager or taskbar; and are  sticky
354               across  all workspaces.  Override windows are not under the con-
355               trol of the window manager. Hints are ignored. This type of win-
356               dow can be useful for certain situations.
357
358
359        out_to_console
360               Print text to stdout.
361
362
363        pad_percents
364               Pad percentages to this many decimals (0 = no padding)
365
366
367        pop3   Default  global  POP3 server. Arguments are: "host user pass [-i
368               interval] [-p port] [-e command]". Default port is 110,  default
369               interval  is  5 minutes. If the password is supplied as '*', you
370               will be prompted to enter the password when Conky starts.
371
372
373        short_units
374               Shortens units to a single character (kiB->k, GiB->G, etc.). De-
375               fault is off.
376
377
378        stippled_borders
379               Border stippling (dashing) in pixels
380
381
382        total_run_times
383               Total  number of times for Conky to update before quitting. Zero
384               makes Conky run forever
385
386
387        update_interval
388               Update interval in seconds
389
390
391        uppercase
392               Boolean value, if true, text is rendered in upper case
393
394
395        use_spacer
396               Adds spaces around certain objects to stop them from moving oth-
397               er things around. Arguments are left, right, and none (default).
398               The  old  true/false  values  are  deprecated  and  default   to
399               right/none  respectively.  Note  that this only helps if you are
400               using a mono font, such as Bitstream Vera Sans Mono.
401
402
403        use_xft
404               Use Xft (anti-aliased font and stuff)
405
406
407        xftalpha
408               Alpha of Xft font. Must be a value at or between 1 and 0.
409
410
411        xftfont
412               Xft font to use.
413
414
415        TEXT   After this begins text to be formatted on screen
416
417
418 VARIABLES
419        Colors are parsed using XParsecolor(), there might be a list  of  them:
420        /usr/X11R6/lib/X11/rgb.txt.  Also, <http://sedition.com/perl/rgb.html>.
421        Color can be also in #rrggbb format (hex).  Note that  when  displaying
422        bytes,  power  is  1024 and not 1000 so 1M really means 1024*1024 bytes
423        and not 1000*1000.
424
425        addr interface
426               IP address for an interface
427
428
429        acpiacadapter
430               ACPI ac adapter state.
431
432
433        acpifan
434               ACPI fan state
435
436
437        acpitemp
438               ACPI temperature in C.
439
440
441        acpitempf
442               ACPI temperature in F.
443
444
445        adt746xcpu
446               CPU temperature from therm_adt746x
447
448
449        adt746xfan
450               Fan speed from therm_adt746x
451
452
453        alignr (num)
454               Right-justify text, with space of N
455
456
457        alignc (num)
458               Align text to centre
459
460
461        apm_adapter
462               Display APM AC adapter status (FreeBSD only)
463
464
465        apm_battery_life
466               Display APM battery life in percent (FreeBSD only)
467
468
469        apm_battery_time
470               Display remaining APM battery life in hh:mm:ss or  "unknown"  if
471               AC adapterstatus is on-line or charging (FreeBSD only)
472
473
474        audacious_bar (height),(width)
475               Progress bar
476
477
478        audacious_bitrate
479               Bitrate of current tune
480
481
482        audacious_channels
483               Number of audio channels of current tune
484
485
486        audacious_filename
487               Full path and filename of current tune
488
489
490        audacious_frequency
491               Sampling frequency of current tune
492
493
494        audacious_length
495               Total length of current tune as MM:SS
496
497
498        audacious_length_seconds
499               Total length of current tune in seconds
500
501
502        audacious_playlist_position
503               Playlist position of current tune
504
505
506        audacious_playlist_length
507               Number of tunes in playlist
508
509
510        audacious_position
511               Position of current tune (MM:SS)
512
513
514        audacious_position_seconds
515               Position of current tune in seconds
516
517
518        audacious_status
519               Player status (Playing/Paused/Stopped/Not running)
520
521
522        audacious_title (max length)
523               Title of current tune with optional maximum length specifier
524
525
526        battery (num)
527               Battery  status and remaining percentage capacity of ACPI or APM
528               battery. ACPI battery number can be given as  argument  (default
529               is BAT0).
530
531
532        battery_bar (height),(width) (num)
533               Battery percentage remaining of ACPI battery in a bar. ACPI bat-
534               tery number can be given as argument (default is BAT0).
535
536
537        battery_percent (num)
538               Battery percentage remaining for ACPI battery. ACPI battery num-
539               ber can be given as argument (default is BAT0).
540
541
542        battery_time (num)
543               Battery  charge/discharge  time  remaining of ACPI battery. ACPI
544               battery number can be given as argument (default is BAT0).
545
546
547        bmpx_artist
548               Artist in current BMPx track
549
550
551        bmpx_album
552               Album in current BMPx track
553
554
555        bmpx_title
556               Title of the current BMPx track
557
558
559        bmpx_track
560               Track number of the current BMPx track
561
562
563        bmpx_bitrate
564               Bitrate of the current BMPx track
565
566
567        bmpx_uri
568               URI of the current BMPx track
569
570
571        buffers
572               Amount of memory buffered
573
574
575        cached Amount of memory cached
576
577
578        color (color)
579               Change drawing color to color
580
581
582        color0 Change drawing color to color0 configuration option
583
584
585        color1 Change drawing color to color1 configuration option
586
587
588        color2 Change drawing color to color2 configuration option
589
590
591        color3 Change drawing color to color3 configuration option
592
593
594        color4 Change drawing color to color4 configuration option
595
596
597        color5 Change drawing color to color5 configuration option
598
599
600        color6 Change drawing color to color6 configuration option
601
602
603        color7 Change drawing color to color7 configuration option
604
605
606        color8 Change drawing color to color8 configuration option
607
608
609        color9 Change drawing color to color9 configuration option
610
611
612        cpu (cpuN)
613               CPU usage in percents. For SMP machines, the CPU number  can  be
614               provided  as  an  argument.  ${cpu cpu0} is the total usage, and
615               ${cpu cpuX} (X >= 1) are individual CPUs.
616
617
618        cpubar (cpu number) (height),(width)
619               Bar that shows CPU usage, height is bar's height in pixels.  See
620               $cpu for more info on SMP.
621
622
623        cpugraph  (cpu  number)  (height),(width) (gradient colour 1) (gradient
624        colour 2)
625               CPU  usage graph, with optional colours in hex, minus the #. See
626               $cpu for more info on SMP.
627
628
629        diskio (device)
630               Displays current disk IO. Device is optional, and takes the form
631               of sda for /dev/sda. Individual partitions are allowed.
632
633
634        diskiograph  (device)  (height),(width)  (gradient  colour 1) (gradient
635        colour 2) (scale)
636               Disk  IO graph, colours defined in hex, minus the #. If scale is
637               non-zero, it becomes the scale for the graph.
638
639
640        diskio_read (device)
641               Displays current disk IO for reads. Device as in diskio.
642
643
644        diskiograph_read (device) (height),(width) (gradient colour 1)  (gradi-
645        ent colour 2) (scale)
646               Disk IO graph for reads, colours defined in hex, minus the #. If
647               scale is non-zero, it becomes the scale for the graph. Device as
648               in diskio.
649
650
651        diskio_write (device)
652               Displays current disk IO for writes. Device as in diskio.
653
654
655        diskiograph_write (device) (height),(width) (gradient colour 1) (gradi-
656        ent colour 2) (scale)
657               Disk IO graph for writes, colours defined in hex, minus  the  #.
658               If scale is non-zero, it becomes the scale for the graph. Device
659               as in diskio.
660
661
662        downspeed net
663               Download speed in kilobytes
664
665
666        downspeedf net
667               Download speed in kilobytes with one decimal
668
669
670        downspeedgraph  net  (height),(width)  (gradient  colour  1)  (gradient
671        colour 2) (scale)
672               Download speed graph, colours defined in hex, minus  the  #.  If
673               scale is non-zero, it becomes the scale for the graph.
674
675
676        else   Text to show if any of the above are not true
677
678
679        entropy_avail
680               Current entropy available for crypto freaks
681
682
683        entropy_bar (height),(width)
684               Normalized bar of available entropy for crypto freaks
685
686
687        entropy_poolsize
688               Total size of system entropy pool for crypto freaks
689
690
691        exec command
692               Executes a shell command and displays the output in conky. warn-
693               ing: this takes a lot more resources than other  variables.  I'd
694               recommend coding wanted behaviour in C and posting a patch.
695
696
697        execbar command
698               Same  as  exec,  except if the first value return is a value be-
699               tween 0-100, it will use that number for a bar. The size for the
700               bar is currently fixed, but that may change in the future.
701
702
703        execgraph command
704               Same as execbar, but graphs values.
705
706
707        execi interval command
708               Same  as exec but with specific interval. Interval can't be less
709               than update_interval in configuration. See also $texeci
710
711
712        execibar interval command
713               Same as execbar, except with an interval
714
715
716        execigraph interval command
717               Same as execigraph, but takes an interval arg graphs values
718
719
720        font (font)
721               Specify a different font. This new font will apply to  the  cur-
722               rent  line and everything following. You can use a $font with no
723               arguments to change back to the default  font  (much  like  with
724               $color)
725
726
727        freq (n)
728               Returns  CPU  #n's frequency in MHz. CPUs are counted from 1. If
729               omitted, the parameter defaults to 1.
730
731
732        freq_g (n)
733               Returns CPU #n's frequency in GHz. CPUs are counted from  1.  If
734               omitted, the parameter defaults to 1.
735
736
737        freq_dyn
738               Returns  CPU  frequency in MHz, but is calculated by counting to
739               clock cycles to complete  an  instruction.  Only  available  for
740               x86/amd64.
741
742
743        freq_dyn_g
744               Returns  CPU  frequency in GHz, but is calculated by counting to
745               clock cycles to complete  an  instruction.  Only  available  for
746               x86/amd64.
747
748
749        fs_bar (height),(width) fs
750               Bar  that  shows how much space is used on a file system. height
751               is the height in pixels. fs is any file on that file system.
752
753
754        fs_free (fs)
755               Free space on a file system available for users.
756
757
758        fs_free_perc (fs)
759               Free percentage of space on a file system available for users.
760
761
762        fs_size (fs)
763               File system size
764
765
766        fs_used (fs)
767               File system used space
768
769
770        goto x The next element will be printed at position 'x'.
771
772
773        hddtemp dev, (host,(port))
774               Displays temperature of a selected hard disk drive  as  reported
775               by  the  hddtemp  daemon  running on host:port.  Default host is
776               127.0.0.1, default port is 7634.
777
778
779        head logfile lines (interval)
780               Displays first N lines of supplied text text file.  If  interval
781               is  not  supplied,  Conky assumes 2x Conky's interval. Max of 30
782               lines can be displayed, or until the text buffer is filled.
783
784
785        hr (height)
786               Horizontal line, height is the height in pixels
787
788
789        hwmon (dev) type n
790               Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be  omit-
791               ted  if you have only one hwmon device. Parameter type is either
792               'in' or 'vol' meaning voltage; 'fan' meaning fan;  'temp'  (Cel-
793               sius)  or  'tempf' (Fahrenheit) meaning temperature. Parameter n
794               is number of the sensor. See  /sys/class/hwmon/  on  your  local
795               computer.
796
797
798        iconv_start codeset_from codeset_to
799               Convert  text from one codeset to another using GNU iconv. Needs
800               to be stopped with iconv_stop.
801
802
803        iconv_stop
804               Stop iconv codeset conversion.
805
806
807        i2c (dev) type n
808               I2C sensor from sysfs (Linux 2.6). Parameter dev may be  omitted
809               if  you  have only one I2C device. Parameter type is either 'in'
810               or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or
811               'tempf'  (Fahrenheit) meaning temperature. Parameter n is number
812               of the sensor. See /sys/bus/i2c/devices/ on your local computer.
813
814
815        i8k_ac_status
816               If  running the i8k kernel driver for Inspiron laptops, displays
817               whether ac power is on, as listed in  /proc/i8k  (translated  to
818               human-readable).  Beware  that this is by default not enabled by
819               i8k itself.
820
821
822        i8k_bios
823               If running the i8k kernel driver for Inspiron laptops,  displays
824               the bios version as listed in /proc/i8k.
825
826
827        i8k_buttons_status
828               If  running the i8k kernel driver for Inspiron laptops, displays
829               the volume buttons status as listed in /proc/i8k.
830
831
832        i8k_cpu_temp
833               If running the i8k kernel driver for Inspiron laptops,  displays
834               the cpu temperature in Celsius, as reported by /proc/i8k.
835
836
837        i8k_cpu_tempf
838               If  running the i8k kernel driver for Inspiron laptops, displays
839               the cpu temperature in Fahrenheit, as reported by /proc/i8k.
840
841
842        i8k_left_fan_rpm
843               If running the i8k kernel driver for Inspiron laptops,  displays
844               the  left  fan's  rate of rotation, in revolutions per minute as
845               listed in /proc/i8k. Beware, some laptops i8k reports these fans
846               in reverse order.
847
848
849        i8k_left_fan_status
850               If  running the i8k kernel driver for Inspiron laptops, displays
851               the left fan status as listed in /proc/i8k (translated to human-
852               readable).  Beware,  some  laptops i8k reports these fans in re-
853               verse order.
854
855
856        i8k_right_fan_rpm
857               If running the i8k kernel driver for Inspiron laptops,  displays
858               the  right  fan's rate of rotation, in revolutions per minute as
859               listed in /proc/i8k. Beware, some laptops i8k reports these fans
860               in reverse order.
861
862
863        i8k_right_fan_status
864               If  running the i8k kernel driver for Inspiron laptops, displays
865               the right fan status as listed in /proc/i8k (translated  to  hu-
866               man-readable).  Beware,  some  laptops i8k reports these fans in
867               reverse order.
868
869
870        i8k_serial
871               If running the i8k kernel driver for Inspiron laptops,  displays
872               your laptop serial number as listed in /proc/i8k.
873
874
875        i8k_version
876               If  running the i8k kernel driver for Inspiron laptops, displays
877               the version formatting of /proc/i8k.
878
879
880        ibm_fan
881               If running the IBM ACPI, displays the fan speed.
882
883
884        ibm_temps N
885               If running the IBM ACPI, displays the temperatures from the  IBM
886               temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
887               GPU.
888
889
890        ibm_volume
891               If running the IBM ACPI,  displays  the  "master"  volume,  con-
892               trolled by the volume keys (0-14).
893
894
895        ibm_brightness
896               If running the IBM ACPI, displays the brigtness of the laptops's
897               LCD (0-7).
898
899
900        if_empty (var)
901               if conky variable  VAR  is  empty,  display  everything  between
902               $if_empty and the matching $endif
903
904
905        if_running (process)
906               if  PROCESS  is  running, display everything $if_running and the
907               matching $endif
908
909
910        if_existing file (string)
911               if FILE exists, display everything between if_existing  and  the
912               matching  $endif.  The optional second paramater checks for FILE
913               containing the specified string and  prints  everything  between
914               $if_existing and the matching $endif.
915
916
917        if_mounted (mountpoint)
918               if MOUNTPOINT is mounted, display everything between $if_mounted
919               and the matching $endif
920
921
922        imap_messages (args)
923               Displays the number of messages in your global IMAP inbox by de-
924               fault.  You  can  define  individual  IMAP inboxes seperately by
925               passing arguments to this object. Arguments are: "host user pass
926               [-i  interval] [-p port] [-e command]". Default port is 143, de-
927               fault interval is 5 minutes. If the password is supplied as '*',
928               you will be prompted to enter the password when Conky starts.
929
930
931        imap_unseen (args)
932               Displays the number of unseen messages in your global IMAP inbox
933               by default. You can define individual IMAP inboxes seperately by
934               passing arguments to this object. Arguments are: "host user pass
935               [-i interval] [-p port] [-e command]". Default port is 143,  de-
936               fault interval is 5 minutes. If the password is supplied as '*',
937               you will be prompted to enter the password when Conky starts.
938
939
940        kernel Kernel version
941
942
943        loadavg
944               (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
945               5 minutes and 3 for past 15 minutes.
946
947
948        machine
949               Machine, i686 for example
950
951
952        mails (mailbox) (interval)
953               Mail  count  in the specified mailbox or your mail spool if not.
954               Both mbox and maildir type mailboxes are supported. You can  use
955               a  program  like  fetchmail  to get mails from some server using
956               your favourite protocol. See also new_mails.
957
958
959        mboxscan (-n number of messages to print) (-fw from width) (-sw subject
960        width) mbox
961               Print a summary of recent messages in an  mbox  format  mailbox.
962               mbox  parameter  is the filename of the mailbox (can be encapsu-
963               lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
964
965
966        mem    Amount of memory in use
967
968
969        membar (height),(width)
970               Bar that shows amount of memory in use
971
972
973        memmax Total amount of memory
974
975
976        memperc
977               Percentage of memory in use
978
979
980        mpd_artist
981               Artist in current MPD song must be enabled at compile
982
983
984        mpd_album
985               Album in current MPD song
986
987
988        mpd_bar (height),(width)
989               Bar of mpd's progress
990
991
992        mpd_bitrate
993               Bitrate of current song
994
995
996        mpd_status
997               Playing, stopped, et cetera.
998
999
1000        mpd_title (max length)
1001               Title of current MPD song
1002
1003
1004        mpd_vol
1005               MPD's volume
1006
1007
1008        mpd_elapsed
1009               Song's elapsed time
1010
1011
1012        mpd_length
1013               Song's length
1014
1015
1016        mpd_percent
1017               Percent of song's progress
1018
1019
1020        mpd_random
1021               Random status (On/Off)
1022
1023
1024        mpd_repeat
1025               Repeat status (On/Off)
1026
1027
1028        mpd_track
1029               Prints the MPD track field
1030
1031
1032        mpd_name
1033               Prints the MPD name field
1034
1035
1036        mpd_file
1037               Prints the file name of the current MPD song
1038
1039
1040        mpd_smart
1041               Prints the song name in either the form "artist - title" or file
1042               name, depending on whats available
1043
1044
1045        new_mails (mailbox) (interval)
1046               Unread mail count in the specified mailbox or mail spool if not.
1047               Both mbox and maildir type mailboxes are supported.
1048
1049
1050        nodename
1051               Hostname
1052
1053
1054        outlinecolor (color)
1055               Change outline color
1056
1057
1058        pb_battery item
1059               If running on Apple powerbook/ibook, display information on bat-
1060               tery  status.  The item parameter specifies, what information to
1061               display. Exactly one item must be specified. Valid items are:
1062
1063               status: Display if battery is fully charged, charging, discharg-
1064               ing or absent (running on AC)
1065               percent:  Display  charge  of battery in percent, if charging or
1066               discharging. Nothing will be  displayed,  if  battery  is  fully
1067               charged or absent.
1068               time: Display the time remaining until the battery will be fully
1069               charged or discharged at current rate. Nothing is displayed,  if
1070               battery  is  absent or if it's present but fully charged and not
1071               discharging.
1072
1073
1074        platform (dev) type n
1075               Platform sensor from sysfs (Linux 2.6).  Parameter  dev  may  be
1076               omitted  if  you have only one platform device. Platform type is
1077               either 'in' or 'vol' meaning voltage; 'fan' meaning fan;  'temp'
1078               (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter
1079               n is number of the  sensor.  See  /sys/bus/platform/devices/  on
1080               your local computer.
1081
1082
1083        pop3_unseen (args)
1084               Displays the number of unseen messages in your global POP3 inbox
1085               by default. You can define individual POP3 inboxes seperately by
1086               passing arguments to this object. Arguments are: "host user pass
1087               [-i interval] [-p port] [-e command]". Default port is 110,  de-
1088               fault interval is 5 minutes. If the password is supplied as '*',
1089               you will be prompted to enter the password when Conky starts.
1090
1091
1092        pop3_used (args)
1093               Displays the amount of space (in MiB, 2^20) used in your  global
1094               POP3  inbox  by  default. You can define individual POP3 inboxes
1095               seperately by passing arguments to this object.  Arguments  are:
1096               "host  user  pass [-i interval] [-p port] [-e command]". Default
1097               port is 110, default interval is 5 minutes. If the  password  is
1098               supplied as '*', you will be prompted to enter the password when
1099               Conky starts.
1100
1101
1102        pre_exec shell command
1103               Executes a shell command one time before conky displays anything
1104               and puts output as text.
1105
1106
1107        processes
1108               Total processes (sleeping and running)
1109
1110
1111        running_processes
1112               Running processes (not sleeping), requires Linux 2.6
1113
1114
1115        shadecolor (color)
1116               Change shading color
1117
1118
1119        stippled_hr (space)
1120               Stippled (dashed) horizontal line
1121
1122
1123        swapbar (height),(width)
1124               Bar that shows amount of swap in use
1125
1126
1127        swap   Amount of swap in use
1128
1129
1130        swapmax
1131               Total amount of swap
1132
1133
1134        swapperc
1135               Percentage of swap in use
1136
1137
1138        sysname
1139               System name, Linux for example
1140
1141
1142        tcp_portmon port_begin port_end item (index) (ip4 only at present)
1143               TCP port monitor for specified local ports. Port numbers must be
1144               in the range 1 to 65535. Valid items are:
1145
1146               count - total number of connections in the range
1147               rip - remote ip address
1148               rhost - remote host name
1149               rport - remote port number
1150               rservice - remote service name from /etc/services
1151               lip - local ip address
1152               lhost - local host name
1153               lport - local port number
1154               lservice - local service name from /etc/services
1155
1156               The connection index provides you with access to each connection
1157               in the port monitor. The monitor will return information for in-
1158               dex values from 0 to n-1 connections. Values higher than n-1 are
1159               simply  ignored. For the "count" item, the connection index must
1160               be omitted. It is required for all other items.
1161
1162               Examples:
1163               ${tcp_portmon 6881 6999 count} - displays the number of  connec-
1164               tions in the bittorrent port range
1165               ${tcp_portmon  22 22 rip 0} - displays the remote host ip of the
1166               first sshd connection
1167               ${tcp_portmon 22 22 rip 9} - displays the remote host ip of  the
1168               tenth sshd connection
1169               ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1170               the first connection on a privileged port
1171               ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1172               the fifth connection on a privileged port
1173               ${tcp_portmon  1 65535 lservice 14} - displays the local service
1174               name of the fifteenth connection in the range of all ports
1175
1176               Note that port monitor variables which share the same port range
1177               actually refer to the same monitor, so many references to a sin-
1178               gle port range for different items and different indexes all use
1179               the  same monitor internally. In other words, the program avoids
1180               creating redundant monitors.
1181
1182        texeci interval command
1183               Runs a command at an interval inside a thread and  displays  the
1184               output.  Same  as  $execi,  except  the  command is run inside a
1185               thread. Use this if you have a slow script to keep Conky  updat-
1186               ing.  You should make the interval slightly longer then the time
1187               it takes your script to execute. For  example,  if  you  have  a
1188               script  that  take 5 seconds to execute, you should make the in-
1189               terval at least 6 seconds. See also $execi.
1190
1191
1192        offset (pixels)
1193               Move text over by N pixels. See also $voffset.
1194
1195
1196        rss url delay_in_minutes action item_num
1197               Download and parse RSS feeds. Action may be one of  the  follow-
1198               ing:  feed_title, item_title (with num par), item_desc (with num
1199               par) and item_titles.
1200
1201
1202        tab (width, (start))
1203               Puts a tab of the specified width, starting from column 'start'.
1204
1205
1206        tail logfile lines (interval)
1207               Displays last N lines of supplied text text file. If interval is
1208               not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1209               can be displayed, or until the text buffer is filled.
1210
1211
1212        time (format)
1213               Local  time, see man strftime to get more information about for-
1214               mat
1215
1216
1217        utime (format)
1218               Display time in UTC (universal coordinate time).
1219
1220
1221        tztime (timezone) (format)
1222               Local time for specified timezone, see man strftime to get  more
1223               information  about format. The timezone argument is specified in
1224               similar fashion as TZ environment variable. For hints,  look  in
1225               /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1226
1227
1228        totaldown net
1229               Total  download, overflows at 4 GB on Linux with 32-bit arch and
1230               there doesn't seem to be a way to know how many times it has al-
1231               ready done that before conky has started.
1232
1233
1234        top type, num
1235               This  takes arguments in the form:top (name) (number) Basically,
1236               processes are ranked from highest to lowest in terms of cpu  us-
1237               age,  which  is  what  (num)  represents. The types are: "name",
1238               "pid", "cpu", "mem", and "time". There can be a max of  10  pro-
1239               cesses listed.
1240
1241
1242        top_mem type, num
1243               Same as top, except sorted by mem usage instead of cpu
1244
1245
1246        totalup net
1247               Total upload, this one too, may overflow
1248
1249
1250        updates Number of updates
1251               for debugging
1252
1253
1254        upspeed net
1255               Upload speed in kilobytes
1256
1257
1258        upspeedf net
1259               Upload speed in kilobytes with one decimal
1260
1261
1262        upspeedgraph  net (height),(width) (gradient colour 1) (gradient colour
1263        2) (scale)
1264               Upload  speed  graph,  colours  defined  in hex, minus the #. If
1265               scale is non-zero, it becomes the scale for the graph.
1266
1267
1268        uptime Uptime
1269
1270
1271        uptime_short
1272               Uptime in a shorter format
1273
1274
1275        voffset (pixels)
1276               Change vertical offset by N pixels. Negative values  will  cause
1277               text to overlap. See also $offset.
1278
1279
1280        voltage_mv (n)
1281               Returns  CPU  #n's  voltage  in  mV. CPUs are counted from 1. If
1282               omitted, the parameter defaults to 1.
1283
1284
1285        voltage_v (n)
1286               Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1287               ted, the parameter defaults to 1.
1288
1289
1290        wireless_essid net
1291               Wireless access point ESSID (Linux only)
1292
1293
1294        wireless_mode net
1295               Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1296
1297
1298        wireless_bitrate net
1299               Wireless bitrate (ie 11 Mb/s) (Linux only)
1300
1301
1302        wireless_ap net
1303               Wireless access point MAC address (Linux only)
1304
1305
1306        wireless_link_qual net
1307               Wireless link quality (Linux only)
1308
1309
1310        wireless_link_qual_max net
1311               Wireless link quality maximum value (Linux only)
1312
1313
1314        wireless_link_qual_perc net
1315               Wireless link quality in percents (Linux only)
1316
1317
1318        wireless_link_bar (height), (width) net
1319               Wireless link quality bar (Linux only)
1320
1321
1322        xmms2_artist
1323               Artist in current XMMS2 song
1324
1325
1326        xmms2_album
1327               Album in current XMMS2 song
1328
1329
1330        xmms2_title
1331               Title in current XMMS2 song
1332
1333
1334        xmms2_genre
1335               Genre in current XMMS2 song
1336
1337
1338        xmms2_comment
1339               Comment in current XMMS2 song
1340
1341
1342        xmms2_decoder
1343               Decoder plugin used
1344
1345
1346        xmms2_transport
1347               Transport plugin used
1348
1349
1350        xmms2_url
1351               Full path to current song
1352
1353
1354        xmms2_tracknr
1355               Track number in current XMMS2 song
1356
1357
1358        xmms2_bitrate
1359               Bitrate of current song
1360
1361
1362        xmms2_id
1363               XMMS2 id of current song
1364
1365
1366        xmms2_duration
1367               Duration of current song
1368
1369
1370        xmms2_elapsed
1371               Song's elapsed time
1372
1373
1374        xmms2_size
1375               Size of current song
1376
1377
1378        xmms2_percent
1379               Percent of song's progress
1380
1381
1382        xmms2_status
1383               XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1384
1385
1386        xmms2_bar (height),(width)
1387               Bar of XMMS2's progress
1388
1389
1390        xmms2_smart
1391               Prints the song name in either the form "artist - title" or file
1392               name, depending on whats available
1393
1394
1395 EXAMPLES
1396        conky -t '${time %D %H:%M}' -o -u 30
1397               Start Conky in its own window with date and clock as text and 30
1398               sec update interval.
1399
1400        conky -a top_left -x 5 -y 500 -d
1401               Start Conky to background at coordinates (5, 500).
1402
1403 FILES
1404        ~/.conkyrc default configuration file
1405
1406 BUGS
1407        Drawing to root or some other desktop window directly doesn't work with
1408        all window managers. Especially doesn't work well with Gnome and it has
1409        been  reported  that  it  doesn't work with KDE either. Nautilus can be
1410        disabled from drawing to desktop  with  program  gconf-editor.  Uncheck
1411        show_desktop  in  /apps/nautilus/preferences/.  There  is  -w switch in
1412        Conky to set some specific window id. You  might  find  xwininfo  -tree
1413        useful  to  find  the  window  to draw to. You can also use -o argument
1414        which makes Conky to create its own window.
1415
1416 SEE ALSO
1417        <http://conky.sourceforge.net>
1418
1419        <http://www.sourceforge.net/projects/conky>
1420
1421        #conky on irc.freenode.net
1422
1423 AUTHORS
1424        The Conky dev team. What's up now!
1425
1426
1427
1428                                   2007-08-08                          conky(1)