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