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