\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
-.TH conky 1 2008-12-07 "" ""
+.TH conky 1 2009-03-15 "" ""
.SH NAME
conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
.SH SYNOPSIS
You might want to copy it to $HOME/.conkyrc and then start modifying it.
Other configs can be found at http://conky.sf.net/
.TP
+\fB\*(T<\fBalias\fR\*(T>\fR
+Use this to create aliases of variables. The first argument is the new name, the second the old name, and the other arguments are passed on to the variable. Example: If you want to use $alpha instead of ${beta gamma delta} then you have to write the following: alias alpha beta gamma delta . PS: Instead of creating an alias in the config you can also use environment variables. Example: Start conky like this: alpha="beta gamma delta" conky
+
+.TP
\fB\*(T<\fBalignment\fR\*(T>\fR
Aligned position on screen, may be top_left, top_right, top_middle, bottom_left, bottom_right, bottom_middle, middle_left, middle_right, or none (also can be abreviated as tl, tr, tm, bl, br, bm, ml, mr)
If true, cpu in top will show usage of one processor's power. If false, cpu in top will show the usage of all processors' power combined.
.TP
+\fB\*(T<\fBdefault_bar_size\fR\*(T>\fR
+Specify a default width and height for bars. Example: 'default_bar_size 0 6'. This is particularly useful for execbar and execibar as they do not take size arguments
+
+.TP
+\fB\*(T<\fBdefault_graph_size\fR\*(T>\fR
+Specify a default width and height for graphs. Example: 'default_graph_size 0 25'. This is particularly useful for execgraph and execigraph as they do not take size arguments
+
+.TP
+\fB\*(T<\fBdefault_gauge_size\fR\*(T>\fR
+Specify a default width and height for gauges. Example: 'default_gauge_size 25 25'. This is particularly useful for execgauge and execigauge as they do not take size arguments
+
+.TP
\fB\*(T<\fBdefault_color\fR\*(T>\fR
Default color and border color
Print text to stdout.
.TP
+\fB\*(T<\fBout_to_stderr\fR\*(T>\fR
+Print text to stderr.
+
+.TP
+\fB\*(T<\fBout_to_x\fR\*(T>\fR
+When set to no, there will be no output in X (useful when you also use things like out_to_console).
+If you set it to no, make sure that it's placed before all other X-related setting (take the first
+line of your configfile to be sure). Default value is yes
+
+.TP
+\fB\*(T<\fBoverwrite_file\fR\*(T>\fR
+Overwrite the file given as argument.
+
+.TP
+\fB\*(T<\fBappend_file\fR\*(T>\fR
+Append the file given as argument.
+
+.TP
\fB\*(T<\fBpad_percents\fR\*(T>\fR
Pad percentages to this many decimals (0 = no padding)
.TP
\fB\*(T<\fBTEXT\fR\*(T>\fR
-After this begins text to be formatted on screen
+After this begins text to be formatted on screen. Backslash (\e) escapes newlines in the text section. This can be useful for cleaning up config files where conky is used to pipe input to dzen2.
.SH VARIABLES
Colors are parsed using XParsecolor(), there might be a list of them:
Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
.TP
+\fB\*(T<\fBbattery_short\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
+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.
+
+.TP
\fB\*(T<\fBbattery_bar\fR\*(T>\fR \*(T<\fB(height),(width) (num)\fR\*(T>
Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
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.
.TP
-\fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
+\fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpuN) (height),(width)\fR\*(T>
Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
.TP
-\fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fBnormal|log (cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T>
+\fB\*(T<\fBcpugauge\fR\*(T>\fR \*(T<\fB(cpuN) (height),(width)\fR\*(T>
+Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively. See $cpu for more info on SMP.
+
+.TP
+\fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpuN) ("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
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".
.TP
Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
.TP
-\fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fBnormal|log (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
+\fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T>
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".
.TP
Displays current disk IO for reads. Device as in diskio.
.TP
-\fB\*(T<\fBdiskiograph_read\fR\*(T>\fR \*(T<\fBnormal|log (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
+\fB\*(T<\fBdiskiograph_read\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T>
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".
.TP
Displays current disk IO for writes. Device as in diskio.
.TP
-\fB\*(T<\fBdiskiograph_write\fR\*(T>\fR \*(T<\fBnormal|log (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
+\fB\*(T<\fBdiskiograph_write\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T>
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".
.TP
Download speed in KiB with one decimal
.TP
-\fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnormal|log net (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
+\fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T>
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".
.TP
Total size of system entropy pool for crypto freaks
.TP
+\fB\*(T<\fBeval\fR\*(T>\fR \*(T<\fBstring\fR\*(T>
+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.
+
+.TP
\fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
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.
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.
.TP
-\fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB(normal|log) command\fR\*(T>
+\fB\*(T<\fBexecgauge\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
+Same as exec, except if the first value return is a value between 0-100, it will use that number for a gauge. The size for the gauge is currently fixed, but you may change that for the future conky release.
+
+.TP
+\fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command\fR\*(T>
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.
.TP
.TP
\fB\*(T<\fBif_empty\fR\*(T>\fR \*(T<\fB(var)\fR\*(T>
-if conky variable VAR is empty, display everything between $if_empty and the matching $endif
+if conky variable VAR is empty, display everything
+between $if_empty and the matching $endif
.TP
-\fB\*(T<\fBif_gw\fR\*(T>\fR
-if there is at least one default gateway, display everything between $if_gw and the matching $endif
+\fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fBfile (string)\fR\*(T>
+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.
.TP
-\fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
-if PROCESS is running, display everything $if_running and the matching $endif
+\fB\*(T<\fBif_gw\fR\*(T>\fR
+if there is at least one default gateway, display
+everything between $if_gw and the matching $endif
+
+.TP
+\fB\*(T<\fBif_match\fR\*(T>\fR \*(T<\fBexpression\fR\*(T>
+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:
+
+\fBdouble\fR:
+argument consists of only digits and a
+single dot.
+.br
+\fBlong\fR:
+argument consists of only digits.
+.br
+\fBstring\fR:
+argument is enclosed in quotation mark
+or the checks for double and long failed
+before.
+
+Valid operands are:
+\&'>', '<', '>=', '<=', '==', '!='.
.TP
-\fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fBfile (string)\fR\*(T>
-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.
+\fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
+if PROCESS is running, display everything $if_running
+and the matching $endif. This uses the ``pidof'' command, so the
+-x switch is also supported.
.TP
\fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T>
-if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
+if MOUNTPOINT is mounted, display everything between
+$if_mounted and the matching $endif
.TP
\fB\*(T<\fBif_smapi_bat_installed\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T>
-when using smapi, if the battery with index INDEX is installed, display everything between $if_smapi_bat_installed and the matching $endif
+when using smapi, if the battery with index INDEX is
+installed, display everything between
+$if_smapi_bat_installed and the matching $endif
.TP
\fB\*(T<\fBif_up\fR\*(T>\fR \*(T<\fB(interface)\fR\*(T>
if INTERFACE exists and is up, display everything between $if_up and the matching $endif
.TP
+\fB\*(T<\fBif_updatenr\fR\*(T>\fR \*(T<\fB(updatenr)\fR\*(T>
+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.
+
+.TP
\fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
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.
(1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
.TP
-\fB\*(T<\fBloadgraph\fR\*(T>\fR \*(T<\fBnormal|log (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T>
+\fB\*(T<\fBloadgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
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".
.TP
using your favourite protocol. See also new_mails.
.TP
+\fB\*(T<\fBnew_mails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+Unread mail count in the specified mailbox or mail spool if
+not. Both mbox and maildir type mailboxes are supported.
+
+.TP
+\fB\*(T<\fBseen_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBunseen_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBflagged_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBunflagged_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBforwarded_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBunforwarded_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBreplied_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBunreplied_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBdraft_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
+\fB\*(T<\fBtrashed_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
+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.
+
+.TP
\fB\*(T<\fBmboxscan\fR\*(T>\fR \*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T>
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"}
Bar that shows amount of memory in use
.TP
-\fB\*(T<\fBmemgraph\fR\*(T>\fR \*(T<\fBnormal|log (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T>
+\fB\*(T<\fBmemgauge\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
+Gauge that shows amount of memory in use (see cpugauge)
+
+.TP
+\fB\*(T<\fBmemgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
.TP
Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
.TP
-\fB\*(T<\fBnew_mails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
-Unread mail count in the specified mailbox or mail spool if
-not. Both mbox and maildir type mailboxes are supported.
-
-.TP
\fB\*(T<\fBnodename\fR\*(T>\fR
Hostname
.TP
-\fB\*(T<\fBnvidia\fR\*(T>\fR \*(T<\fBthreshold\fR\*(T> \*(T<\fBtemp\fR\*(T> \*(T<\fBgpufreq\fR\*(T> \*(T<\fBmemfreq\fR\*(T> \*(T<\fBimagequality\fR\*(T>
+\fB\*(T<\fBnvidia\fR\*(T>\fR \*(T<\fBthreshold\fR\*(T> \*(T<\fBtemp\fR\*(T> \*(T<\fBambient\fR\*(T> \*(T<\fBgpufreq\fR\*(T> \*(T<\fBmemfreq\fR\*(T> \*(T<\fBimagequality\fR\*(T>
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.
\fBtemp\fR:
gives the gpu current temperature
.br
+\fBambient\fR:
+gives current air temperature near GPU case
+.br
\fBgpufreq\fR:
gives the current gpu frequency
.br
Same as top, except sorted by mem usage instead of cpu
.TP
+\fB\*(T<\fBtop_time\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
+Same as top, except sorted by total CPU time instead of current CPU usage
+
+.TP
\fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
Total upload, this one too, may overflow
Upload speed in KiB with one decimal
.TP
-\fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fBnormal|log net (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
+\fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T>
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".
.TP
.PP
#conky on irc.freenode.net
.SH COPYING
-Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al.
+Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al.
Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy).
All code written since the fork of torsmo is licensed under the GPL (see LICENSE.GPL for a copy), except where noted differently (such as in portmon code, timed thread code, and audacious code which are LGPL, and prss which is an MIT-style license).
.SH AUTHORS
projects / monky / blobdiff