mirror of
https://github.com/Llewellynvdm/conky.git
synced 2024-12-26 12:27:52 +00:00
e8e6d1c819
Added the (incomplete) check_docs.py, to 'synchronize' the docs with the code, as well as vim/nano syntax stuff. Removed some unused OBJ_* stuff from text_objects.h, and updated docs with some missing things. Also removed a couple deprecated objects which were still documented.
2766 lines
76 KiB
XML
2766 lines
76 KiB
XML
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>addr</option></command>
|
|
<option>interface</option>
|
|
</term>
|
|
<listitem>
|
|
IP address for an interface, or "No Address" if no address is assigned.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>addrs</option></command>
|
|
<option>interface</option>
|
|
</term>
|
|
<listitem>
|
|
IP addresses for an interface (if one - works like addr). Linux only.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>acpiacadapter</option></command>
|
|
</term>
|
|
<listitem>
|
|
ACPI ac adapter state.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>acpifan</option></command>
|
|
</term>
|
|
<listitem>
|
|
ACPI fan state
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>acpitemp</option></command>
|
|
</term>
|
|
<listitem>
|
|
ACPI temperature in C.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>adt746xcpu</option></command>
|
|
</term>
|
|
<listitem>
|
|
CPU temperature from therm_adt746x
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>adt746xfan</option></command>
|
|
</term>
|
|
<listitem>
|
|
Fan speed from therm_adt746x
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>alignr</option></command>
|
|
<option>(num)</option>
|
|
</term>
|
|
<listitem>
|
|
Right-justify text, with space of N
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>alignc</option></command>
|
|
<option>(num)</option>
|
|
</term>
|
|
<listitem>
|
|
Align text to centre
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>apm_adapter</option></command>
|
|
</term>
|
|
<listitem>
|
|
Display APM AC adapter status (FreeBSD only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>apm_battery_life</option></command>
|
|
</term>
|
|
<listitem>
|
|
Display APM battery life in percent (FreeBSD only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>apm_battery_time</option></command>
|
|
</term>
|
|
<listitem>
|
|
Display remaining APM battery life in hh:mm:ss or "unknown" if
|
|
AC adapterstatus is on-line or charging (FreeBSD only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_bar</option></command>
|
|
<option>(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Progress bar
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_bitrate</option></command>
|
|
</term>
|
|
<listitem>
|
|
Bitrate of current tune
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_channels</option></command>
|
|
</term>
|
|
<listitem>
|
|
Number of audio channels of current tune
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_filename</option></command>
|
|
</term>
|
|
<listitem>
|
|
Full path and filename of current tune
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_frequency</option></command>
|
|
</term>
|
|
<listitem>
|
|
Sampling frequency of current tune
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_length</option></command>
|
|
</term>
|
|
<listitem>
|
|
Total length of current tune as MM:SS
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_length_seconds</option></command>
|
|
</term>
|
|
<listitem>
|
|
Total length of current tune in seconds
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_playlist_position</option></command>
|
|
</term>
|
|
<listitem>
|
|
Playlist position of current tune
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_playlist_length</option></command>
|
|
</term>
|
|
<listitem>
|
|
Number of tunes in playlist
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_position</option></command>
|
|
</term>
|
|
<listitem>
|
|
Position of current tune (MM:SS)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_position_seconds</option></command>
|
|
</term>
|
|
<listitem>
|
|
Position of current tune in seconds
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_status</option></command>
|
|
</term>
|
|
<listitem>
|
|
Player status (Playing/Paused/Stopped/Not running)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_title</option></command>
|
|
<option>(max length)</option>
|
|
</term>
|
|
<listitem>
|
|
Title of current tune with optional maximum length specifier
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>audacious_main_volume</option></command>
|
|
</term>
|
|
<listitem>
|
|
The current volume fetched from Audacious
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>battery</option></command>
|
|
<option>(num)</option>
|
|
</term>
|
|
<listitem>
|
|
Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>battery_short</option></command>
|
|
<option>(num)</option>
|
|
</term>
|
|
<listitem>
|
|
Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
|
|
This mode display a short status, which means that C is displayed instead of charging and D is displayed instead of discharging.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>battery_bar</option></command>
|
|
<option>(height),(width) (num)</option>
|
|
</term>
|
|
<listitem>
|
|
Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>battery_percent</option></command>
|
|
<option>(num)</option>
|
|
</term>
|
|
<listitem>
|
|
Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>battery_time</option></command>
|
|
<option>(num)</option>
|
|
</term>
|
|
<listitem>
|
|
Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>bmpx_artist</option></command>
|
|
</term>
|
|
<listitem>
|
|
Artist in current BMPx track
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>bmpx_album</option></command>
|
|
</term>
|
|
<listitem>
|
|
Album in current BMPx track
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>bmpx_title</option></command>
|
|
</term>
|
|
<listitem>
|
|
Title of the current BMPx track
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>bmpx_track</option></command>
|
|
</term>
|
|
<listitem>
|
|
Track number of the current BMPx track
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>bmpx_bitrate</option></command>
|
|
</term>
|
|
<listitem>
|
|
Bitrate of the current BMPx track
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>bmpx_uri</option></command>
|
|
</term>
|
|
<listitem>
|
|
URI of the current BMPx track
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>buffers</option></command>
|
|
</term>
|
|
<listitem>
|
|
Amount of memory buffered
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>cached</option></command>
|
|
</term>
|
|
<listitem>
|
|
Amount of memory cached
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>color</option></command>
|
|
<option>(color)</option>
|
|
</term>
|
|
<listitem>
|
|
Change drawing color to color
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><command><option>colorN</option></command></term>
|
|
<listitem>
|
|
Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>combine</option></command>
|
|
<option>var1 var2</option>
|
|
</term>
|
|
<listitem>
|
|
Places the lines of var2 to the right of the lines of var1 seperated by the chars that are put between var1 and var2. For example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/meminfo 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1 and "cpuinfo_line2 -" on line 2. $combine vars can also be nested to place more vars next to each other.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>conky_version</option></command>
|
|
</term>
|
|
<listitem>
|
|
Conky version
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>conky_build_date</option></command>
|
|
</term>
|
|
<listitem>
|
|
Date Conky was built
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>conky_build_arch</option></command>
|
|
</term>
|
|
<listitem>
|
|
CPU architecture Conky was built for
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>cpu</option></command>
|
|
<option>(cpuN)</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>cpubar</option></command>
|
|
<option>(cpuN) (height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>cpugauge</option></command>
|
|
<option>(cpuN) (height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively. See $cpu for more info on SMP.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>cpugraph</option></command>
|
|
<option>(cpuN) ("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
|
|
</term>
|
|
<listitem>
|
|
CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>diskio</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>diskiograph</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
|
|
</term>
|
|
<listitem>
|
|
Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>diskio_read</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Displays current disk IO for reads. Device as in diskio.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>diskiograph_read</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
|
|
</term>
|
|
<listitem>
|
|
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. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>diskio_write</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Displays current disk IO for writes. Device as in diskio.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>diskiograph_write</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
|
|
</term>
|
|
<listitem>
|
|
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. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>disk_protect</option></command>
|
|
<option>device</option>
|
|
</term>
|
|
<listitem>
|
|
Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>downspeed</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Download speed in KiB
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>downspeedf</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Download speed in KiB with one decimal
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>downspeedgraph</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
|
|
</term>
|
|
<listitem>
|
|
Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>else</option></command>
|
|
</term>
|
|
<listitem>
|
|
Text to show if any of the above are not true
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>entropy_avail</option></command>
|
|
</term>
|
|
<listitem>
|
|
Current entropy available for crypto freaks
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>entropy_bar</option></command>
|
|
<option>(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Normalized bar of available entropy for crypto freaks
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>entropy_poolsize</option></command>
|
|
</term>
|
|
<listitem>
|
|
Total size of system entropy pool for crypto freaks
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>eval</option></command>
|
|
<option>string</option>
|
|
</term>
|
|
<listitem>
|
|
Evalutates given string according to the rules of TEXT interpretation, i.e. parsing any contained text object specifications into their output, any occuring '$$' into a single '$' and so on. The output is then being parsed again.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>exec</option></command>
|
|
<option>command</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execbar</option></command>
|
|
<option>command</option>
|
|
</term>
|
|
<listitem>
|
|
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 bars can be controlled via the default_bar_size config setting.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execgauge</option></command>
|
|
<option>command</option>
|
|
</term>
|
|
<listitem>
|
|
Same as exec, except if the first value returned is a value between 0-100, it will use that number for a gauge. The size for gauges can be controlled via the default_gauge_size config setting.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execgraph</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command</option>
|
|
</term>
|
|
<listitem>
|
|
Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100. The size for graphs can be controlled via the default_graph_size config setting.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execi</option></command>
|
|
<option>interval command</option>
|
|
</term>
|
|
<listitem>
|
|
Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execibar</option></command>
|
|
<option>interval command</option>
|
|
</term>
|
|
<listitem>
|
|
Same as execbar, except with an interval
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execigraph</option></command>
|
|
<option>interval command</option>
|
|
</term>
|
|
<listitem>
|
|
Same as execgraph, but takes an interval arg and graphs values.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execigauge</option></command>
|
|
<option>interval command</option>
|
|
</term>
|
|
<listitem>
|
|
Same as execgauge, but takes an interval arg and gauges values.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execp</option></command>
|
|
<option>command</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>execpi</option></command>
|
|
<option>interval command</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>font</option></command>
|
|
<option>(font)</option>
|
|
</term>
|
|
<listitem>
|
|
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)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>freq</option></command>
|
|
<option>(n)</option>
|
|
</term>
|
|
<listitem>
|
|
Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>freq_g</option></command>
|
|
<option>(n)</option>
|
|
</term>
|
|
<listitem>
|
|
Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_bar</option></command>
|
|
<option>(height),(width) fs</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_bar_free</option></command>
|
|
<option>(height),(width) fs</option>
|
|
</term>
|
|
<listitem>
|
|
Bar that shows how much space is free on a file system. height is the height in pixels. fs is any file on that file system.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_free</option></command>
|
|
<option>(fs)</option>
|
|
</term>
|
|
<listitem>
|
|
Free space on a file system available for users.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_free_perc</option></command>
|
|
<option>(fs)</option>
|
|
</term>
|
|
<listitem>
|
|
Free percentage of space on a file system available for users.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_size</option></command>
|
|
<option>(fs)</option>
|
|
</term>
|
|
<listitem>
|
|
File system size.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_type</option></command>
|
|
<option>(fs)</option>
|
|
</term>
|
|
<listitem>
|
|
File system type.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_used</option></command>
|
|
<option>(fs)</option>
|
|
</term>
|
|
<listitem>
|
|
File system used space.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>fs_used_perc</option></command>
|
|
<option>(fs)</option>
|
|
</term>
|
|
<listitem>
|
|
Percent of file system used space.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>goto</option></command>
|
|
<option>x</option>
|
|
</term>
|
|
<listitem>
|
|
The next element will be printed at position 'x'.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>gw_iface</option></command>
|
|
</term>
|
|
<listitem>
|
|
Displays the default route's interface or "multiple"/"none" accordingly.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>gw_ip</option></command>
|
|
</term>
|
|
<listitem>
|
|
Displays the default gateway's IP or "multiple"/"none" accordingly.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>hddtemp</option></command>
|
|
<option>dev, (host,(port))</option>
|
|
</term>
|
|
<listitem>
|
|
Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
|
|
Default host is 127.0.0.1, default port is 7634.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>head</option></command>
|
|
<option>logfile lines (interval)</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>hr</option></command>
|
|
<option>(height)</option>
|
|
</term>
|
|
<listitem>
|
|
Horizontal line, height is the height in pixels
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>hwmon</option></command>
|
|
<option>(dev) type n</option>
|
|
</term>
|
|
<listitem>
|
|
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' meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>iconv_start</option></command>
|
|
<option>codeset_from codeset_to</option>
|
|
</term>
|
|
<listitem>
|
|
Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>iconv_stop</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
Stop iconv codeset conversion.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i2c</option></command>
|
|
<option>(dev) type n</option>
|
|
</term>
|
|
<listitem>
|
|
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' meaning temperature. Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_ac_status</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_bios</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_buttons_status</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_cpu_temp</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_left_fan_rpm</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_left_fan_status</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_right_fan_rpm</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_right_fan_status</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_serial</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>i8k_version</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>ibm_fan</option></command>
|
|
</term>
|
|
<listitem>
|
|
If running the IBM ACPI, displays the fan speed.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>ibm_temps</option></command>
|
|
<option>N</option>
|
|
</term>
|
|
<listitem>
|
|
If running the IBM ACPI, displays the temperatures
|
|
from the IBM temperature sensors (N=0..7) Sensor 0 is
|
|
on the CPU, 3 is on the GPU.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>ibm_volume</option></command>
|
|
</term>
|
|
<listitem>
|
|
If running the IBM ACPI, displays the "master" volume,
|
|
controlled by the volume keys (0-14).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>ibm_brightness</option></command>
|
|
</term>
|
|
<listitem>
|
|
If running the IBM ACPI, displays the brigtness of the
|
|
laptops's LCD (0-7).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_empty</option></command>
|
|
<option>(var)</option>
|
|
</term>
|
|
<listitem>
|
|
if conky variable VAR is empty, display everything
|
|
between $if_empty and the matching $endif
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_existing</option></command>
|
|
<option>file (string)</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_gw</option></command>
|
|
</term>
|
|
<listitem>
|
|
if there is at least one default gateway, display
|
|
everything between $if_gw and the matching $endif
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_match</option></command>
|
|
<option>expression</option>
|
|
</term>
|
|
<listitem>
|
|
Evaluates the given boolean expression, printing
|
|
everything between $if_match and the matching $endif
|
|
depending on whether the evaluation returns true or not.
|
|
Valid expressions consist of a left side, an operator
|
|
and a right side. Left and right sides are being parsed
|
|
for contained text objects before evaluation. Recognised
|
|
left and right side types are:
|
|
<simplelist>
|
|
<member><command>double</command>:
|
|
argument consists of only digits and a
|
|
single dot.
|
|
</member>
|
|
<member><command>long</command>:
|
|
argument consists of only digits.
|
|
</member>
|
|
<member><command>string</command>:
|
|
argument is enclosed in quotation mark
|
|
or the checks for double and long failed
|
|
before.
|
|
</member>
|
|
</simplelist>
|
|
Valid operands are:
|
|
'>', '<', '>=', '<=', '==', '!='.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_mixer_mute</option></command>
|
|
<option>(mixer)</option>
|
|
</term>
|
|
<listitem>
|
|
If mixer exists, display everything between $if_mixer_mute and the
|
|
matching $endif. If no mixer is specified, "Master" is used.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_running</option></command>
|
|
<option>(process)</option>
|
|
</term>
|
|
<listitem>
|
|
if PROCESS is running, display everything $if_running
|
|
and the matching $endif. This uses the ``pidof'' command, so the
|
|
-x switch is also supported.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_mounted</option></command>
|
|
<option>(mountpoint)</option>
|
|
</term>
|
|
<listitem>
|
|
if MOUNTPOINT is mounted, display everything between
|
|
$if_mounted and the matching $endif
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_smapi_bat_installed</option></command>
|
|
<option>(INDEX)</option>
|
|
</term>
|
|
<listitem>
|
|
when using smapi, if the battery with index INDEX is
|
|
installed, display everything between
|
|
$if_smapi_bat_installed and the matching $endif
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_up</option></command>
|
|
<option>(interface)</option>
|
|
</term>
|
|
<listitem>
|
|
if INTERFACE exists and is up, display everything between $if_up and the matching $endif
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_updatenr</option></command>
|
|
<option>(updatenr)</option>
|
|
</term>
|
|
<listitem>
|
|
If it's the UPDATENR-th time that conky updates,
|
|
display everything between $if_updatenr and the matching $endif.
|
|
The counter resets when the highest UPDATENR is reached.
|
|
Example : "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$endif"
|
|
shows foo 25% of the time followed by bar 25% of the time followed by nothing the other half of the time.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>imap_messages</option></command>
|
|
<option>(args)</option>
|
|
</term>
|
|
<listitem>
|
|
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] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>imap_unseen</option></command>
|
|
<option>(args)</option>
|
|
</term>
|
|
<listitem>
|
|
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] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>ioscheduler</option></command>
|
|
<option>disk</option>
|
|
</term>
|
|
<listitem>
|
|
Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>kernel</option></command>
|
|
</term>
|
|
<listitem>
|
|
Kernel version
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>laptop_mode</option></command>
|
|
</term>
|
|
<listitem>
|
|
The value of /proc/sys/vm/laptop_mode
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>loadavg</option></command>
|
|
</term>
|
|
<listitem>
|
|
(1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>loadgraph</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
|
|
</term>
|
|
<listitem>
|
|
Load1 average graph, similar to xload, with optional colours in hex, minus the #. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>lines</option></command>
|
|
<option>textfile</option>
|
|
</term>
|
|
<listitem>
|
|
Displays the number of lines in the given file
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>machine</option></command>
|
|
</term>
|
|
<listitem>
|
|
Machine, i686 for example
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mails</option></command>
|
|
<option>(mailbox)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Mail count in the specified mailbox or your mail spool if not.
|
|
Both mbox and maildir type mailboxes are supported. You can
|
|
use a program like fetchmail to get mails from some server
|
|
using your favourite protocol. See also new_mails.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>new_mails</option></command>
|
|
<option>(mailbox)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Unread mail count in the specified mailbox or mail spool if
|
|
not. Both mbox and maildir type mailboxes are supported.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>seen_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails marked as seen in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>unseen_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of new or unseen mails in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>flagged_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails marked as flagged in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>unflagged_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails not marked as flagged in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>forwarded_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails marked as forwarded in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>unforwarded_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails not marked as forwarded in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>replied_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails marked as replied in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>unreplied_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails not marked as replied in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>draft_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails marked as draft in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>trashed_mails</option></command>
|
|
<option>(maildir)</option>
|
|
<option>(interval)</option>
|
|
</term>
|
|
<listitem>
|
|
Number of mails marked as trashed in the specified mailbox or mail spool if
|
|
not. Only maildir type mailboxes are supported, mbox type will return -1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mboxscan</option></command>
|
|
<option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
|
|
</term>
|
|
<listitem>
|
|
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"}
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mem</option></command>
|
|
</term>
|
|
<listitem>
|
|
Amount of memory in use
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>membar</option></command>
|
|
<option>(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Bar that shows amount of memory in use
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>memgauge</option></command>
|
|
<option>(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Gauge that shows amount of memory in use (see cpugauge)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>memgraph</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
|
|
</term>
|
|
<listitem>
|
|
Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>memeasyfree</option></command>
|
|
</term>
|
|
<listitem>
|
|
Amount of free memory including the memory that is very easily freed (buffers/cache)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>memfree</option></command>
|
|
</term>
|
|
<listitem>
|
|
Amount of free memory
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>memmax</option></command>
|
|
</term>
|
|
<listitem>
|
|
Total amount of memory
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>memperc</option></command>
|
|
</term>
|
|
<listitem>
|
|
Percentage of memory in use
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mixer</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Prints the mixer value as reported by the OS. Default mixer is "vol", but you can specify one of the following optional arguments: "vol", "bass", "treble", "synth", "pcm", "speaker", "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin", "phout", "video", "radio", "monitor". Refer to the definition of SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <soundcard.h> (on OpenBSD), or <sys/soundcard.h> to find the exact options available on your system.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mixerbar</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mixerr</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mixerrbar</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mixerl</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mixerlbar</option></command>
|
|
<option>(device)</option>
|
|
</term>
|
|
<listitem>
|
|
Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_state</option></command>
|
|
</term>
|
|
<listitem>
|
|
Current state of MOC; playing, stopped etc.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_file</option></command>
|
|
</term>
|
|
<listitem>
|
|
File name of the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_title</option></command>
|
|
</term>
|
|
<listitem>
|
|
Title of the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_artist</option></command>
|
|
</term>
|
|
<listitem>
|
|
Artist of the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_song</option></command>
|
|
</term>
|
|
<listitem>
|
|
The current song name being played in MOC.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_album</option></command>
|
|
</term>
|
|
<listitem>
|
|
Album of the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_totaltime</option></command>
|
|
</term>
|
|
<listitem>
|
|
Total length of the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_timeleft</option></command>
|
|
</term>
|
|
<listitem>
|
|
Time left in the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_curtime</option></command>
|
|
</term>
|
|
<listitem>
|
|
Current time of the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_bitrate</option></command>
|
|
</term>
|
|
<listitem>
|
|
Bitrate in the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>moc_rate</option></command>
|
|
</term>
|
|
<listitem>
|
|
Rate of the current MOC song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>monitor</option></command>
|
|
</term>
|
|
<listitem>
|
|
Number of the monitor on which conky is running
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>monitor_number</option></command>
|
|
</term>
|
|
<listitem>
|
|
Number of monitors
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_artist</option></command>
|
|
</term>
|
|
<listitem>
|
|
Artist in current MPD song must be enabled at compile
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_album</option></command>
|
|
</term>
|
|
<listitem>
|
|
Album in current MPD song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_bar</option></command>
|
|
<option>(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Bar of mpd's progress
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_bitrate</option></command>
|
|
</term>
|
|
<listitem>
|
|
Bitrate of current song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_status</option></command>
|
|
</term>
|
|
<listitem>
|
|
Playing, stopped, et cetera.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_title</option></command>
|
|
<option>(max length)</option>
|
|
</term>
|
|
<listitem>
|
|
Title of current MPD song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_vol</option></command>
|
|
</term>
|
|
<listitem>
|
|
MPD's volume
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_elapsed</option></command>
|
|
</term>
|
|
<listitem>
|
|
Song's elapsed time
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_length</option></command>
|
|
</term>
|
|
<listitem>
|
|
Song's length
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_percent</option></command>
|
|
</term>
|
|
<listitem>
|
|
Percent of song's progress
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_random</option></command>
|
|
</term>
|
|
<listitem>
|
|
Random status (On/Off)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_repeat</option></command>
|
|
</term>
|
|
<listitem>
|
|
Repeat status (On/Off)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_track</option></command>
|
|
</term>
|
|
<listitem>
|
|
Prints the MPD track field
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_name</option></command>
|
|
</term>
|
|
<listitem>
|
|
Prints the MPD name field
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_file</option></command>
|
|
</term>
|
|
<listitem>
|
|
Prints the file name of the current MPD song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>mpd_smart</option></command>
|
|
<option>(max length)</option>
|
|
</term>
|
|
<listitem>
|
|
Prints the song name in either the form "artist - title" or file name, depending on whats available
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_mpd_playing</option></command>
|
|
</term>
|
|
<listitem>
|
|
if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>nameserver</option></command>
|
|
<option>(index)</option>
|
|
</term>
|
|
<listitem>
|
|
Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>nodename</option></command>
|
|
</term>
|
|
<listitem>
|
|
Hostname
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>nvidia</option></command>
|
|
<option>threshold</option>
|
|
<option>temp</option>
|
|
<option>ambient</option>
|
|
<option>gpufreq</option>
|
|
<option>memfreq</option>
|
|
<option>imagequality</option>
|
|
</term>
|
|
<listitem>
|
|
Nvidia graficcard support for the XNVCtrl library.
|
|
Each option can be shortened to the least significant part.
|
|
Temperatures are printed as float, all other values as integer.
|
|
<simplelist>
|
|
<member><command>threshold</command>:
|
|
the thresholdtemperature at which the gpu slows down
|
|
</member>
|
|
<member><command>temp</command>:
|
|
gives the gpu current temperature
|
|
</member>
|
|
<member><command>ambient</command>:
|
|
gives current air temperature near GPU case
|
|
</member>
|
|
<member><command>gpufreq</command>:
|
|
gives the current gpu frequency
|
|
</member>
|
|
<member><command>memfreq</command>:
|
|
gives the current mem frequency
|
|
</member>
|
|
<member><command>imagequality</command>:
|
|
which imagequality should be choosen by OpenGL applications
|
|
</member>
|
|
</simplelist>
|
|
<para></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>outlinecolor</option></command>
|
|
<option>(color)</option>
|
|
</term>
|
|
<listitem>
|
|
Change outline color
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>pb_battery</option></command>
|
|
<option>item</option>
|
|
</term>
|
|
<listitem>
|
|
If running on Apple powerbook/ibook, display
|
|
information on battery status. The item parameter
|
|
specifies, what information to display. Exactly one item
|
|
must be specified. Valid items are:
|
|
<simplelist>
|
|
<member><command>status</command>:
|
|
Display if battery is fully charged, charging,
|
|
discharging or absent (running on AC)
|
|
</member>
|
|
<member><command>percent</command>:
|
|
Display charge of battery in percent, if
|
|
charging or discharging. Nothing will be
|
|
displayed, if battery is fully charged
|
|
or absent.
|
|
</member>
|
|
<member><command>time</command>:
|
|
Display the time remaining until the battery
|
|
will be fully charged or discharged at current
|
|
rate. Nothing is displayed, if battery is
|
|
absent or if it's present but fully charged
|
|
and not discharging.
|
|
</member>
|
|
</simplelist>
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>platform</option></command>
|
|
<option>(dev) type n</option>
|
|
</term>
|
|
<listitem>
|
|
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' meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>pop3_unseen</option></command>
|
|
<option>(args)</option>
|
|
</term>
|
|
<listitem>
|
|
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] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
|
|
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>pop3_used</option></command>
|
|
<option>(args)</option>
|
|
</term>
|
|
<listitem>
|
|
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] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
|
|
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>pre_exec</option></command>
|
|
<option>shell command</option>
|
|
</term>
|
|
<listitem>
|
|
Executes a shell command one time before conky displays anything and puts output as text.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>processes</option></command>
|
|
</term>
|
|
<listitem>
|
|
Total processes (sleeping and running)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>running_processes</option></command>
|
|
</term>
|
|
<listitem>
|
|
Running processes (not sleeping), requires Linux 2.6
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>scroll</option></command>
|
|
<option>length (step) text</option>
|
|
</term>
|
|
<listitem>
|
|
Scroll 'text' by 'step' characters showing 'length' number of characters at the same time. The text may also contain variables. 'step' is optional and defaults to 1 if not set. If a var creates output on multiple lines then the lines are placed behind each other separated with a '|'-sign. Do NOT use vars that change colors or otherwise affect the design inside a scrolling text. If you want spaces between the start and the end of 'text', place them at the end of 'text' not at the front ("foobar" and " foobar" can both generate "barfoo" but "foobar " will keep the spaces like this "bar foo").
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>shadecolor</option></command>
|
|
<option>(color)</option>
|
|
</term>
|
|
<listitem>
|
|
Change shading color
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>smapi</option></command>
|
|
<option>(ARGS)</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>smapi_bat_bar</option></command>
|
|
<option>(INDEX),(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>smapi_bat_perc</option></command>
|
|
<option>(INDEX)</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>smapi_bat_power</option></command>
|
|
<option>INDEX</option>
|
|
</term>
|
|
<listitem>
|
|
when using smapi, display the current power of the battery with index INDEX in watt. This is a separate variable because the original read out value is being converted from mW. The sign of the output reflects charging (positive) or discharging (negative) state.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>smapi_bat_temp</option></command>
|
|
<option>INDEX</option>
|
|
</term>
|
|
<listitem>
|
|
when using smapi, display the current temperature of the battery with index INDEX in degree Celsius. This is a separate variable because the original read out value is being converted from milli degree Celsius.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>stippled_hr</option></command>
|
|
<option>(space)</option>
|
|
</term>
|
|
<listitem>
|
|
Stippled (dashed) horizontal line
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>swapbar</option></command>
|
|
<option>(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Bar that shows amount of swap in use
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>swap</option></command>
|
|
</term>
|
|
<listitem>
|
|
Amount of swap in use
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>swapmax</option></command>
|
|
</term>
|
|
<listitem>
|
|
Total amount of swap
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>swapperc</option></command>
|
|
</term>
|
|
<listitem>
|
|
Percentage of swap in use
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>sysname</option></command>
|
|
</term>
|
|
<listitem>
|
|
System name, Linux for example
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>tcp_portmon</option></command>
|
|
<option>port_begin port_end item (index)</option>
|
|
<emphasis>(ip4 only at present)</emphasis>
|
|
</term>
|
|
<listitem>
|
|
TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
|
|
<simplelist>
|
|
<member><command>count</command> - total number of connections in the range
|
|
</member>
|
|
<member><command>rip</command> - remote ip address
|
|
</member>
|
|
<member><command>rhost</command> - remote host name
|
|
</member>
|
|
<member><command>rport</command> - remote port number
|
|
</member>
|
|
<member><command>rservice</command> - remote service name from /etc/services
|
|
</member>
|
|
<member><command>lip</command> - local ip address
|
|
</member>
|
|
<member><command>lhost</command> - local host name
|
|
</member>
|
|
<member><command>lport</command> - local port number
|
|
</member>
|
|
<member><command>lservice</command> - local service name from /etc/services
|
|
</member>
|
|
</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.
|
|
<simplelist>
|
|
<member>Examples:</member>
|
|
<member><command>${tcp_portmon 6881 6999 count}</command> -
|
|
displays the number of connections in the bittorrent port range</member>
|
|
<member><command>${tcp_portmon 22 22 rip 0}</command> -
|
|
displays the remote host ip of the first sshd connection</member>
|
|
<member><command>${tcp_portmon 22 22 rip 9}</command> -
|
|
displays the remote host ip of the tenth sshd connection</member>
|
|
<member><command>${tcp_portmon 1 1024 rhost 0}</command> -
|
|
displays the remote host name of the first connection on a privileged port</member>
|
|
<member><command>${tcp_portmon 1 1024 rport 4}</command> -
|
|
displays the remote host port of the fifth connection on a privileged port</member>
|
|
<member><command>${tcp_portmon 1 65535 lservice 14}</command> -
|
|
displays the local service name of the fifteenth connection in the range of all ports</member>
|
|
</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.
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>texeci</option></command>
|
|
<option>interval command</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>offset</option></command>
|
|
<option>(pixels)</option>
|
|
</term>
|
|
<listitem>
|
|
Move text over by N pixels. See also $voffset.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>rss</option></command>
|
|
<option>url delay_in_minutes action (num_par (spaces_in_front))</option>
|
|
</term>
|
|
<listitem>
|
|
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 (when using this action and spaces_in_front is given conky places that many spaces in front of each item).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>tab</option></command>
|
|
<option>(width, (start))</option>
|
|
</term>
|
|
<listitem>
|
|
Puts a tab of the specified width, starting from column 'start'. The unit is pixels for both arguments.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>tail</option></command>
|
|
<option>logfile lines (interval)</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>templateN</option></command>
|
|
<option>(arg1)</option>
|
|
<option>(arg2)</option>
|
|
<option>(arg3 ...)</option>
|
|
</term>
|
|
<listitem>
|
|
Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
|
|
applying substitutions as described in the documentation of the corresponding configuration variable.
|
|
The number of arguments is optional, but must match the highest referred index in the template. You can use the
|
|
same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
|
|
to contain a whitespace. Also simple nesting of templates is possible this way.
|
|
<para></para></listitem>
|
|
<listitem>
|
|
Here are some examples of template definitions:
|
|
<simplelist>
|
|
<member>template0 $\1\2</member>
|
|
<member>template1 \1: ${fs_used \2} / ${fs_size \2}</member>
|
|
<member>template2 \1 \2</member>
|
|
</simplelist>
|
|
The following list shows sample usage of the templates defined above,
|
|
with the equivalent syntax when not using any template at all:
|
|
<table>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row rowsep="1"><entry>using template</entry><entry>same without template</entry></row>
|
|
</thead>
|
|
<tbody>
|
|
<row><entry>${template0 node name}</entry><entry>$nodename</entry></row>
|
|
<row><entry>${template1 root /}</entry><entry>root: ${fs_free /} / ${fs_size /}</entry></row>
|
|
<row>
|
|
<entry><programlisting>${template1 ${template2\ disk\ root} /}</programlisting></entry>
|
|
<entry><programlisting>disk root: ${fs_free /} / ${fs_size /}</programlisting></entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>time</option></command>
|
|
<option>(format)</option>
|
|
</term>
|
|
<listitem>
|
|
Local time, see man strftime to get more information about format
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>utime</option></command>
|
|
<option>(format)</option>
|
|
</term>
|
|
<listitem>
|
|
Display time in UTC (universal coordinate time).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>tztime</option></command>
|
|
<option>(timezone) (format)</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>totaldown</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>top</option></command>
|
|
<option>type, num</option>
|
|
</term>
|
|
<listitem>
|
|
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.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>top_mem</option></command>
|
|
<option>type, num</option>
|
|
</term>
|
|
<listitem>
|
|
Same as top, except sorted by mem usage instead of cpu
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>top_time</option></command>
|
|
<option>type, num</option>
|
|
</term>
|
|
<listitem>
|
|
Same as top, except sorted by total CPU time instead of current CPU usage
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>totalup</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Total upload, this one too, may overflow
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>updates</option></command>
|
|
<option>Number of updates</option>
|
|
</term>
|
|
<listitem>
|
|
for debugging
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>upspeed</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Upload speed in KiB
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>upspeedf</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Upload speed in KiB with one decimal
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>upspeedgraph</option></command>
|
|
<option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
|
|
</term>
|
|
<listitem>
|
|
Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>uptime</option></command>
|
|
</term>
|
|
<listitem>
|
|
Uptime
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>uptime_short</option></command>
|
|
</term>
|
|
<listitem>
|
|
Uptime in a shorter format
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>user_number</option></command>
|
|
</term>
|
|
<listitem>
|
|
Number of users logged in
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>user_names</option></command>
|
|
</term>
|
|
<listitem>
|
|
Lists the names of the users logged in
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>user_terms</option></command>
|
|
</term>
|
|
<listitem>
|
|
Lists the consoles in use
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>user_times</option></command>
|
|
</term>
|
|
<listitem>
|
|
Lists how long users have been logged in for
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>voffset</option></command>
|
|
<option>(pixels)</option>
|
|
</term>
|
|
<listitem>
|
|
Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>voltage_mv</option></command>
|
|
<option>(n)</option>
|
|
</term>
|
|
<listitem>
|
|
Returns CPU #n's voltage in mV. CPUs are
|
|
counted from 1. If omitted, the parameter
|
|
defaults to 1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>voltage_v</option></command>
|
|
<option>(n)</option>
|
|
</term>
|
|
<listitem>
|
|
Returns CPU #n's voltage in V. CPUs are
|
|
counted from 1. If omitted, the parameter
|
|
defaults to 1.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_essid</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless access point ESSID (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_mode</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_bitrate</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless bitrate (ie 11 Mb/s) (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_ap</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless access point MAC address (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_link_qual</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless link quality (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_link_qual_max</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless link quality maximum value (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_link_qual_perc</option></command>
|
|
<option>net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless link quality in percents (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>wireless_link_bar</option></command>
|
|
<option>(height), (width) net</option>
|
|
</term>
|
|
<listitem>
|
|
Wireless link quality bar (Linux only)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>words</option></command>
|
|
<option>textfile</option>
|
|
</term>
|
|
<listitem>
|
|
Displays the number of words in the given file
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_artist</option></command>
|
|
</term>
|
|
<listitem>
|
|
Artist in current XMMS2 song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_album</option></command>
|
|
</term>
|
|
<listitem>
|
|
Album in current XMMS2 song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_title</option></command>
|
|
</term>
|
|
<listitem>
|
|
Title in current XMMS2 song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_genre</option></command>
|
|
</term>
|
|
<listitem>
|
|
Genre in current XMMS2 song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_comment</option></command>
|
|
</term>
|
|
<listitem>
|
|
Comment in current XMMS2 song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_url</option></command>
|
|
</term>
|
|
<listitem>
|
|
Full path to current song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_tracknr</option></command>
|
|
</term>
|
|
<listitem>
|
|
Track number in current XMMS2 song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_bitrate</option></command>
|
|
</term>
|
|
<listitem>
|
|
Bitrate of current song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_id</option></command>
|
|
</term>
|
|
<listitem>
|
|
XMMS2 id of current song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_duration</option></command>
|
|
</term>
|
|
<listitem>
|
|
Duration of current song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_elapsed</option></command>
|
|
</term>
|
|
<listitem>
|
|
Song's elapsed time
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_size</option></command>
|
|
</term>
|
|
<listitem>
|
|
Size of current song
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_percent</option></command>
|
|
</term>
|
|
<listitem>
|
|
Percent of song's progress
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_date</option></command>
|
|
</term>
|
|
<listitem>
|
|
Returns song's date.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_playlist</option></command>
|
|
</term>
|
|
<listitem>
|
|
Returns the XMMS2 playlist.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_timesplayed</option></command>
|
|
</term>
|
|
<listitem>
|
|
Number of times a song was played (presumably).
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_status</option></command>
|
|
</term>
|
|
<listitem>
|
|
XMMS2 status (Playing, Paused, Stopped, or Disconnected)
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_bar</option></command>
|
|
<option>(height),(width)</option>
|
|
</term>
|
|
<listitem>
|
|
Bar of XMMS2's progress
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>xmms2_smart</option></command>
|
|
</term>
|
|
<listitem>
|
|
Prints the song name in either the form "artist - title" or file name, depending on whats available
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>if_xmms2_connected</option></command>
|
|
</term>
|
|
<listitem>
|
|
Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>eve</option></command>
|
|
<option>api_userid api_key character_id</option>
|
|
</term>
|
|
<listitem>
|
|
Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>
|
|
<command><option>endif</option></command>
|
|
<option></option>
|
|
</term>
|
|
<listitem>
|
|
Ends an $if block.
|
|
<para></para></listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|