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