vcs.maemo.org Git - monky/blob - doc/variables.xml

   1 <variablelist>
   2 <varlistentry>
   3         <term>
   4                 <command><option>addr</option></command>
   5         <option>interface</option>
   6         </term>
   7         <listitem>
   8                 IP address for an interface
   9         <para></para></listitem>
  10 </varlistentry>
  11
  12 <varlistentry>
  13         <term>
  14                 <command><option>acpiacadapter</option></command>
  15         </term>
  16         <listitem>
  17                 ACPI ac adapter state.
  18         <para></para></listitem>
  19 </varlistentry>
  20
  21 <varlistentry>
  22         <term>
  23                 <command><option>acpifan</option></command>
  24         </term>
  25         <listitem>
  26                 ACPI fan state
  27         <para></para></listitem>
  28 </varlistentry>
  29
  30 <varlistentry>
  31         <term>
  32                 <command><option>acpitemp</option></command>
  33         </term>
  34         <listitem>
  35                 ACPI temperature in C.
  36                 <para></para></listitem>
  37 </varlistentry>
  38
  39 <varlistentry>
  40         <term>
  41                 <command><option>acpitempf</option></command>
  42         </term>
  43         <listitem>
  44                 ACPI temperature in F.
  45                 <para></para></listitem>
  46 </varlistentry>
  47
  48 <varlistentry>
  49         <term>
  50                 <command><option>adt746xcpu</option></command>
  51         </term>
  52         <listitem>
  53                 CPU temperature from therm_adt746x
  54         <para></para></listitem>
  55 </varlistentry>
  56
  57 <varlistentry>
  58         <term>
  59                 <command><option>adt746xfan</option></command>
  60         </term>
  61         <listitem>
  62                 Fan speed from therm_adt746x
  63         <para></para></listitem>
  64 </varlistentry>
  65
  66 <varlistentry>
  67         <term>
  68                 <command><option>alignr</option></command>
  69         <option>(num)</option>
  70         </term>
  71         <listitem>
  72                 Right-justify text, with space of N
  73         <para></para></listitem>
  74 </varlistentry>
  75
  76 <varlistentry>
  77         <term>
  78                 <command><option>alignc</option></command>
  79         <option>(num)</option>
  80         </term>
  81         <listitem>
  82                 Align text to centre
  83         <para></para></listitem>
  84 </varlistentry>
  85
  86 <varlistentry>
  87         <term>
  88                 <command><option>apm_adapter</option></command>
  89         </term>
  90         <listitem>
  91                 Display APM AC adapter status (FreeBSD only)
  92         <para></para></listitem>
  93 </varlistentry>
  94
  95 <varlistentry>
  96         <term>
  97                 <command><option>apm_battery_life</option></command>
  98         </term>
  99         <listitem>
 100                 Display APM battery life in percent (FreeBSD only)
 101         <para></para></listitem>
 102 </varlistentry>
 103
 104 <varlistentry>
 105         <term>
 106                 <command><option>apm_battery_time</option></command>
 107         </term>
 108         <listitem>
 109                 Display remaining APM battery life in hh:mm:ss or "unknown" if
 110                 AC adapterstatus is on-line or charging (FreeBSD only)
 111         <para></para></listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115         <term>
 116                 <command><option>battery</option></command>
 117         <option>(num)</option>
 118         </term>
 119         <listitem>
 120                 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
 121         <para></para></listitem>
 122 </varlistentry>
 123
 124 <varlistentry>
 125         <term>
 126                 <command><option>bmpx_artist</option></command>
 127         </term>
 128         <listitem>
 129                 Artist in current BMPx track
 130         <para></para></listitem>
 131 </varlistentry>
 132
 133 <varlistentry>
 134         <term>
 135                 <command><option>bmpx_album</option></command>
 136         </term>
 137         <listitem>
 138                 Album in current BMPx track
 139         <para></para></listitem>
 140 </varlistentry>
 141
 142 <varlistentry>
 143         <term>
 144                 <command><option>bmpx_title</option></command>
 145         </term>
 146         <listitem>
 147                 Title of the current BMPx track
 148         <para></para></listitem>
 149 </varlistentry>
 150
 151 <varlistentry>
 152         <term>
 153                 <command><option>bmpx_track</option></command>
 154         </term>
 155         <listitem>
 156                 Track number of the current BMPx track
 157         <para></para></listitem>
 158 </varlistentry>
 159
 160 <varlistentry>
 161         <term>
 162                 <command><option>bmpx_bitrate</option></command>
 163         </term>
 164         <listitem>
 165                 Bitrate of the current BMPx track
 166         <para></para></listitem>
 167 </varlistentry>
 168
 169 <varlistentry>
 170         <term>
 171                 <command><option>bmpx_uri</option></command>
 172         </term>
 173         <listitem>
 174                 URI of the current BMPx track
 175         <para></para></listitem>
 176 </varlistentry>
 177
 178 <varlistentry>
 179         <term>
 180                 <command><option>buffers</option></command>
 181         </term>
 182         <listitem>
 183                 Amount of memory buffered
 184         <para></para></listitem>
 185 </varlistentry>
 186
 187 <varlistentry>
 188         <term>
 189                 <command><option>cached</option></command>
 190         </term>
 191         <listitem>
 192                 Amount of memory cached
 193         <para></para></listitem>
 194 </varlistentry>
 195
 196 <varlistentry>
 197         <term>
 198                 <command><option>color</option></command>
 199         <option>(color)</option>
 200         </term>
 201         <listitem>
 202                 Change drawing color to color
 203         <para></para></listitem>
 204 </varlistentry>
 205
 206 <varlistentry>
 207         <term>
 208                 <command><option>cpu</option></command>
 209                 <option>(cpuN)</option>
 210         </term>
 211         <listitem>
 212                 CPU usage in percents.  For SMP machines, the CPU number can be provided as an argument.  cpu0 is the total usage, and >=cpu1 are individual CPUs.
 213         <para></para></listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217         <term>
 218                 <command><option>cpubar</option></command>
 219                 <option>(cpu number) (height),(width)</option>
 220         </term>
 221         <listitem>
 222                 Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
 223         <para></para></listitem>
 224 </varlistentry>
 225
 226 <varlistentry>
 227         <term>
 228                 <command><option>cpugraph</option></command>
 229         <option>(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
 230         </term>
 231         <listitem>
 232                 CPU usage graph, with optional colours in hex, minus the #.  See $cpu for more info on SMP.
 233         <para></para></listitem>
 234 </varlistentry>
 235
 236 <varlistentry>
 237         <term>
 238                 <command><option>diskio</option></command>
 239         </term>
 240         <listitem>
 241                 Displays current disk IO.
 242                 <para></para></listitem>
 243 </varlistentry>
 244
 245 <varlistentry>
 246         <term>
 247                 <command><option>diskiograph</option></command>
 248                 <option>(height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 249         </term>
 250         <listitem>
 251                 Disk IO graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 252                 <para></para></listitem>
 253 </varlistentry>
 254
 255 <varlistentry>
 256         <term>
 257                 <command><option>downspeed</option></command>
 258         <option>net</option>
 259         </term>
 260         <listitem>
 261                 Download speed in kilobytes
 262         <para></para></listitem>
 263 </varlistentry>
 264
 265 <varlistentry>
 266         <term>
 267                 <command><option>downspeedf</option></command>
 268         <option>net</option>
 269         </term>
 270         <listitem>
 271                 Download speed in kilobytes with one decimal
 272         <para></para></listitem>
 273 </varlistentry>
 274
 275 <varlistentry>
 276         <term>
 277                 <command><option>downspeedgraph</option></command>
 278                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 279         </term>
 280         <listitem>
 281                 Download speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 282         <para></para></listitem>
 283 </varlistentry>
 284
 285 <varlistentry>
 286         <term>
 287                 <command><option>else</option></command>
 288         </term>
 289         <listitem>
 290                 Text to show if any of the above are not true
 291         <para></para></listitem>
 292 </varlistentry>
 293
 294 <varlistentry>
 295         <term>
 296                 <command><option>exec</option></command>
 297         <option>command</option>
 298         </term>
 299         <listitem>
 300                 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
 301         <para></para></listitem>
 302 </varlistentry>
 303
 304 <varlistentry>
 305         <term>
 306                 <command><option>execbar</option></command>
 307         <option>command</option>
 308         </term>
 309         <listitem>
 310                 Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future.
 311         <para></para></listitem>
 312 </varlistentry>
 313
 314 <varlistentry>
 315         <term>
 316                 <command><option>execgraph</option></command>
 317         <option>command</option>
 318         </term>
 319         <listitem>
 320                 Same as execbar, but graphs values.
 321         <para></para></listitem>
 322 </varlistentry>
 323
 324 <varlistentry>
 325         <term>
 326                 <command><option>execi</option></command>
 327                 <option>interval command</option>
 328         </term>
 329         <listitem>
 330                 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
 331                 <para></para></listitem>
 332 </varlistentry>
 333
 334 <varlistentry>
 335         <term>
 336                 <command><option>execibar</option></command>
 337                 <option>interval command</option>
 338         </term>
 339         <listitem>
 340                 Same as execbar, except with an interval
 341                 <para></para></listitem>
 342 </varlistentry>
 343
 344 <varlistentry>
 345         <term>
 346                 <command><option>execigraph</option></command>
 347                 <option>interval command</option>
 348         </term>
 349         <listitem>
 350                 Same as execigraph, but takes an interval arg graphs values
 351                 <para></para></listitem>
 352 </varlistentry>
 353
 354 <varlistentry>
 355         <term>
 356                 <command><option>font</option></command>
 357         <option>font</option>
 358         </term>
 359         <listitem>
 360                 Specify a different font. Only applies to one line.
 361         <para></para></listitem>
 362 </varlistentry>
 363
 364
 365         <varlistentry>
 366                 <term>
 367                         <command><option>freq</option></command>
 368                 </term>
 369                 <listitem>
 370                         Returns CPU frequency in MHz
 371                         <para></para></listitem>
 372         </varlistentry>
 373         <varlistentry>
 374                 <term>
 375                         <command><option>freq_g</option></command>
 376                 </term>
 377                 <listitem>
 378                         Returns CPU frequency in GHz
 379                         <para></para></listitem>
 380         </varlistentry>
 381
 382         <varlistentry>
 383                 <term>
 384                         <command><option>freq_dyn</option></command>
 385                 </term>
 386                 <listitem>
 387                         Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 388                         <para></para></listitem>
 389         </varlistentry>
 390         <varlistentry>
 391                 <term>
 392                         <command><option>freq_dyn_g</option></command>
 393                 </term>
 394                 <listitem>
 395                         Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 396                         <para></para></listitem>
 397         </varlistentry>
 398
 399         <varlistentry>
 400         <term>
 401                 <command><option>fs_bar</option></command>
 402         <option>(height),(width) fs</option>
 403         </term>
 404         <listitem>
 405                 Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system.
 406         <para></para></listitem>
 407 </varlistentry>
 408
 409 <varlistentry>
 410         <term>
 411                 <command><option>fs_free</option></command>
 412         <option>(fs)</option>
 413         </term>
 414         <listitem>
 415                 Free space on a file system available for users.
 416         <para></para></listitem>
 417 </varlistentry>
 418
 419 <varlistentry>
 420         <term>
 421                 <command><option>fs_free_perc</option></command>
 422         <option>(fs)</option>
 423         </term>
 424         <listitem>
 425                 Free percentage of space on a file system available for users.
 426         <para></para></listitem>
 427 </varlistentry>
 428
 429 <varlistentry>
 430         <term>
 431                 <command><option>fs_size</option></command>
 432         <option>(fs)</option>
 433         </term>
 434         <listitem>
 435                 File system size
 436         <para></para></listitem>
 437 </varlistentry>
 438
 439 <varlistentry>
 440         <term>
 441                 <command><option>fs_used</option></command>
 442         <option>(fs)</option>
 443         </term>
 444         <listitem>
 445                 File system used space
 446         <para></para></listitem>
 447 </varlistentry>
 448
 449 <varlistentry>
 450         <term>
 451                 <command><option>head</option></command>
 452                 <option>logfile lines (interval)</option>
 453         </term>
 454         <listitem>
 455                 Displays first N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
 456                 <para></para></listitem>
 457 </varlistentry>
 458
 459 <varlistentry>
 460         <term>
 461                 <command><option>hr</option></command>
 462         <option>(height)</option>
 463         </term>
 464         <listitem>
 465                 Horizontal line, height is the height in pixels
 466         <para></para></listitem>
 467 </varlistentry>
 468
 469 <varlistentry>
 470         <term>
 471                 <command><option>i2c</option></command>
 472         <option>(dev) type n</option>
 473         </term>
 474         <listitem>
 475                 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
 476         <para></para></listitem>
 477 </varlistentry>
 478
 479 <varlistentry>
 480         <term>
 481                 <command><option>i8k_ac_status</option></command>
 482         <option></option>
 483         </term>
 484         <listitem>
 485                 If running the i8k kernel driver for Inspiron laptops, displays whether ac power is on, as listed in /proc/i8k (translated to human-readable). Beware that this is by default not enabled by i8k itself.
 486         <para></para></listitem>
 487 </varlistentry>
 488
 489 <varlistentry>
 490         <term>
 491                 <command><option>i8k_bios</option></command>
 492         <option></option>
 493         </term>
 494         <listitem>
 495                 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
 496         <para></para></listitem>
 497 </varlistentry>
 498
 499 <varlistentry>
 500         <term>
 501                 <command><option>i8k_buttons_status</option></command>
 502         <option></option>
 503         </term>
 504         <listitem>
 505                 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
 506         <para></para></listitem>
 507 </varlistentry>
 508
 509 <varlistentry>
 510         <term>
 511                 <command><option>i8k_cpu_temp</option></command>
 512         <option></option>
 513         </term>
 514         <listitem>
 515                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
 516         <para></para></listitem>
 517 </varlistentry>
 518
 519 <varlistentry>
 520         <term>
 521                 <command><option>i8k_cpu_tempf</option></command>
 522         <option></option>
 523         </term>
 524         <listitem>
 525                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
 526         <para></para></listitem>
 527 </varlistentry>
 528
 529 <varlistentry>
 530         <term>
 531                 <command><option>i8k_left_fan_rpm</option></command>
 532         <option></option>
 533         </term>
 534         <listitem>
 535                 If running the i8k kernel driver for Inspiron laptops, displays the left fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
 536         <para></para></listitem>
 537 </varlistentry>
 538
 539 <varlistentry>
 540         <term>
 541                 <command><option>i8k_left_fan_status</option></command>
 542         <option></option>
 543         </term>
 544         <listitem>
 545                 If running the i8k kernel driver for Inspiron laptops, displays the left fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
 546         <para></para></listitem>
 547 </varlistentry>
 548
 549 <varlistentry>
 550         <term>
 551                 <command><option>i8k_right_fan_rpm</option></command>
 552         <option></option>
 553         </term>
 554         <listitem>
 555                 If running the i8k kernel driver for Inspiron laptops, displays the right fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
 556         <para></para></listitem>
 557 </varlistentry>
 558
 559 <varlistentry>
 560         <term>
 561                 <command><option>i8k_right_fan_status</option></command>
 562         <option></option>
 563         </term>
 564         <listitem>
 565                 If running the i8k kernel driver for Inspiron laptops, displays the right fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
 566         <para></para></listitem>
 567 </varlistentry>
 568
 569 <varlistentry>
 570         <term>
 571                 <command><option>i8k_serial</option></command>
 572         <option></option>
 573         </term>
 574         <listitem>
 575                 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
 576         <para></para></listitem>
 577 </varlistentry>
 578
 579 <varlistentry>
 580         <term>
 581                 <command><option>i8k_version</option></command>
 582         <option></option>
 583         </term>
 584         <listitem>
 585                 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
 586         <para></para></listitem>
 587 </varlistentry>
 588
 589
 590 <varlistentry>
 591         <term>
 592                 <command><option>if_running</option></command>
 593         <option>(process)</option>
 594         </term>
 595         <listitem>
 596                 if PROCESS is running, display everything if_running and the matching $endif
 597         <para></para></listitem>
 598 </varlistentry>
 599
 600 <varlistentry>
 601         <term>
 602                 <command><option>if_existing</option></command>
 603         <option>(file)</option>
 604         </term>
 605         <listitem>
 606                 if FILE exists, display everything between if_existing and the matching $endif
 607         <para></para></listitem>
 608 </varlistentry>
 609
 610 <varlistentry>
 611         <term>
 612                 <command><option>if_mounted</option></command>
 613         <option>(mountpoint)</option>
 614         </term>
 615         <listitem>
 616                 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
 617         <para></para></listitem>
 618 </varlistentry>
 619
 620 <varlistentry>
 621         <term>
 622                 <command><option>kernel</option></command>
 623         </term>
 624         <listitem>
 625                 Kernel version
 626         <para></para></listitem>
 627 </varlistentry>
 628
 629 <varlistentry>
 630         <term>
 631                 <command><option>linkstatus</option></command>
 632         <option>interface</option>
 633         </term>
 634         <listitem>
 635                 Get the link status for wireless connections
 636         <para></para></listitem>
 637 </varlistentry>
 638
 639 <varlistentry>
 640         <term>
 641                 <command><option>loadavg</option></command>
 642         </term>
 643         <listitem>
 644                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
 645         <para></para></listitem>
 646 </varlistentry>
 647
 648 <varlistentry>
 649         <term>
 650                 <command><option>machine</option></command>
 651         </term>
 652         <listitem>
 653                 Machine, i686 for example
 654         <para></para></listitem>
 655 </varlistentry>
 656
 657 <varlistentry>
 658         <term>
 659                 <command><option>mails</option></command>
 660         </term>
 661         <listitem>
 662                 Mail count in mail spool. You can use program like fetchmail to get mails from some server using your favourite protocol. See also new_mails.
 663         <para></para></listitem>
 664 </varlistentry>
 665
 666 <varlistentry>
 667         <term>
 668                 <command><option>mem</option></command>
 669         </term>
 670         <listitem>
 671                 Amount of memory in use
 672         <para></para></listitem>
 673 </varlistentry>
 674
 675 <varlistentry>
 676         <term>
 677                 <command><option>membar</option></command>
 678         <option>(height),(width)</option>
 679         </term>
 680         <listitem>
 681                 Bar that shows amount of memory in use
 682         <para></para></listitem>
 683 </varlistentry>
 684
 685 <varlistentry>
 686         <term>
 687                 <command><option>memmax</option></command>
 688         </term>
 689         <listitem>
 690                 Total amount of memory
 691         <para></para></listitem>
 692 </varlistentry>
 693
 694 <varlistentry>
 695         <term>
 696                 <command><option>memperc</option></command>
 697         </term>
 698         <listitem>
 699                 Percentage of memory in use
 700         <para></para></listitem>
 701 </varlistentry>
 702
 703 <varlistentry>
 704         <term>
 705                 <command><option>mpd_artist</option></command>
 706         </term>
 707         <listitem>
 708                 Artist in current MPD song must be enabled at compile
 709         <para></para></listitem>
 710 </varlistentry>
 711
 712 <varlistentry>
 713         <term>
 714                 <command><option>mpd_album</option></command>
 715         </term>
 716         <listitem>
 717                 Album in current MPD song
 718         <para></para></listitem>
 719 </varlistentry>
 720
 721 <varlistentry>
 722         <term>
 723                 <command><option>mpd_bar</option></command>
 724         <option>(height),(width)</option>
 725         </term>
 726         <listitem>
 727                 Bar of mpd's progress
 728         <para></para></listitem>
 729 </varlistentry>
 730
 731 <varlistentry>
 732         <term>
 733                 <command><option>mpd_bitrate</option></command>
 734         </term>
 735         <listitem>
 736                 Bitrate of current song
 737         <para></para></listitem>
 738 </varlistentry>
 739
 740 <varlistentry>
 741         <term>
 742                 <command><option>mpd_status</option></command>
 743         </term>
 744         <listitem>
 745                 Playing, stopped, et cetera.
 746         <para></para></listitem>
 747 </varlistentry>
 748
 749 <varlistentry>
 750         <term>
 751                 <command><option>mpd_title</option></command>
 752         </term>
 753         <listitem>
 754                 Title of current MPD song
 755         <para></para></listitem>
 756 </varlistentry>
 757
 758 <varlistentry>
 759         <term>
 760                 <command><option>mpd_vol</option></command>
 761         </term>
 762         <listitem>
 763                 MPD's volume
 764         <para></para></listitem>
 765 </varlistentry>
 766
 767 <varlistentry>
 768         <term>
 769                 <command><option>mpd_elapsed</option></command>
 770         </term>
 771         <listitem>
 772                 Song's elapsed time
 773         <para></para></listitem>
 774 </varlistentry>
 775
 776 <varlistentry>
 777         <term>
 778                 <command><option>mpd_length</option></command>
 779         </term>
 780         <listitem>
 781                 Song's length
 782         <para></para></listitem>
 783 </varlistentry>
 784
 785 <varlistentry>
 786         <term>
 787                 <command><option>mpd_percent</option></command>
 788         </term>
 789         <listitem>
 790                 Percent of song's progress
 791         <para></para></listitem>
 792 </varlistentry>
 793
 794 <varlistentry>
 795         <term>
 796                 <command><option>mpd_random</option></command>
 797         </term>
 798         <listitem>
 799                 Random status (On/Off)
 800         <para></para></listitem>
 801 </varlistentry>
 802
 803 <varlistentry>
 804         <term>
 805                 <command><option>mpd_repeat</option></command>
 806         </term>
 807         <listitem>
 808                 Repeat status (On/Off)
 809         <para></para></listitem>
 810 </varlistentry>
 811
 812 <varlistentry>
 813         <term>
 814                 <command><option>mpd_track</option></command>
 815         </term>
 816         <listitem>
 817                 Prints the MPD track field
 818         <para></para></listitem>
 819 </varlistentry>
 820
 821 <varlistentry>
 822         <term>
 823                 <command><option>mpd_name</option></command>
 824         </term>
 825         <listitem>
 826                 Prints the MPD name field
 827         <para></para></listitem>
 828 </varlistentry>
 829
 830 <varlistentry>
 831         <term>
 832                 <command><option>mpd_file</option></command>
 833         </term>
 834         <listitem>
 835                 Prints the file name of the current MPD song
 836         <para></para></listitem>
 837 </varlistentry>
 838
 839 <varlistentry>
 840         <term>
 841                 <command><option>mpd_smart</option></command>
 842         </term>
 843         <listitem>
 844                 Prints the song name in either the form "artist - title" or file name, depending on whats available
 845         <para></para></listitem>
 846 </varlistentry>
 847
 848 <varlistentry>
 849         <term>
 850                 <command><option>new_mails</option></command>
 851         </term>
 852         <listitem>
 853                 Unread mail count in mail spool.
 854         <para></para></listitem>
 855 </varlistentry>
 856
 857 <varlistentry>
 858         <term>
 859                 <command><option>nodename</option></command>
 860         </term>
 861         <listitem>
 862                 Hostname
 863         <para></para></listitem>
 864 </varlistentry>
 865
 866 <varlistentry>
 867         <term>
 868                 <command><option>outlinecolor</option></command>
 869         <option>(color)</option>
 870         </term>
 871         <listitem>
 872                 Change outline color
 873         <para></para></listitem>
 874 </varlistentry>
 875
 876 <varlistentry>
 877         <term>
 878                 <command><option>pre_exec</option></command>
 879         <option>shell command</option>
 880         </term>
 881         <listitem>
 882                 Executes a shell command one time before conky displays anything and puts output as text.
 883         <para></para></listitem>
 884 </varlistentry>
 885
 886 <varlistentry>
 887         <term>
 888                 <command><option>processes</option></command>
 889         </term>
 890         <listitem>
 891                 Total processes (sleeping and running)
 892         <para></para></listitem>
 893 </varlistentry>
 894
 895 <varlistentry>
 896         <term>
 897                 <command><option>running_processes</option></command>
 898         </term>
 899         <listitem>
 900                 Running processes (not sleeping), requires Linux 2.6
 901         <para></para></listitem>
 902 </varlistentry>
 903
 904 <varlistentry>
 905         <term>
 906                 <command><option>shadecolor</option></command>
 907         <option>(color)</option>
 908         </term>
 909         <listitem>
 910                 Change shading color
 911         <para></para></listitem>
 912 </varlistentry>
 913
 914 <varlistentry>
 915         <term>
 916                 <command><option>stippled_hr</option></command>
 917         <option>(space)</option>
 918         </term>
 919         <listitem>
 920                 Stippled (dashed) horizontal line
 921         <para></para></listitem>
 922 </varlistentry>
 923
 924 <varlistentry>
 925         <term>
 926                 <command><option>swapbar</option></command>
 927         <option>(height),(width)</option>
 928         </term>
 929         <listitem>
 930                 Bar that shows amount of swap in use
 931         <para></para></listitem>
 932 </varlistentry>
 933
 934 <varlistentry>
 935         <term>
 936                 <command><option>swap</option></command>
 937         </term>
 938         <listitem>
 939                 Amount of swap in use
 940         <para></para></listitem>
 941 </varlistentry>
 942
 943 <varlistentry>
 944         <term>
 945                 <command><option>swapmax</option></command>
 946         </term>
 947         <listitem>
 948                 Total amount of swap
 949         <para></para></listitem>
 950 </varlistentry>
 951
 952 <varlistentry>
 953         <term>
 954                 <command><option>swapperc</option></command>
 955         </term>
 956         <listitem>
 957                 Percentage of swap in use
 958         <para></para></listitem>
 959 </varlistentry>
 960
 961 <varlistentry>
 962         <term>
 963                 <command><option>sysname</option></command>
 964         </term>
 965         <listitem>
 966                 System name, Linux for example
 967         <para></para></listitem>
 968 </varlistentry>
 969
 970 <varlistentry>
 971         <term>
 972                 <command><option>tcp_portmon</option></command>
 973                 <option>port_begin port_end item (index)</option>
 974                 <emphasis>(ip4 only at present)</emphasis>
 975         </term>
 976         <listitem>
 977                 TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
 978                 <simplelist>
 979                         <member><command>count</command> - total number of connections in the range
 980                                 </member>
 981                         <member><command>rip</command> - remote ip address
 982                                 </member>
 983                         <member><command>rhost</command> - remote host name
 984                                 </member>
 985                         <member><command>rport</command> - remote port number
 986                                 </member>
 987                         <member><command>rservice</command> - remote service name from /etc/services
 988                                 </member>
 989                         <member><command>lip</command> - local ip address
 990                                 </member>
 991                         <member><command>lhost</command> - local host name
 992                                 </member>
 993                         <member><command>lport</command> - local port number
 994                                 </member>
 995                         <member><command>lservice</command> - local service name from /etc/services
 996                                 </member>
 997                 </simplelist>The connection index provides you with access to each connection in the port monitor.  The monitor will return information for index values from 0 to n-1 connections.  Values higher than n-1 are simply ignored.  For the "count" item, the connection index must be omitted.  It is required for all other items.
 998                 <simplelist>
 999                         <member>Examples:</member>
1000                         <member><command>${tcp_portmon 6881 6999 count}</command> -
1001                                 displays the number of connections in the bittorrent port range</member>
1002                         <member><command>${tcp_portmon 22 22 rip 0}</command> -
1003                                 displays the remote host ip of the first sshd connection</member>
1004                         <member><command>${tcp_portmon 22 22 rip 9}</command> -
1005                                 displays the remote host ip of the tenth sshd connection</member>
1006                         <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1007                                 displays the remote host name of the first connection on a privileged port</member>
1008                         <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1009                                 displays the remote host port of the fifth connection on a privileged port</member>
1010                         <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1011                                 displays the local service name of the fifteenth connection in the range of all ports</member>
1012                 </simplelist>Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a single port range for different items and different indexes all use the same monitor internally.  In other words, the program avoids creating redundant monitors.
1013         </listitem>
1014 </varlistentry>
1015
1016 <varlistentry>
1017         <term>
1018                 <command><option>texeci</option></command>
1019                 <option>interval command</option>
1020         </term>
1021         <listitem>
1022                 Runs a command at an interval inside a thread and displays the output.  Same as $execi, except the command is run inside a thread.  Use this if you have a slow script to keep Conky updating.  You should make the interval slightly longer then the time it takes your script to execute.  For example, if you have a script that take 5 seconds to execute, you should make the interval at least 6 seconds. See also $execi.
1023                 <para></para></listitem>
1024 </varlistentry>
1025
1026 <varlistentry>
1027         <term>
1028                 <command><option>offset</option></command>
1029                 <option>(pixels)</option>
1030         </term>
1031         <listitem>
1032                 Move text over by N pixels.  See also $voffset.
1033                 <para></para></listitem>
1034 </varlistentry>
1035
1036 <varlistentry>
1037         <term>
1038                 <command><option>tail</option></command>
1039                 <option>logfile lines (interval)</option>
1040         </term>
1041         <listitem>
1042                 Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
1043         <para></para></listitem>
1044 </varlistentry>
1045
1046 <varlistentry>
1047         <term>
1048                 <command><option>time</option></command>
1049         <option>(format)</option>
1050         </term>
1051         <listitem>
1052                 Local time, see man strftime to get more information about format
1053         <para></para></listitem>
1054 </varlistentry>
1055
1056 <varlistentry>
1057         <term>
1058                 <command><option>totaldown</option></command>
1059         <option>net</option>
1060         </term>
1061         <listitem>
1062                 Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't seem to be a way to know how many times it has already done that before conky has started.
1063         <para></para></listitem>
1064 </varlistentry>
1065
1066 <varlistentry>
1067         <term>
1068                 <command><option>top</option></command>
1069         <option>type, num</option>
1070         </term>
1071         <listitem>
1072                 This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", and mem". There can be a max of 10 processes listed.
1073         <para></para></listitem>
1074 </varlistentry>
1075
1076 <varlistentry>
1077         <term>
1078                 <command><option>top_mem</option></command>
1079         <option>type, num</option>
1080         </term>
1081         <listitem>
1082                 Same as top, except sorted by mem usage instead of cpu
1083         <para></para></listitem>
1084 </varlistentry>
1085
1086 <varlistentry>
1087         <term>
1088                 <command><option>totalup</option></command>
1089         <option>net</option>
1090         </term>
1091         <listitem>
1092                 Total upload, this one too, may overflow
1093         <para></para></listitem>
1094 </varlistentry>
1095
1096 <varlistentry>
1097         <term>
1098                 <command><option>updates</option></command>
1099         <option>Number of updates</option>
1100         </term>
1101         <listitem>
1102                 for debugging
1103         <para></para></listitem>
1104 </varlistentry>
1105
1106 <varlistentry>
1107         <term>
1108                 <command><option>upspeed</option></command>
1109         <option>net</option>
1110         </term>
1111         <listitem>
1112                 Upload speed in kilobytes
1113         <para></para></listitem>
1114 </varlistentry>
1115
1116 <varlistentry>
1117         <term>
1118                 <command><option>upspeedf</option></command>
1119         <option>net</option>
1120         </term>
1121         <listitem>
1122                 Upload speed in kilobytes with one decimal
1123         <para></para></listitem>
1124 </varlistentry>
1125
1126 <varlistentry>
1127         <term>
1128                 <command><option>upspeedgraph</option></command>
1129                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1130         </term>
1131         <listitem>
1132                 Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1133         <para></para></listitem>
1134 </varlistentry>
1135
1136 <varlistentry>
1137         <term>
1138                 <command><option>uptime</option></command>
1139         </term>
1140         <listitem>
1141                 Uptime
1142         <para></para></listitem>
1143 </varlistentry>
1144
1145 <varlistentry>
1146         <term>
1147                 <command><option>uptime_short</option></command>
1148         </term>
1149         <listitem>
1150                 Uptime in a shorter format
1151         <para></para></listitem>
1152 </varlistentry>
1153
1154 <varlistentry>
1155         <term>
1156                 <command><option>seti_prog</option></command>
1157         </term>
1158         <listitem>
1159                 Seti@home current progress
1160         <para></para></listitem>
1161 </varlistentry>
1162
1163 <varlistentry>
1164         <term>
1165                 <command><option>seti_progbar</option></command>
1166         <option>(height),(width)</option>
1167         </term>
1168         <listitem>
1169                 Seti@home current progress bar
1170         <para></para></listitem>
1171 </varlistentry>
1172
1173 <varlistentry>
1174         <term>
1175                 <command><option>seti_credit</option></command>
1176         </term>
1177         <listitem>
1178                 Seti@home total user credit
1179         <para></para></listitem>
1180 </varlistentry>
1181 <varlistentry>
1182         <term>
1183                 <command><option>voffset</option></command>
1184                 <option>(pixels)</option>
1185         </term>
1186         <listitem>
1187                 Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1188                 <para></para></listitem>
1189 </varlistentry>
1190
1191 <varlistentry>
1192         <term>
1193                 <command><option>xmms_bar</option></command>
1194                 <option>(height),(width)</option>
1195         </term>
1196         <listitem>
1197                 xmms / bmp / audacious / infopipe: progress bar
1198         <para></para></listitem>
1199 </varlistentry>
1200
1201 <varlistentry>
1202         <term>
1203                 <command><option>xmms_bitrate</option></command>
1204         </term>
1205         <listitem>
1206                 xmms / bmp / audacious / infopipe: bitrate of current tune
1207         <para></para></listitem>
1208 </varlistentry>
1209
1210 <varlistentry>
1211         <term>
1212                 <command><option>xmms_channels</option></command>
1213         </term>
1214         <listitem>
1215                 xmms / bmp / audacious / infopipe: number of audio channels of current tune
1216         <para></para></listitem>
1217 </varlistentry>
1218
1219 <varlistentry>
1220         <term>
1221                 <command><option>xmms_filename</option></command>
1222         </term>
1223         <listitem>
1224                 xmms / bmp / audacious / infopipe: full path and filename of current tune
1225         <para></para></listitem>
1226 </varlistentry>
1227
1228 <varlistentry>
1229         <term>
1230                 <command><option>xmms_frequency</option></command>
1231         </term>
1232         <listitem>
1233                 xmms / bmp / audacious / infopipe: sampling frequency of current tune
1234         <para></para></listitem>
1235 </varlistentry>
1236
1237 <varlistentry>
1238         <term>
1239                 <command><option>xmms_length</option></command>
1240         </term>
1241         <listitem>
1242                 xmms / bmp / audacious / infopipe: total length of current tune as MM:SS
1243         <para></para></listitem>
1244 </varlistentry>
1245
1246 <varlistentry>
1247         <term>
1248                 <command><option>xmms_length_seconds</option></command>
1249         </term>
1250         <listitem>
1251                 xmms / bmp / audacious / infopipe: total length of current tune in seconds
1252         <para></para></listitem>
1253 </varlistentry>
1254
1255 <varlistentry>
1256         <term>
1257                 <command><option>xmms_playlist_position</option></command>
1258         </term>
1259         <listitem>
1260                 xmms / bmp / audacious / infopipe: playlist position of current tune
1261         <para></para></listitem>
1262 </varlistentry>
1263
1264 <varlistentry>
1265         <term>
1266                 <command><option>xmms_playlist_length</option></command>
1267         </term>
1268         <listitem>
1269                 xmms / bmp / audacious / infopipe: number of tunes in playlist
1270         <para></para></listitem>
1271 </varlistentry>
1272
1273 <varlistentry>
1274         <term>
1275                 <command><option>xmms_position</option></command>
1276         </term>
1277         <listitem>
1278                 xmms / bmp / audacious / infopipe: MM:SS position of current tune
1279         <para></para></listitem>
1280 </varlistentry>
1281
1282 <varlistentry>
1283         <term>
1284                 <command><option>xmms_position_seconds</option></command>
1285         </term>
1286         <listitem>
1287                 xmms / bmp / audacious / infopipe: position of current tune in seconds
1288         <para></para></listitem>
1289 </varlistentry>
1290
1291 <varlistentry>
1292         <term>
1293                 <command><option>xmms_status</option></command>
1294         </term>
1295         <listitem>
1296                 xmms / bmp / audacious / infopipe: player status (Playing/Paused/Stopped/Not running)
1297         <para></para></listitem>
1298 </varlistentry>
1299
1300 <varlistentry>
1301         <term>
1302                 <command><option>xmms_title</option></command>
1303         </term>
1304         <listitem>
1305                 xmms / bmp / audacious / infopipe: title of current tune
1306         <para></para></listitem>
1307 </varlistentry>
1308
1309 <varlistentry>
1310         <term>
1311                 <command><option>ibm_fan</option></command>
1312         </term>
1313         <listitem>
1314                 If running the IBM ACPI, displays the fan speed.
1315         <para></para></listitem>
1316 </varlistentry>
1317
1318 <varlistentry>
1319         <term>
1320                 <command><option>ibm_temps</option></command>
1321                 <option>N</option>
1322         </term>
1323         <listitem>
1324                 If running the IBM ACPI, displays the temperatures
1325                 from the IBM temperature sensors (N=0..7) Sensor 0 is
1326                 on the CPU, 3 is on the GPU.
1327         <para></para></listitem>
1328 </varlistentry>
1329
1330 <varlistentry>
1331         <term>
1332                 <command><option>ibm_volume</option></command>
1333         </term>
1334         <listitem>
1335                 If running the IBM ACPI, displays the "master" volume,
1336         controlled by the volume keys (0-14).
1337         <para></para></listitem>
1338 </varlistentry>
1339
1340 <varlistentry>
1341         <term>
1342                 <command><option>ibm_brightness</option></command>
1343         </term>
1344         <listitem>
1345                 If running the IBM ACPI, displays the brigtness of the
1346         laptops's LCD (0-7).
1347         <para></para></listitem>
1348 </varlistentry>
1349
1350 </variablelist>