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>addrs</option></command>
  15                         <option>interface</option>
  16                 </term>
  17                 <listitem>
  18                         IP addresses for an interface (if one - works like addr). Linux only.
  19                         <para></para></listitem>
  20         </varlistentry>
  21
  22
  23         <varlistentry>
  24                 <term>
  25                         <command><option>acpiacadapter</option></command>
  26                 </term>
  27                 <listitem>
  28                         ACPI ac adapter state.
  29                         <para></para></listitem>
  30         </varlistentry>
  31
  32         <varlistentry>
  33                 <term>
  34                         <command><option>acpifan</option></command>
  35                 </term>
  36                 <listitem>
  37                         ACPI fan state
  38                         <para></para></listitem>
  39         </varlistentry>
  40
  41         <varlistentry>
  42                 <term>
  43                         <command><option>acpitemp</option></command>
  44                 </term>
  45                 <listitem>
  46                         ACPI temperature in C.
  47                         <para></para></listitem>
  48         </varlistentry>
  49
  50         <varlistentry>
  51                 <term>
  52                         <command><option>acpitempf</option></command>
  53                 </term>
  54                 <listitem>
  55                         ACPI temperature in F.
  56                         <para></para></listitem>
  57         </varlistentry>
  58
  59         <varlistentry>
  60                 <term>
  61                         <command><option>adt746xcpu</option></command>
  62                 </term>
  63                 <listitem>
  64                         CPU temperature from therm_adt746x
  65                         <para></para></listitem>
  66         </varlistentry>
  67
  68         <varlistentry>
  69                 <term>
  70                         <command><option>adt746xfan</option></command>
  71                 </term>
  72                 <listitem>
  73                         Fan speed from therm_adt746x
  74                         <para></para></listitem>
  75         </varlistentry>
  76
  77         <varlistentry>
  78                 <term>
  79                         <command><option>alignr</option></command>
  80                         <option>(num)</option>
  81                 </term>
  82                 <listitem>
  83                         Right-justify text, with space of N
  84                         <para></para></listitem>
  85         </varlistentry>
  86
  87         <varlistentry>
  88                 <term>
  89                         <command><option>alignc</option></command>
  90                         <option>(num)</option>
  91                 </term>
  92                 <listitem>
  93                         Align text to centre
  94                         <para></para></listitem>
  95         </varlistentry>
  96
  97         <varlistentry>
  98                 <term>
  99                         <command><option>apm_adapter</option></command>
 100                 </term>
 101                 <listitem>
 102                         Display APM AC adapter status (FreeBSD only)
 103                         <para></para></listitem>
 104         </varlistentry>
 105
 106         <varlistentry>
 107                 <term>
 108                         <command><option>apm_battery_life</option></command>
 109                 </term>
 110                 <listitem>
 111                         Display APM battery life in percent (FreeBSD only)
 112                         <para></para></listitem>
 113         </varlistentry>
 114
 115         <varlistentry>
 116                 <term>
 117                         <command><option>apm_battery_time</option></command>
 118                 </term>
 119                 <listitem>
 120                         Display remaining APM battery life in hh:mm:ss or "unknown" if
 121                         AC adapterstatus is on-line or charging (FreeBSD only)
 122                         <para></para></listitem>
 123         </varlistentry>
 124
 125         <varlistentry>
 126                 <term>
 127                         <command><option>audacious_bar</option></command>
 128                         <option>(height),(width)</option>
 129                 </term>
 130                 <listitem>
 131                         Progress bar
 132                         <para></para></listitem>
 133         </varlistentry>
 134
 135         <varlistentry>
 136                 <term>
 137                         <command><option>audacious_bitrate</option></command>
 138                 </term>
 139                 <listitem>
 140                         Bitrate of current tune
 141                         <para></para></listitem>
 142         </varlistentry>
 143
 144         <varlistentry>
 145                 <term>
 146                         <command><option>audacious_channels</option></command>
 147                 </term>
 148                 <listitem>
 149                         Number of audio channels of current tune
 150                         <para></para></listitem>
 151         </varlistentry>
 152
 153         <varlistentry>
 154                 <term>
 155                         <command><option>audacious_filename</option></command>
 156                 </term>
 157                 <listitem>
 158                         Full path and filename of current tune
 159                         <para></para></listitem>
 160         </varlistentry>
 161
 162         <varlistentry>
 163                 <term>
 164                         <command><option>audacious_frequency</option></command>
 165                 </term>
 166                 <listitem>
 167                         Sampling frequency of current tune
 168                         <para></para></listitem>
 169         </varlistentry>
 170
 171         <varlistentry>
 172                 <term>
 173                         <command><option>audacious_length</option></command>
 174                 </term>
 175                 <listitem>
 176                         Total length of current tune as MM:SS
 177                         <para></para></listitem>
 178         </varlistentry>
 179
 180         <varlistentry>
 181                 <term>
 182                         <command><option>audacious_length_seconds</option></command>
 183                 </term>
 184                 <listitem>
 185                         Total length of current tune in seconds
 186                         <para></para></listitem>
 187         </varlistentry>
 188
 189         <varlistentry>
 190                 <term>
 191                         <command><option>audacious_playlist_position</option></command>
 192                 </term>
 193                 <listitem>
 194                         Playlist position of current tune
 195                         <para></para></listitem>
 196         </varlistentry>
 197
 198         <varlistentry>
 199                 <term>
 200                         <command><option>audacious_playlist_length</option></command>
 201                 </term>
 202                 <listitem>
 203                         Number of tunes in playlist
 204                         <para></para></listitem>
 205         </varlistentry>
 206
 207         <varlistentry>
 208                 <term>
 209                         <command><option>audacious_position</option></command>
 210                 </term>
 211                 <listitem>
 212                         Position of current tune (MM:SS)
 213                         <para></para></listitem>
 214         </varlistentry>
 215
 216         <varlistentry>
 217                 <term>
 218                         <command><option>audacious_position_seconds</option></command>
 219                 </term>
 220                 <listitem>
 221                         Position of current tune in seconds
 222                         <para></para></listitem>
 223         </varlistentry>
 224
 225         <varlistentry>
 226                 <term>
 227                         <command><option>audacious_status</option></command>
 228                 </term>
 229                 <listitem>
 230                         Player status (Playing/Paused/Stopped/Not running)
 231                         <para></para></listitem>
 232         </varlistentry>
 233
 234         <varlistentry>
 235                 <term>
 236                         <command><option>audacious_title</option></command>
 237                         <option>(max length)</option>
 238                 </term>
 239                 <listitem>
 240                         Title of current tune with optional maximum length specifier
 241                         <para></para></listitem>
 242         </varlistentry>
 243
 244         <varlistentry>
 245                 <term>
 246                         <command><option>battery</option></command>
 247                         <option>(num)</option>
 248                 </term>
 249                 <listitem>
 250                         Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
 251                         <para></para></listitem>
 252         </varlistentry>
 253
 254         <varlistentry>
 255                 <term>
 256                         <command><option>battery_bar</option></command>
 257                         <option>(height),(width) (num)</option>
 258                 </term>
 259                 <listitem>
 260                         Battery percentage remaining of ACPI battery in a bar.  ACPI battery number can be given as argument (default is BAT0).
 261                         <para></para></listitem>
 262         </varlistentry>
 263
 264         <varlistentry>
 265                 <term>
 266                         <command><option>battery_percent</option></command>
 267                         <option>(num)</option>
 268                 </term>
 269                 <listitem>
 270                         Battery percentage remaining for ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
 271                         <para></para></listitem>
 272         </varlistentry>
 273
 274         <varlistentry>
 275                 <term>
 276                         <command><option>battery_time</option></command>
 277                         <option>(num)</option>
 278                 </term>
 279                 <listitem>
 280                         Battery charge/discharge time remaining of ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
 281                         <para></para></listitem>
 282         </varlistentry>
 283
 284         <varlistentry>
 285                 <term>
 286                         <command><option>bmpx_artist</option></command>
 287                 </term>
 288                 <listitem>
 289                         Artist in current BMPx track
 290                         <para></para></listitem>
 291         </varlistentry>
 292
 293         <varlistentry>
 294                 <term>
 295                         <command><option>bmpx_album</option></command>
 296                 </term>
 297                 <listitem>
 298                         Album in current BMPx track
 299                         <para></para></listitem>
 300         </varlistentry>
 301
 302         <varlistentry>
 303                 <term>
 304                         <command><option>bmpx_title</option></command>
 305                 </term>
 306                 <listitem>
 307                         Title of the current BMPx track
 308                         <para></para></listitem>
 309         </varlistentry>
 310
 311         <varlistentry>
 312                 <term>
 313                         <command><option>bmpx_track</option></command>
 314                 </term>
 315                 <listitem>
 316                         Track number of the current BMPx track
 317                         <para></para></listitem>
 318         </varlistentry>
 319
 320         <varlistentry>
 321                 <term>
 322                         <command><option>bmpx_bitrate</option></command>
 323                 </term>
 324                 <listitem>
 325                         Bitrate of the current BMPx track
 326                         <para></para></listitem>
 327         </varlistentry>
 328
 329         <varlistentry>
 330                 <term>
 331                         <command><option>bmpx_uri</option></command>
 332                 </term>
 333                 <listitem>
 334                         URI of the current BMPx track
 335                         <para></para></listitem>
 336         </varlistentry>
 337
 338         <varlistentry>
 339                 <term>
 340                         <command><option>buffers</option></command>
 341                 </term>
 342                 <listitem>
 343                         Amount of memory buffered
 344                         <para></para></listitem>
 345         </varlistentry>
 346
 347         <varlistentry>
 348                 <term>
 349                         <command><option>cached</option></command>
 350                 </term>
 351                 <listitem>
 352                         Amount of memory cached
 353                         <para></para></listitem>
 354         </varlistentry>
 355
 356         <varlistentry>
 357                 <term>
 358                         <command><option>color</option></command>
 359                         <option>(color)</option>
 360                 </term>
 361                 <listitem>
 362                         Change drawing color to color
 363                         <para></para></listitem>
 364         </varlistentry>
 365
 366         <varlistentry>
 367                 <term><command><option>colorN</option></command></term>
 368                 <listitem>
 369                         Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
 370                         <para></para></listitem>
 371         </varlistentry>
 372
 373         <varlistentry>
 374                 <term>
 375                         <command><option>conky_version</option></command>
 376                 </term>
 377                 <listitem>
 378                         Conky version
 379                         <para></para></listitem>
 380         </varlistentry>
 381
 382         <varlistentry>
 383                 <term>
 384                         <command><option>conky_build_date</option></command>
 385                 </term>
 386                 <listitem>
 387                         Date Conky was built
 388                         <para></para></listitem>
 389         </varlistentry>
 390
 391         <varlistentry>
 392                 <term>
 393                         <command><option>conky_bulid_arch</option></command>
 394                 </term>
 395                 <listitem>
 396                         CPU architecture Conky was built for
 397                         <para></para></listitem>
 398         </varlistentry>
 399
 400         <varlistentry>
 401                 <term>
 402                         <command><option>cpu</option></command>
 403                         <option>(cpuN)</option>
 404                 </term>
 405                 <listitem>
 406                         CPU usage in percents.  For SMP machines, the CPU number can be provided as an argument.  ${cpu cpu0} is the total usage, and ${cpu cpuX} (X >= 1) are individual CPUs.
 407                         <para></para></listitem>
 408         </varlistentry>
 409
 410         <varlistentry>
 411                 <term>
 412                         <command><option>cpubar</option></command>
 413                         <option>(cpu number) (height),(width)</option>
 414                 </term>
 415                 <listitem>
 416                         Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
 417                         <para></para></listitem>
 418         </varlistentry>
 419
 420         <varlistentry>
 421                 <term>
 422                         <command><option>cpugraph</option></command>
 423                         <option>(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
 424                 </term>
 425                 <listitem>
 426                         CPU usage graph, with optional colours in hex, minus the #.  See $cpu for more info on SMP.
 427                         <para></para></listitem>
 428         </varlistentry>
 429
 430         <varlistentry>
 431                 <term>
 432                         <command><option>diskio</option></command>
 433                         <option>(device)</option>
 434                 </term>
 435                 <listitem>
 436                         Displays current disk IO.  Device is optional, and takes the form of sda for /dev/sda.  Individual partitions are allowed.
 437                         <para></para></listitem>
 438         </varlistentry>
 439
 440         <varlistentry>
 441                 <term>
 442                         <command><option>diskiograph</option></command>
 443                         <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 444                 </term>
 445                 <listitem>
 446                         Disk IO graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 447                         <para></para></listitem>
 448         </varlistentry>
 449
 450         <varlistentry>
 451                 <term>
 452                         <command><option>diskio_read</option></command>
 453                         <option>(device)</option>
 454                 </term>
 455                 <listitem>
 456                         Displays current disk IO for reads.  Device as in diskio.
 457                         <para></para></listitem>
 458         </varlistentry>
 459
 460         <varlistentry>
 461                 <term>
 462                         <command><option>diskiograph_read</option></command>
 463                         <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 464                 </term>
 465                 <listitem>
 466                         Disk IO graph for reads, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.  Device as in diskio.
 467                         <para></para></listitem>
 468         </varlistentry>
 469
 470         <varlistentry>
 471                 <term>
 472                         <command><option>diskio_write</option></command>
 473                         <option>(device)</option>
 474                 </term>
 475                 <listitem>
 476                         Displays current disk IO for writes.  Device as in diskio.
 477                         <para></para></listitem>
 478         </varlistentry>
 479
 480         <varlistentry>
 481                 <term>
 482                         <command><option>diskiograph_write</option></command>
 483                         <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 484                 </term>
 485                 <listitem>
 486                         Disk IO graph for writes, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.  Device as in diskio.
 487                         <para></para></listitem>
 488         </varlistentry>
 489
 490         <varlistentry>
 491                 <term>
 492                         <command><option>disk_protect</option></command>
 493                         <option>device</option>
 494                 </term>
 495                 <listitem>
 496                         Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free  " (note the padding).
 497                         <para></para></listitem>
 498         </varlistentry>
 499
 500         <varlistentry>
 501                 <term>
 502                         <command><option>downspeed</option></command>
 503                         <option>net</option>
 504                 </term>
 505                 <listitem>
 506                         Download speed in KiB
 507                         <para></para></listitem>
 508         </varlistentry>
 509
 510         <varlistentry>
 511                 <term>
 512                         <command><option>downspeedf</option></command>
 513                         <option>net</option>
 514                 </term>
 515                 <listitem>
 516                         Download speed in KiB with one decimal
 517                         <para></para></listitem>
 518         </varlistentry>
 519
 520         <varlistentry>
 521                 <term>
 522                         <command><option>downspeedgraph</option></command>
 523                         <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
 524                 </term>
 525                 <listitem>
 526                         Download speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
 527                         <para></para></listitem>
 528         </varlistentry>
 529
 530         <varlistentry>
 531                 <term>
 532                         <command><option>else</option></command>
 533                 </term>
 534                 <listitem>
 535                         Text to show if any of the above are not true
 536                         <para></para></listitem>
 537         </varlistentry>
 538
 539         <varlistentry>
 540                 <term>
 541                         <command><option>entropy_avail</option></command>
 542                 </term>
 543                 <listitem>
 544                         Current entropy available for crypto freaks
 545                         <para></para></listitem>
 546         </varlistentry>
 547
 548         <varlistentry>
 549                 <term>
 550                         <command><option>entropy_bar</option></command>
 551                         <option>(height),(width)</option>
 552                 </term>
 553                 <listitem>
 554                         Normalized bar of available entropy for crypto freaks
 555                         <para></para></listitem>
 556         </varlistentry>
 557
 558         <varlistentry>
 559                 <term>
 560                         <command><option>entropy_poolsize</option></command>
 561                 </term>
 562                 <listitem>
 563                         Total size of system entropy pool for crypto freaks
 564                         <para></para></listitem>
 565         </varlistentry>
 566
 567         <varlistentry>
 568                 <term>
 569                         <command><option>exec</option></command>
 570                         <option>command</option>
 571                 </term>
 572                 <listitem>
 573                         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.
 574                         <para></para></listitem>
 575         </varlistentry>
 576
 577         <varlistentry>
 578                 <term>
 579                         <command><option>execbar</option></command>
 580                         <option>command</option>
 581                 </term>
 582                 <listitem>
 583                         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.
 584                         <para></para></listitem>
 585         </varlistentry>
 586
 587         <varlistentry>
 588                 <term>
 589                         <command><option>execgraph</option></command>
 590                         <option>command</option>
 591                 </term>
 592                 <listitem>
 593                         Same as execbar, but graphs values.
 594                         <para></para></listitem>
 595         </varlistentry>
 596
 597         <varlistentry>
 598                 <term>
 599                         <command><option>execi</option></command>
 600                         <option>interval command</option>
 601                 </term>
 602                 <listitem>
 603                         Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
 604                         <para></para></listitem>
 605         </varlistentry>
 606
 607         <varlistentry>
 608                 <term>
 609                         <command><option>execibar</option></command>
 610                         <option>interval command</option>
 611                 </term>
 612                 <listitem>
 613                         Same as execbar, except with an interval
 614                         <para></para></listitem>
 615         </varlistentry>
 616
 617         <varlistentry>
 618                 <term>
 619                         <command><option>execigraph</option></command>
 620                         <option>interval command</option>
 621                 </term>
 622                 <listitem>
 623                         Same as execgraph, but takes an interval arg graphs values
 624                         <para></para></listitem>
 625         </varlistentry>
 626
 627         <varlistentry>
 628                 <term>
 629                         <command><option>execp</option></command>
 630                         <option>command</option>
 631                 </term>
 632                 <listitem>
 633                         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.  This differs from $exec in that it parses the output of the command, so you can insert things like ${color red}hi!${color} in your script and have it correctly parsed by Conky.
 634                         Caveats: Conky parses and evaluates the output of $execp every time Conky loops, and then destroys all the objects.  If you try to use anything like $execi within an $execp statement, it will functionally run at the same interval that the $execp statement runs, as it is created and destroyed at every interval.
 635                         <para></para></listitem>
 636         </varlistentry>
 637
 638         <varlistentry>
 639                 <term>
 640                         <command><option>execpi</option></command>
 641                         <option>interval command</option>
 642                 </term>
 643                 <listitem>
 644                         Same as execp but with specific interval. Interval can't be less than update_interval in configuration.  Note that the output from the $execpi command is still parsed and evaluated at every interval.
 645                         <para></para></listitem>
 646         </varlistentry>
 647
 648         <varlistentry>
 649                 <term>
 650                         <command><option>font</option></command>
 651                         <option>(font)</option>
 652                 </term>
 653                 <listitem>
 654                         Specify a different font. This new font will apply to the current line and everything following.  You can use a $font with no arguments to change back to the default font (much like with $color)
 655                         <para></para></listitem>
 656         </varlistentry>
 657
 658         <varlistentry>
 659                 <term>
 660                         <command><option>freq</option></command>
 661                         <option>(n)</option>
 662                 </term>
 663                 <listitem>
 664                         Returns CPU #n's frequency in MHz. CPUs are
 665                         counted from 1. If omitted, the parameter
 666                         defaults to 1.
 667                         <para></para></listitem>
 668         </varlistentry>
 669         <varlistentry>
 670                 <term>
 671                         <command><option>freq_g</option></command>
 672                         <option>(n)</option>
 673                 </term>
 674                 <listitem>
 675                         Returns CPU #n's frequency in GHz. CPUs are
 676                         counted from 1. If omitted, the parameter
 677                         defaults to 1.
 678                         <para></para></listitem>
 679         </varlistentry>
 680
 681         <varlistentry>
 682                 <term>
 683                         <command><option>freq_dyn</option></command>
 684                 </term>
 685                 <listitem>
 686                         Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 687                         <para></para></listitem>
 688         </varlistentry>
 689
 690         <varlistentry>
 691                 <term>
 692                         <command><option>freq_dyn_g</option></command>
 693                 </term>
 694                 <listitem>
 695                         Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
 696                         <para></para></listitem>
 697         </varlistentry>
 698
 699         <varlistentry>
 700                 <term>
 701                         <command><option>fs_bar</option></command>
 702                         <option>(height),(width) fs</option>
 703                 </term>
 704                 <listitem>
 705                         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.
 706                         <para></para></listitem>
 707         </varlistentry>
 708
 709         <varlistentry>
 710                 <term>
 711                         <command><option>fs_free</option></command>
 712                         <option>(fs)</option>
 713                 </term>
 714                 <listitem>
 715                         Free space on a file system available for users.
 716                         <para></para></listitem>
 717         </varlistentry>
 718
 719         <varlistentry>
 720                 <term>
 721                         <command><option>fs_free_perc</option></command>
 722                         <option>(fs)</option>
 723                 </term>
 724                 <listitem>
 725                         Free percentage of space on a file system available for users.
 726                         <para></para></listitem>
 727         </varlistentry>
 728
 729         <varlistentry>
 730                 <term>
 731                         <command><option>fs_size</option></command>
 732                         <option>(fs)</option>
 733                 </term>
 734                 <listitem>
 735                         File system size
 736                         <para></para></listitem>
 737         </varlistentry>
 738
 739         <varlistentry>
 740                 <term>
 741                         <command><option>fs_type</option></command>
 742                         <option>(fs)</option>
 743                 </term>
 744                 <listitem>
 745                         File system type
 746                         <para></para></listitem>
 747         </varlistentry>
 748
 749         <varlistentry>
 750                 <term>
 751                         <command><option>fs_used</option></command>
 752                         <option>(fs)</option>
 753                 </term>
 754                 <listitem>
 755                         File system used space
 756                         <para></para></listitem>
 757         </varlistentry>
 758
 759         <varlistentry>
 760                 <term>
 761                         <command><option>goto</option></command>
 762                         <option>x</option>
 763                 </term>
 764                 <listitem>
 765                         The next element will be printed at position 'x'.
 766                         <para></para></listitem>
 767         </varlistentry>
 768
 769         <varlistentry>
 770                 <term>
 771                         <command><option>gw_iface</option></command>
 772                 </term>
 773                 <listitem>
 774                         Displays the default route's interface or "multiple"/"none" accordingly.
 775                         <para></para></listitem>
 776         </varlistentry>
 777
 778         <varlistentry>
 779                 <term>
 780                         <command><option>gw_ip</option></command>
 781                 </term>
 782                 <listitem>
 783                         Displays the default gateway's IP or "multiple"/"none" accordingly.
 784                         <para></para></listitem>
 785         </varlistentry>
 786
 787         <varlistentry>
 788                 <term>
 789                         <command><option>hddtemp</option></command>
 790                         <option>dev, (host,(port))</option>
 791                 </term>
 792                 <listitem>
 793                         Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
 794                         Default host is 127.0.0.1, default port is 7634.
 795                         <para></para></listitem>
 796         </varlistentry>
 797
 798         <varlistentry>
 799                 <term>
 800                         <command><option>head</option></command>
 801                         <option>logfile lines (interval)</option>
 802                 </term>
 803                 <listitem>
 804                         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.
 805                         <para></para></listitem>
 806         </varlistentry>
 807
 808         <varlistentry>
 809                 <term>
 810                         <command><option>hr</option></command>
 811                         <option>(height)</option>
 812                 </term>
 813                 <listitem>
 814                         Horizontal line, height is the height in pixels
 815                         <para></para></listitem>
 816         </varlistentry>
 817
 818         <varlistentry>
 819                 <term>
 820                         <command><option>hwmon</option></command>
 821                         <option>(dev) type n</option>
 822                 </term>
 823                 <listitem>
 824                         Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one hwmon device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
 825                         <para></para></listitem>
 826         </varlistentry>
 827
 828         <varlistentry>
 829                 <term>
 830                         <command><option>iconv_start</option></command>
 831                         <option>codeset_from codeset_to</option>
 832                 </term>
 833                 <listitem>
 834                         Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
 835                         <para></para></listitem>
 836         </varlistentry>
 837
 838         <varlistentry>
 839                 <term>
 840                         <command><option>iconv_stop</option></command>
 841                         <option></option>
 842                 </term>
 843                 <listitem>
 844                         Stop iconv codeset conversion.
 845                         <para></para></listitem>
 846         </varlistentry>
 847
 848         <varlistentry>
 849                 <term>
 850                         <command><option>i2c</option></command>
 851                         <option>(dev) type n</option>
 852                 </term>
 853                 <listitem>
 854                         I2C sensor from sysfs (Linux 2.6).  Parameter dev may be omitted if you have only one I2C device.  Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature.  Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
 855                         <para></para></listitem>
 856         </varlistentry>
 857
 858         <varlistentry>
 859                 <term>
 860                         <command><option>i8k_ac_status</option></command>
 861                         <option></option>
 862                 </term>
 863                 <listitem>
 864                         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.
 865                         <para></para></listitem>
 866         </varlistentry>
 867
 868         <varlistentry>
 869                 <term>
 870                         <command><option>i8k_bios</option></command>
 871                         <option></option>
 872                 </term>
 873                 <listitem>
 874                         If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
 875                         <para></para></listitem>
 876         </varlistentry>
 877
 878         <varlistentry>
 879                 <term>
 880                         <command><option>i8k_buttons_status</option></command>
 881                         <option></option>
 882                 </term>
 883                 <listitem>
 884                         If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
 885                         <para></para></listitem>
 886         </varlistentry>
 887
 888         <varlistentry>
 889                 <term>
 890                         <command><option>i8k_cpu_temp</option></command>
 891                         <option></option>
 892                 </term>
 893                 <listitem>
 894                         If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
 895                         <para></para></listitem>
 896         </varlistentry>
 897
 898         <varlistentry>
 899                 <term>
 900                         <command><option>i8k_cpu_tempf</option></command>
 901                         <option></option>
 902                 </term>
 903                 <listitem>
 904                         If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
 905                         <para></para></listitem>
 906         </varlistentry>
 907
 908         <varlistentry>
 909                 <term>
 910                         <command><option>i8k_left_fan_rpm</option></command>
 911                         <option></option>
 912                 </term>
 913                 <listitem>
 914                         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.
 915                         <para></para></listitem>
 916         </varlistentry>
 917
 918         <varlistentry>
 919                 <term>
 920                         <command><option>i8k_left_fan_status</option></command>
 921                         <option></option>
 922                 </term>
 923                 <listitem>
 924                         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.
 925                         <para></para></listitem>
 926         </varlistentry>
 927
 928         <varlistentry>
 929                 <term>
 930                         <command><option>i8k_right_fan_rpm</option></command>
 931                         <option></option>
 932                 </term>
 933                 <listitem>
 934                         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.
 935                         <para></para></listitem>
 936         </varlistentry>
 937
 938         <varlistentry>
 939                 <term>
 940                         <command><option>i8k_right_fan_status</option></command>
 941                         <option></option>
 942                 </term>
 943                 <listitem>
 944                         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.
 945                         <para></para></listitem>
 946         </varlistentry>
 947
 948         <varlistentry>
 949                 <term>
 950                         <command><option>i8k_serial</option></command>
 951                         <option></option>
 952                 </term>
 953                 <listitem>
 954                         If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
 955                         <para></para></listitem>
 956         </varlistentry>
 957
 958         <varlistentry>
 959                 <term>
 960                         <command><option>i8k_version</option></command>
 961                         <option></option>
 962                 </term>
 963                 <listitem>
 964                         If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
 965                         <para></para></listitem>
 966         </varlistentry>
 967
 968         <varlistentry>
 969                 <term>
 970                         <command><option>ibm_fan</option></command>
 971                 </term>
 972                 <listitem>
 973                         If running the IBM ACPI, displays the fan speed.
 974                         <para></para></listitem>
 975         </varlistentry>
 976
 977         <varlistentry>
 978                 <term>
 979                         <command><option>ibm_temps</option></command>
 980                         <option>N</option>
 981                 </term>
 982                 <listitem>
 983                         If running the IBM ACPI, displays the temperatures
 984                         from the IBM temperature sensors (N=0..7) Sensor 0 is
 985                         on the CPU, 3 is on the GPU.
 986                         <para></para></listitem>
 987         </varlistentry>
 988
 989         <varlistentry>
 990                 <term>
 991                         <command><option>ibm_volume</option></command>
 992                 </term>
 993                 <listitem>
 994                         If running the IBM ACPI, displays the "master" volume,
 995                         controlled by the volume keys (0-14).
 996                         <para></para></listitem>
 997         </varlistentry>
 998
 999         <varlistentry>
1000                 <term>
1001                         <command><option>ibm_brightness</option></command>
1002                 </term>
1003                 <listitem>
1004                         If running the IBM ACPI, displays the brigtness of the
1005                         laptops's LCD (0-7).
1006                         <para></para></listitem>
1007         </varlistentry>
1008
1009         <varlistentry>
1010                 <term>
1011                         <command><option>if_empty</option></command>
1012                         <option>(var)</option>
1013                 </term>
1014                 <listitem>
1015                         if conky variable VAR is empty, display everything between $if_empty and the matching $endif
1016                         <para></para></listitem>
1017         </varlistentry>
1018
1019         <varlistentry>
1020                 <term>
1021                         <command><option>if_gw</option></command>
1022                 </term>
1023                 <listitem>
1024                         if there is at least one default gateway, display everything between $if_gw and the matching $endif
1025                         <para></para></listitem>
1026         </varlistentry>
1027
1028         <varlistentry>
1029                 <term>
1030                         <command><option>if_running</option></command>
1031                         <option>(process)</option>
1032                 </term>
1033                 <listitem>
1034                         if PROCESS is running, display everything $if_running and the matching $endif
1035                         <para></para></listitem>
1036         </varlistentry>
1037
1038         <varlistentry>
1039                 <term>
1040                         <command><option>if_existing</option></command>
1041                         <option>file (string)</option>
1042                 </term>
1043                 <listitem>
1044                         if FILE exists, display everything between if_existing and the matching $endif.  The optional second paramater checks for FILE containing the specified string and prints everything between $if_existing and the matching $endif.
1045                         <para></para></listitem>
1046         </varlistentry>
1047
1048         <varlistentry>
1049                 <term>
1050                         <command><option>if_mounted</option></command>
1051                         <option>(mountpoint)</option>
1052                 </term>
1053                 <listitem>
1054                         if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
1055                         <para></para></listitem>
1056         </varlistentry>
1057
1058         <varlistentry>
1059                 <term>
1060                         <command><option>if_smapi_bat_installed</option></command>
1061                         <option>(INDEX)</option>
1062                 </term>
1063                 <listitem>
1064                         when using smapi, if the battery with index INDEX is installed, display everything between $if_smapi_bat_installed and the matching $endif
1065                         <para></para></listitem>
1066         </varlistentry>
1067
1068         <varlistentry>
1069                 <term>
1070                         <command><option>if_up</option></command>
1071                         <option>(interface)</option>
1072                 </term>
1073                 <listitem>
1074                         if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1075                         <para></para></listitem>
1076         </varlistentry>
1077
1078         <varlistentry>
1079                 <term>
1080                         <command><option>imap_messages</option></command>
1081                         <option>(args)</option>
1082                 </term>
1083                 <listitem>
1084                         Displays the number of messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 143, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1085                         <para></para></listitem>
1086         </varlistentry>
1087
1088         <varlistentry>
1089                 <term>
1090                         <command><option>imap_unseen</option></command>
1091                         <option>(args)</option>
1092                 </term>
1093                 <listitem>
1094                         Displays the number of unseen messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 143, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1095                         <para></para></listitem>
1096         </varlistentry>
1097
1098         <varlistentry>
1099                 <term>
1100                         <command><option>ioscheduler</option></command>
1101                         <option>disk</option>
1102                 </term>
1103                 <listitem>
1104                         Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1105                         <para></para></listitem>
1106         </varlistentry>
1107
1108         <varlistentry>
1109                 <term>
1110                         <command><option>kernel</option></command>
1111                 </term>
1112                 <listitem>
1113                         Kernel version
1114                         <para></para></listitem>
1115         </varlistentry>
1116
1117         <varlistentry>
1118                 <term>
1119                         <command><option>laptop_mode</option></command>
1120                 </term>
1121                 <listitem>
1122                         The value of /proc/sys/vm/laptop_mode
1123                         <para></para></listitem>
1124         </varlistentry>
1125
1126         <varlistentry>
1127                 <term>
1128                         <command><option>loadavg</option></command>
1129                 </term>
1130                 <listitem>
1131                         (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1132                         <para></para></listitem>
1133         </varlistentry>
1134
1135         <varlistentry>
1136                 <term>
1137                         <command><option>loadgraph</option></command>
1138                         <option>(height),(width) (gradient colour 1) (gradient colour 2)</option>
1139                 </term>
1140                 <listitem>
1141                         Load1 average graph, similar to xload, with optional colours in hex, minus the #.
1142                         <para></para></listitem>
1143         </varlistentry>
1144
1145         <varlistentry>
1146                 <term>
1147                         <command><option>machine</option></command>
1148                 </term>
1149                 <listitem>
1150                         Machine, i686 for example
1151                         <para></para></listitem>
1152         </varlistentry>
1153
1154         <varlistentry>
1155                 <term>
1156                         <command><option>mails</option></command>
1157                         <option>(mailbox)</option>
1158                         <option>(interval)</option>
1159                 </term>
1160                 <listitem>
1161                         Mail count in the specified mailbox or your mail spool if not.
1162                         Both mbox and maildir type mailboxes are supported. You can
1163                         use a program like fetchmail to get mails from some server
1164                         using your favourite protocol. See also new_mails.
1165                         <para></para></listitem>
1166         </varlistentry>
1167
1168         <varlistentry>
1169                 <term>
1170                         <command><option>mboxscan</option></command>
1171                         <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1172                 </term>
1173                 <listitem>
1174                         Print a summary of recent messages in an mbox format mailbox.  mbox parameter is the filename of the mailbox (can be encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1175                         <para></para></listitem>
1176         </varlistentry>
1177
1178         <varlistentry>
1179                 <term>
1180                         <command><option>mem</option></command>
1181                 </term>
1182                 <listitem>
1183                         Amount of memory in use
1184                         <para></para></listitem>
1185         </varlistentry>
1186
1187         <varlistentry>
1188                 <term>
1189                         <command><option>membar</option></command>
1190                         <option>(height),(width)</option>
1191                 </term>
1192                 <listitem>
1193                         Bar that shows amount of memory in use
1194                         <para></para></listitem>
1195         </varlistentry>
1196
1197         <varlistentry>
1198                 <term>
1199                         <command><option>memgraph</option></command>
1200                         <option>(height),(width) (gradient colour 1) (gradient colour 2)</option>
1201                 </term>
1202                 <listitem>
1203                         Memory usage graph
1204                         <para></para></listitem>
1205         </varlistentry>
1206
1207         <varlistentry>
1208                 <term>
1209                         <command><option>memmax</option></command>
1210                 </term>
1211                 <listitem>
1212                         Total amount of memory
1213                         <para></para></listitem>
1214         </varlistentry>
1215
1216         <varlistentry>
1217                 <term>
1218                         <command><option>memperc</option></command>
1219                 </term>
1220                 <listitem>
1221                         Percentage of memory in use
1222                         <para></para></listitem>
1223         </varlistentry>
1224
1225         <varlistentry>
1226                 <term>
1227                         <command><option>mpd_artist</option></command>
1228                 </term>
1229                 <listitem>
1230                         Artist in current MPD song must be enabled at compile
1231                         <para></para></listitem>
1232         </varlistentry>
1233
1234         <varlistentry>
1235                 <term>
1236                         <command><option>mpd_album</option></command>
1237                 </term>
1238                 <listitem>
1239                         Album in current MPD song
1240                         <para></para></listitem>
1241         </varlistentry>
1242
1243         <varlistentry>
1244                 <term>
1245                         <command><option>mpd_bar</option></command>
1246                         <option>(height),(width)</option>
1247                 </term>
1248                 <listitem>
1249                         Bar of mpd's progress
1250                         <para></para></listitem>
1251         </varlistentry>
1252
1253         <varlistentry>
1254                 <term>
1255                         <command><option>mpd_bitrate</option></command>
1256                 </term>
1257                 <listitem>
1258                         Bitrate of current song
1259                         <para></para></listitem>
1260         </varlistentry>
1261
1262         <varlistentry>
1263                 <term>
1264                         <command><option>mpd_status</option></command>
1265                 </term>
1266                 <listitem>
1267                         Playing, stopped, et cetera.
1268                         <para></para></listitem>
1269         </varlistentry>
1270
1271         <varlistentry>
1272                 <term>
1273                         <command><option>mpd_title</option></command>
1274                         <option>(max length)</option>
1275                 </term>
1276                 <listitem>
1277                         Title of current MPD song
1278                         <para></para></listitem>
1279         </varlistentry>
1280
1281         <varlistentry>
1282                 <term>
1283                         <command><option>mpd_vol</option></command>
1284                 </term>
1285                 <listitem>
1286                         MPD's volume
1287                         <para></para></listitem>
1288         </varlistentry>
1289
1290         <varlistentry>
1291                 <term>
1292                         <command><option>mpd_elapsed</option></command>
1293                 </term>
1294                 <listitem>
1295                         Song's elapsed time
1296                         <para></para></listitem>
1297         </varlistentry>
1298
1299         <varlistentry>
1300                 <term>
1301                         <command><option>mpd_length</option></command>
1302                 </term>
1303                 <listitem>
1304                         Song's length
1305                         <para></para></listitem>
1306         </varlistentry>
1307
1308         <varlistentry>
1309                 <term>
1310                         <command><option>mpd_percent</option></command>
1311                 </term>
1312                 <listitem>
1313                         Percent of song's progress
1314                         <para></para></listitem>
1315         </varlistentry>
1316
1317         <varlistentry>
1318                 <term>
1319                         <command><option>mpd_random</option></command>
1320                 </term>
1321                 <listitem>
1322                         Random status (On/Off)
1323                         <para></para></listitem>
1324         </varlistentry>
1325
1326         <varlistentry>
1327                 <term>
1328                         <command><option>mpd_repeat</option></command>
1329                 </term>
1330                 <listitem>
1331                         Repeat status (On/Off)
1332                         <para></para></listitem>
1333         </varlistentry>
1334
1335         <varlistentry>
1336                 <term>
1337                         <command><option>mpd_track</option></command>
1338                 </term>
1339                 <listitem>
1340                         Prints the MPD track field
1341                         <para></para></listitem>
1342         </varlistentry>
1343
1344         <varlistentry>
1345                 <term>
1346                         <command><option>mpd_name</option></command>
1347                 </term>
1348                 <listitem>
1349                         Prints the MPD name field
1350                         <para></para></listitem>
1351         </varlistentry>
1352
1353         <varlistentry>
1354                 <term>
1355                         <command><option>mpd_file</option></command>
1356                 </term>
1357                 <listitem>
1358                         Prints the file name of the current MPD song
1359                         <para></para></listitem>
1360         </varlistentry>
1361
1362         <varlistentry>
1363                 <term>
1364                         <command><option>mpd_smart</option></command>
1365                 </term>
1366                 <listitem>
1367                         Prints the song name in either the form "artist - title" or file name, depending on whats available
1368                         <para></para></listitem>
1369         </varlistentry>
1370
1371         <varlistentry>
1372                 <term>
1373                         <command><option>nameserver</option></command>
1374                         <option>(index)</option>
1375                 </term>
1376                 <listitem>
1377                         Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1378                         <para></para></listitem>
1379         </varlistentry>
1380
1381         <varlistentry>
1382                 <term>
1383                         <command><option>new_mails</option></command>
1384                         <option>(mailbox)</option>
1385                         <option>(interval)</option>
1386                 </term>
1387                 <listitem>
1388                         Unread mail count in the specified mailbox or mail spool if
1389                         not. Both mbox and maildir type mailboxes are supported.
1390                         <para></para></listitem>
1391         </varlistentry>
1392
1393         <varlistentry>
1394                 <term>
1395                         <command><option>nodename</option></command>
1396                 </term>
1397                 <listitem>
1398                         Hostname
1399                         <para></para></listitem>
1400         </varlistentry>
1401
1402         <varlistentry>
1403                 <term>
1404                         <command><option>nvidia</option></command>
1405                         <option>threshold</option>
1406                         <option>temp</option>
1407                         <option>gpufreq</option>
1408                         <option>memfreq</option>
1409                         <option>imagequality</option>
1410                 </term>
1411                 <listitem>
1412                         Nvidia graficcard support for the XNVCtrl library.
1413                         Each option gives back one integer value:
1414                         (threshold): the thresholdtemperature at which the gpu slows down
1415                         (temp): gives the gpu current temperature
1416                         (gpufreq): gives the current gpu frequency
1417                         (memfreq): gives the current mem frequency
1418                         (imagequality): which imagequality should be choosen by OpenGL applications
1419                         <para></para>
1420                 </listitem>
1421         </varlistentry>
1422
1423         <varlistentry>
1424                 <term>
1425                         <command><option>outlinecolor</option></command>
1426                         <option>(color)</option>
1427                 </term>
1428                 <listitem>
1429                         Change outline color
1430                         <para></para></listitem>
1431         </varlistentry>
1432
1433         <varlistentry>
1434                 <term>
1435                         <command><option>pb_battery</option></command>
1436                         <option>item</option>
1437                 </term>
1438                 <listitem>
1439                         If running on Apple powerbook/ibook, display
1440                         information on battery status. The item parameter
1441                         specifies, what information to display. Exactly one item
1442                         must be specified. Valid items are:
1443                         <simplelist>
1444                                 <member><command>status</command>:
1445                                         Display if battery is fully charged, charging,
1446                                         discharging or absent (running on AC)
1447                                 </member>
1448                                 <member><command>percent</command>:
1449                                         Display charge of battery in percent, if
1450                                         charging or discharging. Nothing will be
1451                                         displayed, if battery is fully charged
1452                                         or absent.
1453                                 </member>
1454                                 <member><command>time</command>:
1455                                         Display the time remaining until the battery
1456                                         will be fully charged or discharged at current
1457                                         rate.  Nothing is displayed, if battery is
1458                                         absent or if it's present but fully charged
1459                                         and not discharging.
1460                                 </member>
1461                         </simplelist>
1462                         <para></para></listitem>
1463         </varlistentry>
1464
1465         <varlistentry>
1466                 <term>
1467                         <command><option>platform</option></command>
1468                         <option>(dev) type n</option>
1469                 </term>
1470                 <listitem>
1471                         Platform sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one platform device. Platform type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
1472                         <para></para></listitem>
1473         </varlistentry>
1474
1475         <varlistentry>
1476                 <term>
1477                         <command><option>pop3_unseen</option></command>
1478                         <option>(args)</option>
1479                 </term>
1480                 <listitem>
1481                         Displays the number of unseen messages in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1482
1483                         <para></para></listitem>
1484         </varlistentry>
1485
1486         <varlistentry>
1487                 <term>
1488                         <command><option>pop3_used</option></command>
1489                         <option>(args)</option>
1490                 </term>
1491                 <listitem>
1492                         Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1493
1494                         <para></para></listitem>
1495         </varlistentry>
1496
1497         <varlistentry>
1498                 <term>
1499                         <command><option>pre_exec</option></command>
1500                         <option>shell command</option>
1501                 </term>
1502                 <listitem>
1503                         Executes a shell command one time before conky displays anything and puts output as text.
1504                         <para></para></listitem>
1505         </varlistentry>
1506
1507         <varlistentry>
1508                 <term>
1509                         <command><option>processes</option></command>
1510                 </term>
1511                 <listitem>
1512                         Total processes (sleeping and running)
1513                         <para></para></listitem>
1514         </varlistentry>
1515
1516         <varlistentry>
1517                 <term>
1518                         <command><option>running_processes</option></command>
1519                 </term>
1520                 <listitem>
1521                         Running processes (not sleeping), requires Linux 2.6
1522                         <para></para></listitem>
1523         </varlistentry>
1524
1525         <varlistentry>
1526                 <term>
1527                         <command><option>shadecolor</option></command>
1528                         <option>(color)</option>
1529                 </term>
1530                 <listitem>
1531                         Change shading color
1532                         <para></para></listitem>
1533         </varlistentry>
1534
1535         <varlistentry>
1536                 <term>
1537                         <command><option>smapi</option></command>
1538                         <option>(ARGS)</option>
1539                 </term>
1540                 <listitem>
1541                         when using smapi, display contents of the /sys/devices/platform/smapi directory. ARGS are either '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the corresponding files' content. This is a very raw method of accessing the smapi values. When available, better use one of the smapi_* variables instead.
1542                         <para></para></listitem>
1543         </varlistentry>
1544
1545         <varlistentry>
1546                 <term>
1547                         <command><option>smapi_bat_perc</option></command>
1548                         <option>(INDEX)</option>
1549                 </term>
1550                 <listitem>
1551                         when using smapi, display the remaining capacity in percent of the battery with index INDEX. This is a separate variable because it supports the 'use_spacer' configuration option.
1552                         <para></para></listitem>
1553         </varlistentry>
1554
1555         <varlistentry>
1556                 <term>
1557                         <command><option>smapi_bat_bar</option></command>
1558                         <option>(INDEX),(height),(width)</option>
1559                 </term>
1560                 <listitem>
1561                         when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1562                         <para></para></listitem>
1563         </varlistentry>
1564
1565         <varlistentry>
1566                 <term>
1567                         <command><option>stippled_hr</option></command>
1568                         <option>(space)</option>
1569                 </term>
1570                 <listitem>
1571                         Stippled (dashed) horizontal line
1572                         <para></para></listitem>
1573         </varlistentry>
1574
1575         <varlistentry>
1576                 <term>
1577                         <command><option>swapbar</option></command>
1578                         <option>(height),(width)</option>
1579                 </term>
1580                 <listitem>
1581                         Bar that shows amount of swap in use
1582                         <para></para></listitem>
1583         </varlistentry>
1584
1585         <varlistentry>
1586                 <term>
1587                         <command><option>swap</option></command>
1588                 </term>
1589                 <listitem>
1590                         Amount of swap in use
1591                         <para></para></listitem>
1592         </varlistentry>
1593
1594         <varlistentry>
1595                 <term>
1596                         <command><option>swapmax</option></command>
1597                 </term>
1598                 <listitem>
1599                         Total amount of swap
1600                         <para></para></listitem>
1601         </varlistentry>
1602
1603         <varlistentry>
1604                 <term>
1605                         <command><option>swapperc</option></command>
1606                 </term>
1607                 <listitem>
1608                         Percentage of swap in use
1609                         <para></para></listitem>
1610         </varlistentry>
1611
1612         <varlistentry>
1613                 <term>
1614                         <command><option>sysname</option></command>
1615                 </term>
1616                 <listitem>
1617                         System name, Linux for example
1618                         <para></para></listitem>
1619         </varlistentry>
1620
1621         <varlistentry>
1622                 <term>
1623                         <command><option>tcp_portmon</option></command>
1624                         <option>port_begin port_end item (index)</option>
1625                         <emphasis>(ip4 only at present)</emphasis>
1626                 </term>
1627                 <listitem>
1628                         TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1629                         <simplelist>
1630                                 <member><command>count</command> - total number of connections in the range
1631                                 </member>
1632                                 <member><command>rip</command> - remote ip address
1633                                 </member>
1634                                 <member><command>rhost</command> - remote host name
1635                                 </member>
1636                                 <member><command>rport</command> - remote port number
1637                                 </member>
1638                                 <member><command>rservice</command> - remote service name from /etc/services
1639                                 </member>
1640                                 <member><command>lip</command> - local ip address
1641                                 </member>
1642                                 <member><command>lhost</command> - local host name
1643                                 </member>
1644                                 <member><command>lport</command> - local port number
1645                                 </member>
1646                                 <member><command>lservice</command> - local service name from /etc/services
1647                                 </member>
1648                         </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.
1649                         <simplelist>
1650                                 <member>Examples:</member>
1651                                 <member><command>${tcp_portmon 6881 6999 count}</command> -
1652                                         displays the number of connections in the bittorrent port range</member>
1653                                 <member><command>${tcp_portmon 22 22 rip 0}</command> -
1654                                         displays the remote host ip of the first sshd connection</member>
1655                                 <member><command>${tcp_portmon 22 22 rip 9}</command> -
1656                                         displays the remote host ip of the tenth sshd connection</member>
1657                                 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1658                                         displays the remote host name of the first connection on a privileged port</member>
1659                                 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1660                                         displays the remote host port of the fifth connection on a privileged port</member>
1661                                 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1662                                         displays the local service name of the fifteenth connection in the range of all ports</member>
1663                         </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.
1664                 </listitem>
1665         </varlistentry>
1666
1667         <varlistentry>
1668                 <term>
1669                         <command><option>texeci</option></command>
1670                         <option>interval command</option>
1671                 </term>
1672                 <listitem>
1673                         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.
1674                         <para></para></listitem>
1675         </varlistentry>
1676
1677         <varlistentry>
1678                 <term>
1679                         <command><option>offset</option></command>
1680                         <option>(pixels)</option>
1681                 </term>
1682                 <listitem>
1683                         Move text over by N pixels.  See also $voffset.
1684                         <para></para></listitem>
1685         </varlistentry>
1686
1687         <varlistentry>
1688                 <term>
1689                         <command><option>rss</option></command>
1690                         <option>url delay_in_minutes action item_num</option>
1691                 </term>
1692                 <listitem>
1693                         Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles.
1694                         <para></para></listitem>
1695         </varlistentry>
1696
1697         <varlistentry>
1698                 <term>
1699                         <command><option>tab</option></command>
1700                         <option>(width, (start))</option>
1701                 </term>
1702                 <listitem>
1703                         Puts a tab of the specified width, starting from column 'start'.
1704                         <para></para></listitem>
1705         </varlistentry>
1706
1707         <varlistentry>
1708                 <term>
1709                         <command><option>tail</option></command>
1710                         <option>logfile lines (interval)</option>
1711                 </term>
1712                 <listitem>
1713                         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.
1714                         <para></para></listitem>
1715         </varlistentry>
1716
1717         <varlistentry>
1718                 <term>
1719                         <command><option>time</option></command>
1720                         <option>(format)</option>
1721                 </term>
1722                 <listitem>
1723                         Local time, see man strftime to get more information about format
1724                         <para></para></listitem>
1725         </varlistentry>
1726
1727         <varlistentry>
1728                 <term>
1729                         <command><option>utime</option></command>
1730                         <option>(format)</option>
1731                 </term>
1732                 <listitem>
1733                         Display time in UTC (universal coordinate time).
1734                         <para></para></listitem>
1735         </varlistentry>
1736
1737         <varlistentry>
1738                 <term>
1739                         <command><option>tztime</option></command>
1740                         <option>(timezone) (format)</option>
1741                 </term>
1742                 <listitem>
1743                         Local time for specified timezone, see man strftime to get more information about format. The timezone argument is  specified in similar fashion as TZ environment variable. For hints, look in /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1744                         <para></para></listitem>
1745         </varlistentry>
1746
1747         <varlistentry>
1748                 <term>
1749                         <command><option>totaldown</option></command>
1750                         <option>net</option>
1751                 </term>
1752                 <listitem>
1753                         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.
1754                         <para></para></listitem>
1755         </varlistentry>
1756
1757         <varlistentry>
1758                 <term>
1759                         <command><option>top</option></command>
1760                         <option>type, num</option>
1761                 </term>
1762                 <listitem>
1763                         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", "mem", "mem_res", "mem_vsize", and "time". There can be a max of 10 processes listed.
1764                         <para></para></listitem>
1765         </varlistentry>
1766
1767         <varlistentry>
1768                 <term>
1769                         <command><option>top_mem</option></command>
1770                         <option>type, num</option>
1771                 </term>
1772                 <listitem>
1773                         Same as top, except sorted by mem usage instead of cpu
1774                         <para></para></listitem>
1775         </varlistentry>
1776
1777         <varlistentry>
1778                 <term>
1779                         <command><option>totalup</option></command>
1780                         <option>net</option>
1781                 </term>
1782                 <listitem>
1783                         Total upload, this one too, may overflow
1784                         <para></para></listitem>
1785         </varlistentry>
1786
1787         <varlistentry>
1788                 <term>
1789                         <command><option>updates</option></command>
1790                         <option>Number of updates</option>
1791                 </term>
1792                 <listitem>
1793                         for debugging
1794                         <para></para></listitem>
1795         </varlistentry>
1796
1797         <varlistentry>
1798                 <term>
1799                         <command><option>upspeed</option></command>
1800                         <option>net</option>
1801                 </term>
1802                 <listitem>
1803                         Upload speed in KiB
1804                         <para></para></listitem>
1805         </varlistentry>
1806
1807         <varlistentry>
1808                 <term>
1809                         <command><option>upspeedf</option></command>
1810                         <option>net</option>
1811                 </term>
1812                 <listitem>
1813                         Upload speed in KiB with one decimal
1814                         <para></para></listitem>
1815         </varlistentry>
1816
1817         <varlistentry>
1818                 <term>
1819                         <command><option>upspeedgraph</option></command>
1820                         <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1821                 </term>
1822                 <listitem>
1823                         Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1824                         <para></para></listitem>
1825         </varlistentry>
1826
1827         <varlistentry>
1828                 <term>
1829                         <command><option>uptime</option></command>
1830                 </term>
1831                 <listitem>
1832                         Uptime
1833                         <para></para></listitem>
1834         </varlistentry>
1835
1836         <varlistentry>
1837                 <term>
1838                         <command><option>uptime_short</option></command>
1839                 </term>
1840                 <listitem>
1841                         Uptime in a shorter format
1842                         <para></para></listitem>
1843         </varlistentry>
1844
1845         <varlistentry>
1846                 <term>
1847                         <command><option>user_number</option></command>
1848                 </term>
1849                 <listitem>
1850                         Number of users logged in
1851                         <para></para></listitem>
1852         </varlistentry>
1853
1854         <varlistentry>
1855                 <term>
1856                         <command><option>user_names</option></command>
1857                 </term>
1858                 <listitem>
1859                         Lists the names of the users logged in
1860                         <para></para></listitem>
1861         </varlistentry>
1862
1863         <varlistentry>
1864                 <term>
1865                         <command><option>user_terms</option></command>
1866                 </term>
1867                 <listitem>
1868                         Lists the consoles in use
1869                         <para></para></listitem>
1870         </varlistentry>
1871
1872         <varlistentry>
1873                 <term>
1874                         <command><option>user_times</option></command>
1875                 </term>
1876                 <listitem>
1877                         Lists how long users have been logged in for
1878                         <para></para></listitem>
1879         </varlistentry>
1880
1881         <varlistentry>
1882                 <term>
1883                         <command><option>voffset</option></command>
1884                         <option>(pixels)</option>
1885                 </term>
1886                 <listitem>
1887                         Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1888                         <para></para></listitem>
1889         </varlistentry>
1890
1891         <varlistentry>
1892                 <term>
1893                         <command><option>voltage_mv</option></command>
1894                         <option>(n)</option>
1895                 </term>
1896                 <listitem>
1897                         Returns CPU #n's voltage in mV. CPUs are
1898                         counted from 1. If omitted, the parameter
1899                         defaults to 1.
1900                         <para></para></listitem>
1901         </varlistentry>
1902
1903         <varlistentry>
1904                 <term>
1905                         <command><option>voltage_v</option></command>
1906                         <option>(n)</option>
1907                 </term>
1908                 <listitem>
1909                         Returns CPU #n's voltage in V. CPUs are
1910                         counted from 1. If omitted, the parameter
1911                         defaults to 1.
1912                         <para></para></listitem>
1913         </varlistentry>
1914
1915         <varlistentry>
1916                 <term>
1917                         <command><option>wireless_essid</option></command>
1918                         <option>net</option>
1919                 </term>
1920                 <listitem>
1921                         Wireless access point ESSID (Linux only)
1922                         <para></para></listitem>
1923         </varlistentry>
1924
1925         <varlistentry>
1926                 <term>
1927                         <command><option>wireless_mode</option></command>
1928                         <option>net</option>
1929                 </term>
1930                 <listitem>
1931                         Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1932                         <para></para></listitem>
1933         </varlistentry>
1934
1935         <varlistentry>
1936                 <term>
1937                         <command><option>wireless_bitrate</option></command>
1938                         <option>net</option>
1939                 </term>
1940                 <listitem>
1941                         Wireless bitrate (ie 11 Mb/s) (Linux only)
1942                         <para></para></listitem>
1943         </varlistentry>
1944
1945         <varlistentry>
1946                 <term>
1947                         <command><option>wireless_ap</option></command>
1948                         <option>net</option>
1949                 </term>
1950                 <listitem>
1951                         Wireless access point MAC address (Linux only)
1952                         <para></para></listitem>
1953         </varlistentry>
1954
1955         <varlistentry>
1956                 <term>
1957                         <command><option>wireless_link_qual</option></command>
1958                         <option>net</option>
1959                 </term>
1960                 <listitem>
1961                         Wireless link quality (Linux only)
1962                         <para></para></listitem>
1963         </varlistentry>
1964
1965         <varlistentry>
1966                 <term>
1967                         <command><option>wireless_link_qual_max</option></command>
1968                         <option>net</option>
1969                 </term>
1970                 <listitem>
1971                         Wireless link quality maximum value (Linux only)
1972                         <para></para></listitem>
1973         </varlistentry>
1974
1975         <varlistentry>
1976                 <term>
1977                         <command><option>wireless_link_qual_perc</option></command>
1978                         <option>net</option>
1979                 </term>
1980                 <listitem>
1981                         Wireless link quality in percents (Linux only)
1982                         <para></para></listitem>
1983         </varlistentry>
1984
1985         <varlistentry>
1986                 <term>
1987                         <command><option>wireless_link_bar</option></command>
1988                         <option>(height), (width) net</option>
1989                 </term>
1990                 <listitem>
1991                         Wireless link quality bar (Linux only)
1992                         <para></para></listitem>
1993         </varlistentry>
1994
1995         <varlistentry>
1996                 <term>
1997                         <command><option>xmms2_artist</option></command>
1998                 </term>
1999                 <listitem>
2000                         Artist in current XMMS2 song
2001                         <para></para></listitem>
2002         </varlistentry>
2003
2004         <varlistentry>
2005                 <term>
2006                         <command><option>xmms2_album</option></command>
2007                 </term>
2008                 <listitem>
2009                         Album in current XMMS2 song
2010                         <para></para></listitem>
2011         </varlistentry>
2012
2013         <varlistentry>
2014                 <term>
2015                         <command><option>xmms2_title</option></command>
2016                 </term>
2017                 <listitem>
2018                         Title in current XMMS2 song
2019                         <para></para></listitem>
2020         </varlistentry>
2021
2022         <varlistentry>
2023                 <term>
2024                         <command><option>xmms2_genre</option></command>
2025                 </term>
2026                 <listitem>
2027                         Genre in current XMMS2 song
2028                         <para></para></listitem>
2029         </varlistentry>
2030
2031         <varlistentry>
2032                 <term>
2033                         <command><option>xmms2_comment</option></command>
2034                 </term>
2035                 <listitem>
2036                         Comment in current XMMS2 song
2037                         <para></para></listitem>
2038         </varlistentry>
2039
2040         <varlistentry>
2041                 <term>
2042                         <command><option>xmms2_decoder</option></command>
2043                 </term>
2044                 <listitem>
2045                         Decoder plugin used
2046                         <para></para></listitem>
2047         </varlistentry>
2048
2049         <varlistentry>
2050                 <term>
2051                         <command><option>xmms2_transport</option></command>
2052                 </term>
2053                 <listitem>
2054                         Transport plugin used
2055                         <para></para></listitem>
2056         </varlistentry>
2057
2058         <varlistentry>
2059                 <term>
2060                         <command><option>xmms2_url</option></command>
2061                 </term>
2062                 <listitem>
2063                         Full path to current song
2064                         <para></para></listitem>
2065         </varlistentry>
2066
2067         <varlistentry>
2068                 <term>
2069                         <command><option>xmms2_tracknr</option></command>
2070                 </term>
2071                 <listitem>
2072                         Track number in current XMMS2 song
2073                         <para></para></listitem>
2074         </varlistentry>
2075
2076         <varlistentry>
2077                 <term>
2078                         <command><option>xmms2_bitrate</option></command>
2079                 </term>
2080                 <listitem>
2081                         Bitrate of current song
2082                         <para></para></listitem>
2083         </varlistentry>
2084
2085         <varlistentry>
2086                 <term>
2087                         <command><option>xmms2_id</option></command>
2088                 </term>
2089                 <listitem>
2090                         XMMS2 id of current song
2091                         <para></para></listitem>
2092         </varlistentry>
2093
2094         <varlistentry>
2095                 <term>
2096                         <command><option>xmms2_duration</option></command>
2097                 </term>
2098                 <listitem>
2099                         Duration of current song
2100                         <para></para></listitem>
2101         </varlistentry>
2102
2103         <varlistentry>
2104                 <term>
2105                         <command><option>xmms2_elapsed</option></command>
2106                 </term>
2107                 <listitem>
2108                         Song's elapsed time
2109                         <para></para></listitem>
2110         </varlistentry>
2111
2112         <varlistentry>
2113                 <term>
2114                         <command><option>xmms2_size</option></command>
2115                 </term>
2116                 <listitem>
2117                         Size of current song
2118                         <para></para></listitem>
2119         </varlistentry>
2120
2121         <varlistentry>
2122                 <term>
2123                         <command><option>xmms2_percent</option></command>
2124                 </term>
2125                 <listitem>
2126                         Percent of song's progress
2127                         <para></para></listitem>
2128         </varlistentry>
2129
2130         <varlistentry>
2131                 <term>
2132                         <command><option>xmms2_status</option></command>
2133                 </term>
2134                 <listitem>
2135                         XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2136                         <para></para></listitem>
2137         </varlistentry>
2138
2139         <varlistentry>
2140                 <term>
2141                         <command><option>xmms2_bar</option></command>
2142                         <option>(height),(width)</option>
2143                 </term>
2144                 <listitem>
2145                         Bar of XMMS2's progress
2146                         <para></para></listitem>
2147         </varlistentry>
2148
2149         <varlistentry>
2150                 <term>
2151                         <command><option>xmms2_smart</option></command>
2152                 </term>
2153                 <listitem>
2154                         Prints the song name in either the form "artist - title" or file name, depending on whats available
2155                         <para></para></listitem>
2156         </varlistentry>
2157
2158 </variablelist>