update README and manpage
[monky] / doc / conky.1
1 '\" t -*- coding: us-ascii -*-
2 .if \n(.g .ds T< \\FC
3 .if \n(.g .ds T> \\F[\n[.fam]]
4 .de URL
5 \\$2 \(la\\$1\(ra\\$3
6 ..
7 .if \n(.g .mso www.tmac
8 .TH conky 1 2008-12-07 "" ""
9 .SH NAME
10 conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
11 .SH SYNOPSIS
12 'nh
13 .fi
14 .ad l
15 \fBconky\fR \kx
16 .if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
17 'in \n(.iu+\nxu
18 [\fIoptions\fR]
19 'in \n(.iu-\nxu
20 .ad b
21 'hy
22 .SH DESCRIPTION
23 Conky is a system monitor for X originally based on torsmo.
24 Since its inception, Conky has changed significantly from its predecessor, while maintaining
25 simplicity and configurability. Conky can display just about anything, either
26 on your root desktop or in its own window. Not only does Conky have many
27 built-in objects, it can also display just about any piece of information by
28 using scripts and other external programs.
29 .PP
30 Conky has more than 250 built in objects, including support for
31 a plethora of OS stats (uname, uptime, CPU usage, mem usage, disk
32 usage, "top" like process stats, and network monitoring, just to name a few),
33 built in IMAP and POP3 support, built in support for many popular
34 music players (MPD, XMMS2, BMPx, Audacious), and much much more.
35 Conky can display this info either as text, or using simple progress
36 bars and graph widgets, with different fonts and colours.
37 .PP
38 We are always looking for help, whether its reporting bugs, writing patches, or writing docs.
39 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches,
40 or stop by #conky on irc.freenode.net if you have questions or want to contribute.
41 .PP
42 Thanks for your interest in Conky.
43 .SH COMPILING
44 For users compiling from source on a binary distro, make sure you have the X development
45 libraries installed. This should be a package along the lines of "libx11-dev" or
46 "xorg-x11-dev" for X11 libs, and similar "-dev" format for the other libs required (depending
47 on your configure options).
48 .PP
49 Conky has (for some time) been available in the repositories of most popular distributions.
50 Here are some installation instructions for a few:
51 .PP
52 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
53 There is also usually an up-to-date ebuild within Conky's package or in the git repo.
54 .PP
55 Debian, etc. users -- Conky should be in your repositories, and can be installed by doing
56 "aptitude install conky".
57 .PP
58 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
59 .TP 
60 \fB\*(T<\fBsh autogen.sh\fR\*(T>\fR \*(T<\fB# Only required if building from the git repo\fR\*(T> 
61 .TP 
62 \fB\*(T<\fB\&./configure \fR\*(T>\fR\*(T<\fB\-\-prefix=/usr \-\-mandir=/usr/share/man \-\-infodir=/usr/share/info \-\-datadir=/usr/share \-\-sysconfdir=/etc \-\-localstatedir=/var/lib \-\-disable\-own\-window \-\-enable\-audacious[=yes|no|legacy] \-\-enable\-bmpx \-\-disable\-hddtemp \-\-disable\-mpd \-\-enable\-xmms2 \-\-disable\-portmon \-\-disable\-network \-\-enable\-debug \-\-disable\-x11 \-\-disable\-double\-buffer \-\-disable\-xdamage \-\-disable\-xft\fR\*(T> 
63 .TP 
64 \fB\*(T<\fBmake\fR\*(T>\fR 
65 .TP 
66 \fB\*(T<\fBmake install\fR\*(T>\fR \*(T<\fB# Optional\fR\*(T> 
67 .TP 
68 \fB\*(T<\fBsrc/conky\fR\*(T>\fR 
69 .PP
70 Conky has been tested to be compatible with C99 C, however it has not been tested
71 with anything other than gcc, and is not guaranteed to work with other compilers.
72 .PP
73 .SH "YOU SHOULD KNOW"
74 Conky is generally very good on resources. That said, the more you try to make Conky
75 do, the more resources it is going to consume.
76 .PP
77 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
78 Saves you the trouble of having to kill and then restart. You can now also do the same with SIGHUP.
79 .SH OPTIONS
80 Command line options override configurations defined in configuration file.
81 .TP 
82 \fB\*(T<\fB\-v | \-V | \-\-version\fR\*(T>\fR
83 Prints version and exits
84
85 .TP 
86 \fB\*(T<\fB\-q | \-\-quiet\fR\*(T>\fR
87 Run Conky in 'quiet mode' (ie. no output)
88
89 .TP 
90 \fB\*(T<\fB\-a | \-\-alignment=\fR\*(T>\fR\*(T<\fBALIGNMENT\fR\*(T>
91 Text alignment on screen, {top,bottom,middle}_{left,right,middle} or none
92
93 .TP 
94 \fB\*(T<\fB\-b | \-\-double\-buffer\fR\*(T>\fR
95 Use double buffering (eliminates "flicker")
96
97 .TP 
98 \fB\*(T<\fB\-c | \-\-config=\fR\*(T>\fR\*(T<\fBFILE\fR\*(T>
99 Config file to load instead of $HOME/.conkyrc
100
101 .TP 
102 \fB\*(T<\fB\-d | \-\-daemonize\fR\*(T>\fR
103 Daemonize Conky, aka fork to background
104
105 .TP 
106 \fB\*(T<\fB\-f | \-\-font=\fR\*(T>\fR\*(T<\fBFONT\fR\*(T>
107 Font to use
108
109 .TP 
110 \fB\*(T<\fB\-h | \-\-help\fR\*(T>\fR
111 Prints command line help and exits
112
113 .TP 
114 \fB\*(T<\fB\-o | \-\-own\-window\fR\*(T>\fR
115 Create own window to draw
116
117 .TP 
118 \fB\*(T<\fB\-t | \-\-text=\fR\*(T>\fR\*(T<\fBTEXT\fR\*(T>
119 Text to render, remember single quotes, like -t ' $uptime '
120
121 .TP 
122 \fB\*(T<\fB\-u | \-\-interval=\fR\*(T>\fR\*(T<\fBSECONDS\fR\*(T>
123 Update interval
124
125 .TP 
126 \fB\*(T<\fB\-w | \-\-window\-id=\fR\*(T>\fR\*(T<\fBWIN_ID\fR\*(T>
127 Window id to draw
128
129 .TP 
130 \fB\*(T<\fB\-x \fR\*(T>\fR\*(T<\fBX_COORDINATE\fR\*(T>
131 X position
132
133 .TP 
134 \fB\*(T<\fB\-y \fR\*(T>\fR\*(T<\fBY_COORDINATE\fR\*(T>
135 Y position
136
137 .TP 
138 \fB\*(T<\fB\-i \fR\*(T>\fR\*(T<\fBCOUNT\fR\*(T>
139 Number of times to update Conky (and quit)
140
141 .SH "CONFIGURATION SETTINGS"
142 Default configuration file location is $HOME/.conkyrc or
143 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
144 and you can find the sample config file there (/etc/conky/conky.conf).
145 .PP
146 You might want to copy it to $HOME/.conkyrc and then start modifying it.
147 Other configs can be found at http://conky.sf.net/
148 .TP 
149 \fB\*(T<\fBalignment\fR\*(T>\fR
150 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)
151
152 .TP 
153 \fB\*(T<\fBbackground\fR\*(T>\fR
154 Boolean value, if true, Conky will be forked to background when started
155
156 .TP 
157 \fB\*(T<\fBborder_margin\fR\*(T>\fR
158 Border margin in pixels
159
160 .TP 
161 \fB\*(T<\fBborder_width\fR\*(T>\fR
162 Border width in pixels
163
164 .TP 
165 \fB\*(T<\fBcolorN\fR\*(T>\fR
166 Predefine a color for use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively. When specifying the color value in hex, omit the leading hash (#).
167
168 .TP 
169 \fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
170 The number of samples to average for CPU monitoring
171
172 .TP 
173 \fB\*(T<\fBtop_cpu_separate\fR\*(T>\fR
174 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.
175
176 .TP 
177 \fB\*(T<\fBdefault_color\fR\*(T>\fR
178 Default color and border color
179
180 .TP 
181 \fB\*(T<\fBdefault_outline_color\fR\*(T>\fR
182 Default outline color
183
184 .TP 
185 \fB\*(T<\fBdefault_shade_color\fR\*(T>\fR
186 Default shading color and border's shading color
187
188 .TP 
189 \fB\*(T<\fBdouble_buffer\fR\*(T>\fR
190 Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
191
192 .TP 
193 \fB\*(T<\fBdraw_borders\fR\*(T>\fR
194 Draw borders around text?
195
196 .TP 
197 \fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
198 Draw borders around graphs?
199
200 .TP 
201 \fB\*(T<\fBdraw_outline\fR\*(T>\fR
202 Draw outlines?
203
204 .TP 
205 \fB\*(T<\fBdraw_shades\fR\*(T>\fR
206 Draw shades?
207
208 .TP 
209 \fB\*(T<\fBfont\fR\*(T>\fR
210 Font name in X, xfontsel can be used to get a nice font
211
212 .TP 
213 \fB\*(T<\fBgap_x\fR\*(T>\fR
214 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
215 e.g. gap_x 10
216
217 .TP 
218 \fB\*(T<\fBgap_y\fR\*(T>\fR
219 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
220 e.g. gap_y 10.
221
222 .TP 
223 \fB\*(T<\fBif_up_strictness\fR\*(T>\fR
224 How strict should if_up be when testing an interface for being up? The value is one of up, link or address, to check for the interface being solely up, being up and having link or being up, having link and an assigned IP address.
225
226 .TP 
227 \fB\*(T<\fBimap\fR\*(T>\fR
228 Default global IMAP server. Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command] [-r retries]". Default port is 143, default folder is 'INBOX', 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.
229
230 .TP 
231 \fB\*(T<\fBmail_spool\fR\*(T>\fR
232 Mail spool for mail checking
233
234 .TP 
235 \fB\*(T<\fBmax_port_monitor_connections\fR\*(T>\fR
236 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
237
238 .TP 
239 \fB\*(T<\fBmax_specials\fR\*(T>\fR
240 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
241
242 .TP 
243 \fB\*(T<\fBmax_user_text\fR\*(T>\fR \*(T<\fBbytes\fR\*(T> 
244 Maximum size of user text buffer, i.e. layout below TEXT line in config file
245 (default is 16384 bytes)
246
247 .TP 
248 \fB\*(T<\fBtext_buffer_size\fR\*(T>\fR \*(T<\fBbytes\fR\*(T> 
249 Size of the standard text buffer (default is 256 bytes). This buffer is used for intermediary text, such as individual lines, output from $exec vars, and various other variables. Increasing the size of this buffer can drastically reduce Conky's performance, but will allow for more text display per variable. The size of this buffer cannot be smaller than the default value of 256 bytes.
250
251 .TP 
252 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T> 
253 Maximum width of window
254
255 .TP 
256 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T> 
257 Minimum size of window
258
259 .TP 
260 \fB\*(T<\fBmpd_host\fR\*(T>\fR
261 Host of MPD server
262
263 .TP 
264 \fB\*(T<\fBmpd_port\fR\*(T>\fR
265 Port of MPD server
266
267 .TP 
268 \fB\*(T<\fBmpd_password\fR\*(T>\fR
269 MPD server password
270
271 .TP 
272 \fB\*(T<\fBmusic_player_interval\fR\*(T>\fR
273 Music player thread update interval (defaults to Conky's update interval)
274
275 .TP 
276 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
277 The number of samples to average for net data
278
279 .TP 
280 \fB\*(T<\fBno_buffers\fR\*(T>\fR
281 Substract (file system) buffers from used memory?
282
283 .TP 
284 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
285 Force UTF8? requires XFT
286
287 .TP 
288 \fB\*(T<\fBown_window\fR\*(T>\fR
289 Boolean, create own window to draw?
290
291 .TP 
292 \fB\*(T<\fBown_window_class\fR\*(T>\fR
293 Manually set the WM_CLASS name. Defaults to "Conky".
294
295 .TP 
296 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T> 
297 If own_window_transparent no, set a specified background colour (defaults to black). Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
298
299 .TP 
300 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T> 
301 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
302 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
303 If you use own_window_type override, window manager hints have no meaning and are ignored.
304
305 .TP 
306 \fB\*(T<\fBown_window_title\fR\*(T>\fR
307 Manually set the window name. Defaults to "<hostname> - conky".
308
309 .TP 
310 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
311 Boolean, set pseudo-transparency?
312
313 .TP 
314 \fB\*(T<\fBown_window_type\fR\*(T>\fR
315 if own_window is yes, you may specify type normal, desktop, dock or override (default: normal).
316 Desktop windows are special windows that have no window decorations; are always visible
317 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
318 Override windows are not under the control of the window manager. Hints are ignored. This type
319 of window can be useful for certain situations.
320
321 .TP 
322 \fB\*(T<\fBout_to_console\fR\*(T>\fR 
323 Print text to stdout.
324
325 .TP 
326 \fB\*(T<\fBout_to_stderr\fR\*(T>\fR 
327 Print text to stderr.
328
329 .TP 
330 \fB\*(T<\fBout_to_x\fR\*(T>\fR 
331 When set to no, there will be no output in X (useful when you also use things like out_to_console).
332 If you set it to no, make sure that it's placed before all other X-related setting (take the first
333 line of your configfile to be sure). Default value is yes
334
335 .TP 
336 \fB\*(T<\fBoverwrite_file\fR\*(T>\fR 
337 Overwrite the file given as argument.
338
339 .TP 
340 \fB\*(T<\fBappend_file\fR\*(T>\fR 
341 Append the file given as argument.
342
343 .TP 
344 \fB\*(T<\fBpad_percents\fR\*(T>\fR
345 Pad percentages to this many decimals (0 = no padding)
346
347 .TP 
348 \fB\*(T<\fBpop3\fR\*(T>\fR
349 Default global POP3 server. 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.
350
351 .TP 
352 \fB\*(T<\fBshort_units\fR\*(T>\fR
353 Shortens units to a single character (kiB->k, GiB->G, etc.). Default is off.
354
355 .TP 
356 \fB\*(T<\fBshow_graph_scale\fR\*(T>\fR
357 Shows the maximum value in scaled graphs.
358
359 .TP 
360 \fB\*(T<\fBshow_graph_range\fR\*(T>\fR
361 Shows the time range covered by a graph.
362
363 .TP 
364 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
365 Border stippling (dashing) in pixels
366
367 .TP 
368 \fB\*(T<\fBtemperature_unit\fR\*(T>\fR
369 Desired output unit of all objects displaying a temperature.
370 Parameters are either "fahrenheit" or "celsius". The default
371 unit is degree Celsius.
372
373 .TP 
374 \fB\*(T<\fBtemplateN\fR\*(T>\fR
375 Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
376 The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
377 but before some substitutions are applied:
378
379 \&'\en' -> newline
380 .br
381 \&'\e\e' -> backslash
382 .br
383 \&'\e ' -> space
384 .br
385 \&'\eN' -> template argument N
386
387 .TP 
388 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
389 Total number of times for Conky to update before quitting. Zero makes Conky run forever
390
391 .TP 
392 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
393 Update interval in seconds
394
395 .TP 
396 \fB\*(T<\fBuppercase\fR\*(T>\fR
397 Boolean value, if true, text is rendered in upper case
398
399 .TP 
400 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
401 Adds spaces around certain objects to stop them from moving other things around. Arguments are left, right, and none (default). The old true/false values are deprecated and default to right/none respectively. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
402
403 .TP 
404 \fB\*(T<\fBuse_xft\fR\*(T>\fR
405 Use Xft (anti-aliased font and stuff)
406
407 .TP 
408 \fB\*(T<\fBxftalpha\fR\*(T>\fR
409 Alpha of Xft font. Must be a value at or between 1 and 0.
410
411 .TP 
412 \fB\*(T<\fBxftfont\fR\*(T>\fR
413 Xft font to use.
414
415 .TP 
416 \fB\*(T<\fBTEXT\fR\*(T>\fR
417 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.
418
419 .SH VARIABLES
420 Colors are parsed using XParsecolor(), there might be a list of them:
421 /usr/share/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
422 Color can be also in #rrggbb format (hex).
423 .TP 
424 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> 
425 IP address for an interface, or "No Address" if no address is assigned.
426
427 .TP 
428 \fB\*(T<\fBaddrs\fR\*(T>\fR \*(T<\fBinterface\fR\*(T> 
429 IP addresses for an interface (if one - works like addr). Linux only.
430
431 .TP 
432 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR 
433 ACPI ac adapter state.
434
435 .TP 
436 \fB\*(T<\fBacpifan\fR\*(T>\fR 
437 ACPI fan state
438
439 .TP 
440 \fB\*(T<\fBacpitemp\fR\*(T>\fR 
441 ACPI temperature in C.
442
443 .TP 
444 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR 
445 CPU temperature from therm_adt746x
446
447 .TP 
448 \fB\*(T<\fBadt746xfan\fR\*(T>\fR 
449 Fan speed from therm_adt746x
450
451 .TP 
452 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
453 Right-justify text, with space of N
454
455 .TP 
456 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
457 Align text to centre
458
459 .TP 
460 \fB\*(T<\fBapm_adapter\fR\*(T>\fR 
461 Display APM AC adapter status (FreeBSD only)
462
463 .TP 
464 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR 
465 Display APM battery life in percent (FreeBSD only)
466
467 .TP 
468 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR 
469 Display remaining APM battery life in hh:mm:ss or "unknown" if
470 AC adapterstatus is on-line or charging (FreeBSD only)
471
472 .TP 
473 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
474 Progress bar
475
476 .TP 
477 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR 
478 Bitrate of current tune
479
480 .TP 
481 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR 
482 Number of audio channels of current tune
483
484 .TP 
485 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR 
486 Full path and filename of current tune
487
488 .TP 
489 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR 
490 Sampling frequency of current tune
491
492 .TP 
493 \fB\*(T<\fBaudacious_length\fR\*(T>\fR 
494 Total length of current tune as MM:SS
495
496 .TP 
497 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR 
498 Total length of current tune in seconds
499
500 .TP 
501 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR 
502 Playlist position of current tune
503
504 .TP 
505 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR 
506 Number of tunes in playlist
507
508 .TP 
509 \fB\*(T<\fBaudacious_position\fR\*(T>\fR 
510 Position of current tune (MM:SS)
511
512 .TP 
513 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR 
514 Position of current tune in seconds
515
516 .TP 
517 \fB\*(T<\fBaudacious_status\fR\*(T>\fR 
518 Player status (Playing/Paused/Stopped/Not running)
519
520 .TP 
521 \fB\*(T<\fBaudacious_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
522 Title of current tune with optional maximum length specifier
523
524 .TP 
525 \fB\*(T<\fBaudacious_main_volume\fR\*(T>\fR 
526 The current volume fetched from Audacious
527
528 .TP 
529 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
530 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
531
532 .TP 
533 \fB\*(T<\fBbattery_short\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
534 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
535 This mode display a short status, which means that C is displayed instead of charging and D is displayed instead of discharging.
536
537 .TP 
538 \fB\*(T<\fBbattery_bar\fR\*(T>\fR \*(T<\fB(height),(width) (num)\fR\*(T> 
539 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
540
541 .TP 
542 \fB\*(T<\fBbattery_percent\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
543 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
544
545 .TP 
546 \fB\*(T<\fBbattery_time\fR\*(T>\fR \*(T<\fB(num)\fR\*(T> 
547 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
548
549 .TP 
550 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR 
551 Artist in current BMPx track
552
553 .TP 
554 \fB\*(T<\fBbmpx_album\fR\*(T>\fR 
555 Album in current BMPx track
556
557 .TP 
558 \fB\*(T<\fBbmpx_title\fR\*(T>\fR 
559 Title of the current BMPx track
560
561 .TP 
562 \fB\*(T<\fBbmpx_track\fR\*(T>\fR 
563 Track number of the current BMPx track
564
565 .TP 
566 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR 
567 Bitrate of the current BMPx track
568
569 .TP 
570 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR 
571 URI of the current BMPx track
572
573 .TP 
574 \fB\*(T<\fBbuffers\fR\*(T>\fR 
575 Amount of memory buffered
576
577 .TP 
578 \fB\*(T<\fBcached\fR\*(T>\fR 
579 Amount of memory cached
580
581 .TP 
582 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
583 Change drawing color to color
584
585 .TP 
586 \fB\*(T<\fBcolorN\fR\*(T>\fR
587 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
588
589 .TP 
590 \fB\*(T<\fBconky_version\fR\*(T>\fR 
591 Conky version
592
593 .TP 
594 \fB\*(T<\fBconky_build_date\fR\*(T>\fR 
595 Date Conky was built
596
597 .TP 
598 \fB\*(T<\fBconky_build_arch\fR\*(T>\fR 
599 CPU architecture Conky was built for
600
601 .TP 
602 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T> 
603 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.
604
605 .TP 
606 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T> 
607 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
608
609 .TP 
610 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (cpu number)\fR\*(T> 
611 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".
612
613 .TP 
614 \fB\*(T<\fBdiskio\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
615 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
616
617 .TP 
618 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T> 
619 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".
620
621 .TP 
622 \fB\*(T<\fBdiskio_read\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
623 Displays current disk IO for reads. Device as in diskio.
624
625 .TP 
626 \fB\*(T<\fBdiskiograph_read\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T> 
627 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".
628
629 .TP 
630 \fB\*(T<\fBdiskio_write\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
631 Displays current disk IO for writes. Device as in diskio.
632
633 .TP 
634 \fB\*(T<\fBdiskiograph_write\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T> 
635 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".
636
637 .TP 
638 \fB\*(T<\fBdisk_protect\fR\*(T>\fR \*(T<\fBdevice\fR\*(T> 
639 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
640
641 .TP 
642 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
643 Download speed in KiB
644
645 .TP 
646 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
647 Download speed in KiB with one decimal
648
649 .TP 
650 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T> 
651 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".
652
653 .TP 
654 \fB\*(T<\fBelse\fR\*(T>\fR 
655 Text to show if any of the above are not true
656
657 .TP 
658 \fB\*(T<\fBentropy_avail\fR\*(T>\fR 
659 Current entropy available for crypto freaks
660
661 .TP 
662 \fB\*(T<\fBentropy_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
663 Normalized bar of available entropy for crypto freaks
664
665 .TP 
666 \fB\*(T<\fBentropy_poolsize\fR\*(T>\fR 
667 Total size of system entropy pool for crypto freaks
668
669 .TP 
670 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
671 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.
672
673 .TP 
674 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
675 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.
676
677 .TP 
678 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command\fR\*(T> 
679 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.
680
681 .TP 
682 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
683 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
684
685 .TP 
686 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
687 Same as execbar, except with an interval
688
689 .TP 
690 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
691 Same as execgraph, but takes an interval arg graphs values
692
693 .TP 
694 \fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T> 
695 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.
696 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.
697
698 .TP 
699 \fB\*(T<\fBexecpi\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
700 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.
701
702 .TP 
703 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T> 
704 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)
705
706 .TP 
707 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
708 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
709
710 .TP 
711 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
712 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
713
714 .TP 
715 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
716 Returns CPU #n's frequency in MHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
717
718 .TP 
719 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
720 Returns CPU #n's frequency in GHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
721
722 .TP 
723 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T> 
724 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.
725
726 .TP 
727 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
728 Free space on a file system available for users.
729
730 .TP 
731 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
732 Free percentage of space on a file system available for users.
733
734 .TP 
735 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
736 File system size
737
738 .TP 
739 \fB\*(T<\fBfs_type\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
740 File system type
741
742 .TP 
743 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T> 
744 File system used space
745
746 .TP 
747 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T> 
748 The next element will be printed at position 'x'.
749
750 .TP 
751 \fB\*(T<\fBgw_iface\fR\*(T>\fR 
752 Displays the default route's interface or "multiple"/"none" accordingly.
753
754 .TP 
755 \fB\*(T<\fBgw_ip\fR\*(T>\fR 
756 Displays the default gateway's IP or "multiple"/"none" accordingly.
757
758 .TP 
759 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T> 
760 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
761 Default host is 127.0.0.1, default port is 7634.
762
763 .TP 
764 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
765 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.
766
767 .TP 
768 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T> 
769 Horizontal line, height is the height in pixels
770
771 .TP 
772 \fB\*(T<\fBhwmon\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
773 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.
774
775 .TP 
776 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T> 
777 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
778
779 .TP 
780 \fB\*(T<\fBiconv_stop\fR\*(T>\fR 
781 Stop iconv codeset conversion.
782
783 .TP 
784 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
785 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.
786
787 .TP 
788 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR 
789 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.
790
791 .TP 
792 \fB\*(T<\fBi8k_bios\fR\*(T>\fR 
793 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
794
795 .TP 
796 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR 
797 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
798
799 .TP 
800 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR 
801 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
802
803 .TP 
804 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR 
805 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.
806
807 .TP 
808 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR 
809 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.
810
811 .TP 
812 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR 
813 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.
814
815 .TP 
816 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR 
817 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.
818
819 .TP 
820 \fB\*(T<\fBi8k_serial\fR\*(T>\fR 
821 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
822
823 .TP 
824 \fB\*(T<\fBi8k_version\fR\*(T>\fR 
825 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
826
827 .TP 
828 \fB\*(T<\fBibm_fan\fR\*(T>\fR 
829 If running the IBM ACPI, displays the fan speed.
830
831 .TP 
832 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T> 
833 If running the IBM ACPI, displays the temperatures
834 from the IBM temperature sensors (N=0..7) Sensor 0 is
835 on the CPU, 3 is on the GPU.
836
837 .TP 
838 \fB\*(T<\fBibm_volume\fR\*(T>\fR 
839 If running the IBM ACPI, displays the "master" volume,
840 controlled by the volume keys (0-14).
841
842 .TP 
843 \fB\*(T<\fBibm_brightness\fR\*(T>\fR 
844 If running the IBM ACPI, displays the brigtness of the
845 laptops's LCD (0-7).
846
847 .TP 
848 \fB\*(T<\fBif_empty\fR\*(T>\fR \*(T<\fB(var)\fR\*(T> 
849 if conky variable VAR is empty, display everything
850 between $if_empty and the matching $endif
851
852 .TP 
853 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fBfile (string)\fR\*(T> 
854 if FILE exists, display everything between if_existing
855 and the matching $endif. The optional second paramater
856 checks for FILE containing the specified string and
857 prints everything between $if_existing and the matching
858 $endif.
859
860 .TP 
861 \fB\*(T<\fBif_gw\fR\*(T>\fR 
862 if there is at least one default gateway, display
863 everything between $if_gw and the matching $endif
864
865 .TP 
866 \fB\*(T<\fBif_match\fR\*(T>\fR \*(T<\fBexpression\fR\*(T> 
867 Evaluates the given boolean expression, printing
868 everything between $if_match and the matching $endif
869 depending on whether the evaluation returns true or not.
870 Valid expressions consist of a left side, an operator
871 and a right side. Left and right sides are being parsed
872 for contained text objects before evaluation. Recognised
873 left and right side types are:
874
875 \fBdouble\fR:
876 argument consists of only digits and a
877 single dot.
878 .br
879 \fBlong\fR:
880 argument consists of only digits.
881 .br
882 \fBstring\fR:
883 argument is enclosed in quotation mark
884 or the checks for double and long failed
885 before.
886
887 Valid operands are:
888 \&'>', '<', '>=', '<=', '==', '!='.
889
890 .TP 
891 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T> 
892 if PROCESS is running, display everything $if_running
893 and the matching $endif
894
895 .TP 
896 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T> 
897 if MOUNTPOINT is mounted, display everything between
898 $if_mounted and the matching $endif
899
900 .TP 
901 \fB\*(T<\fBif_smapi_bat_installed\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T> 
902 when using smapi, if the battery with index INDEX is
903 installed, display everything between
904 $if_smapi_bat_installed and the matching $endif
905
906 .TP 
907 \fB\*(T<\fBif_up\fR\*(T>\fR \*(T<\fB(interface)\fR\*(T> 
908 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
909
910 .TP 
911 \fB\*(T<\fBif_updatenr\fR\*(T>\fR \*(T<\fB(updatenr)\fR\*(T> 
912 If it's the UPDATENR-th time that conky updates, 
913 display everything between $if_updatenr and the matching $endif.
914 The counter resets when the highest UPDATENR is reached.
915 Example : "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$endif"
916 shows foo 25% of the time followed by bar 25% of the time followed by nothing the other half of the time.
917
918 .TP 
919 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
920 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.
921
922 .TP 
923 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
924 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.
925
926 .TP 
927 \fB\*(T<\fBioscheduler\fR\*(T>\fR \*(T<\fBdisk\fR\*(T> 
928 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
929
930 .TP 
931 \fB\*(T<\fBkernel\fR\*(T>\fR 
932 Kernel version
933
934 .TP 
935 \fB\*(T<\fBlaptop_mode\fR\*(T>\fR 
936 The value of /proc/sys/vm/laptop_mode
937
938 .TP 
939 \fB\*(T<\fBloadavg\fR\*(T>\fR 
940 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
941
942 .TP 
943 \fB\*(T<\fBloadgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
944 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".
945
946 .TP 
947 \fB\*(T<\fBlines\fR\*(T>\fR \*(T<\fBtextfile\fR\*(T> 
948 Displays the number of lines in the given file
949
950 .TP 
951 \fB\*(T<\fBmachine\fR\*(T>\fR 
952 Machine, i686 for example
953
954 .TP 
955 \fB\*(T<\fBmails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
956 Mail count in the specified mailbox or your mail spool if not.
957 Both mbox and maildir type mailboxes are supported. You can
958 use a program like fetchmail to get mails from some server
959 using your favourite protocol. See also new_mails.
960
961 .TP 
962 \fB\*(T<\fBnew_mails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
963 Unread mail count in the specified mailbox or mail spool if
964 not. Both mbox and maildir type mailboxes are supported.
965
966 .TP 
967 \fB\*(T<\fBseen_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
968 Number of mails marked as seen in the specified mailbox or mail spool if
969 not. Only maildir type mailboxes are supported, mbox type will return -1.
970
971 .TP 
972 \fB\*(T<\fBunseen_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
973 Number of new or unseen mails in the specified mailbox or mail spool if
974 not. Only maildir type mailboxes are supported, mbox type will return -1.
975
976 .TP 
977 \fB\*(T<\fBflagged_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
978 Number of mails marked as flagged in the specified mailbox or mail spool if
979 not. Only maildir type mailboxes are supported, mbox type will return -1.
980
981 .TP 
982 \fB\*(T<\fBunflagged_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
983 Number of mails not marked as flagged in the specified mailbox or mail spool if
984 not. Only maildir type mailboxes are supported, mbox type will return -1.
985
986 .TP 
987 \fB\*(T<\fBforwarded_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
988 Number of mails marked as forwarded in the specified mailbox or mail spool if
989 not. Only maildir type mailboxes are supported, mbox type will return -1.
990
991 .TP 
992 \fB\*(T<\fBunforwarded_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
993 Number of mails not marked as forwarded in the specified mailbox or mail spool if
994 not. Only maildir type mailboxes are supported, mbox type will return -1.
995
996 .TP 
997 \fB\*(T<\fBreplied_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
998 Number of mails marked as replied in the specified mailbox or mail spool if
999 not. Only maildir type mailboxes are supported, mbox type will return -1.
1000
1001 .TP 
1002 \fB\*(T<\fBunreplied_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1003 Number of mails not marked as replied in the specified mailbox or mail spool if
1004 not. Only maildir type mailboxes are supported, mbox type will return -1.
1005
1006 .TP 
1007 \fB\*(T<\fBdraft_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1008 Number of mails marked as draft in the specified mailbox or mail spool if
1009 not. Only maildir type mailboxes are supported, mbox type will return -1.
1010
1011 .TP 
1012 \fB\*(T<\fBtrashed_mails\fR\*(T>\fR \*(T<\fB(maildir)\fR\*(T> \*(T<\fB(interval)\fR\*(T> 
1013 Number of mails marked as trashed in the specified mailbox or mail spool if
1014 not. Only maildir type mailboxes are supported, mbox type will return -1.
1015
1016 .TP 
1017 \fB\*(T<\fBmboxscan\fR\*(T>\fR \*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T> 
1018 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"}
1019
1020 .TP 
1021 \fB\*(T<\fBmem\fR\*(T>\fR 
1022 Amount of memory in use
1023
1024 .TP 
1025 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1026 Bar that shows amount of memory in use
1027
1028 .TP 
1029 \fB\*(T<\fBmemgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T> 
1030 Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1031
1032 .TP 
1033 \fB\*(T<\fBmemeasyfree\fR\*(T>\fR 
1034 Amount of free memory including the memory that is very easily freed (buffers/cache)
1035
1036 .TP 
1037 \fB\*(T<\fBmemfree\fR\*(T>\fR 
1038 Amount of free memory
1039
1040 .TP 
1041 \fB\*(T<\fBmemmax\fR\*(T>\fR 
1042 Total amount of memory
1043
1044 .TP 
1045 \fB\*(T<\fBmemperc\fR\*(T>\fR 
1046 Percentage of memory in use
1047
1048 .TP 
1049 \fB\*(T<\fBmixer\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1050 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.
1051
1052 .TP 
1053 \fB\*(T<\fBmixerbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1054 Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1055
1056 .TP 
1057 \fB\*(T<\fBmixerr\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1058 Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1059
1060 .TP 
1061 \fB\*(T<\fBmixerrbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1062 Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1063
1064 .TP 
1065 \fB\*(T<\fBmixerl\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1066 Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1067
1068 .TP 
1069 \fB\*(T<\fBmixerlbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T> 
1070 Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1071
1072 .TP 
1073 \fB\*(T<\fBmoc_state\fR\*(T>\fR 
1074 Current state of MOC; playing, stopped etc.
1075
1076 .TP 
1077 \fB\*(T<\fBmoc_file\fR\*(T>\fR 
1078 File name of the current MOC song
1079
1080 .TP 
1081 \fB\*(T<\fBmoc_title\fR\*(T>\fR 
1082 Title of the current MOC song
1083
1084 .TP 
1085 \fB\*(T<\fBmoc_artist\fR\*(T>\fR 
1086 Artist of the current MOC song
1087
1088 .TP 
1089 \fB\*(T<\fBmoc_song\fR\*(T>\fR 
1090 The current song name being played in MOC.
1091
1092 .TP 
1093 \fB\*(T<\fBmoc_album\fR\*(T>\fR 
1094 Album of the current MOC song
1095
1096 .TP 
1097 \fB\*(T<\fBmoc_totaltime\fR\*(T>\fR 
1098 Total length of the current MOC song
1099
1100 .TP 
1101 \fB\*(T<\fBmoc_timeleft\fR\*(T>\fR 
1102 Time left in the current MOC song
1103
1104 .TP 
1105 \fB\*(T<\fBmoc_curtime\fR\*(T>\fR 
1106 Current time of the current MOC song
1107
1108 .TP 
1109 \fB\*(T<\fBmoc_bitrate\fR\*(T>\fR 
1110 Bitrate in the current MOC song
1111
1112 .TP 
1113 \fB\*(T<\fBmoc_rate\fR\*(T>\fR 
1114 Rate of the current MOC song
1115
1116 .TP 
1117 \fB\*(T<\fBmonitor\fR\*(T>\fR 
1118 Number of the monitor on which conky is running
1119
1120 .TP 
1121 \fB\*(T<\fBmonitor_number\fR\*(T>\fR 
1122 Number of monitors
1123
1124 .TP 
1125 \fB\*(T<\fBmpd_artist\fR\*(T>\fR 
1126 Artist in current MPD song must be enabled at compile
1127
1128 .TP 
1129 \fB\*(T<\fBmpd_album\fR\*(T>\fR 
1130 Album in current MPD song
1131
1132 .TP 
1133 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1134 Bar of mpd's progress
1135
1136 .TP 
1137 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR 
1138 Bitrate of current song
1139
1140 .TP 
1141 \fB\*(T<\fBmpd_status\fR\*(T>\fR 
1142 Playing, stopped, et cetera.
1143
1144 .TP 
1145 \fB\*(T<\fBmpd_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
1146 Title of current MPD song
1147
1148 .TP 
1149 \fB\*(T<\fBmpd_vol\fR\*(T>\fR 
1150 MPD's volume
1151
1152 .TP 
1153 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR 
1154 Song's elapsed time
1155
1156 .TP 
1157 \fB\*(T<\fBmpd_length\fR\*(T>\fR 
1158 Song's length
1159
1160 .TP 
1161 \fB\*(T<\fBmpd_percent\fR\*(T>\fR 
1162 Percent of song's progress
1163
1164 .TP 
1165 \fB\*(T<\fBmpd_random\fR\*(T>\fR 
1166 Random status (On/Off)
1167
1168 .TP 
1169 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR 
1170 Repeat status (On/Off)
1171
1172 .TP 
1173 \fB\*(T<\fBmpd_track\fR\*(T>\fR 
1174 Prints the MPD track field
1175
1176 .TP 
1177 \fB\*(T<\fBmpd_name\fR\*(T>\fR 
1178 Prints the MPD name field
1179
1180 .TP 
1181 \fB\*(T<\fBmpd_file\fR\*(T>\fR 
1182 Prints the file name of the current MPD song
1183
1184 .TP 
1185 \fB\*(T<\fBmpd_smart\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T> 
1186 Prints the song name in either the form "artist - title" or file name, depending on whats available
1187
1188 .TP 
1189 \fB\*(T<\fBif_mpd_playing\fR\*(T>\fR 
1190 if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1191
1192 .TP 
1193 \fB\*(T<\fBnameserver\fR\*(T>\fR \*(T<\fB(index)\fR\*(T> 
1194 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1195
1196 .TP 
1197 \fB\*(T<\fBnodename\fR\*(T>\fR 
1198 Hostname
1199
1200 .TP 
1201 \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> 
1202 Nvidia graficcard support for the XNVCtrl library.
1203 Each option can be shortened to the least significant part.
1204 Temperatures are printed as float, all other values as integer.
1205
1206 \fBthreshold\fR:
1207 the thresholdtemperature at which the gpu slows down
1208 .br
1209 \fBtemp\fR:
1210 gives the gpu current temperature
1211 .br
1212 \fBambient\fR:
1213 gives current air temperature near GPU case
1214 .br
1215 \fBgpufreq\fR:
1216 gives the current gpu frequency
1217 .br
1218 \fBmemfreq\fR:
1219 gives the current mem frequency
1220 .br
1221 \fBimagequality\fR:
1222 which imagequality should be choosen by OpenGL applications
1223
1224 .TP 
1225 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
1226 Change outline color
1227
1228 .TP 
1229 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T> 
1230 If running on Apple powerbook/ibook, display
1231 information on battery status. The item parameter
1232 specifies, what information to display. Exactly one item
1233 must be specified. Valid items are:
1234
1235 \fBstatus\fR:
1236 Display if battery is fully charged, charging,
1237 discharging or absent (running on AC)
1238 .br
1239 \fBpercent\fR:
1240 Display charge of battery in percent, if
1241 charging or discharging. Nothing will be
1242 displayed, if battery is fully charged
1243 or absent.
1244 .br
1245 \fBtime\fR:
1246 Display the time remaining until the battery
1247 will be fully charged or discharged at current
1248 rate. Nothing is displayed, if battery is
1249 absent or if it's present but fully charged
1250 and not discharging.
1251
1252 .TP 
1253 \fB\*(T<\fBplatform\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T> 
1254 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.
1255
1256 .TP 
1257 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
1258 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.
1259
1260 .TP 
1261 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T> 
1262 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.
1263
1264 .TP 
1265 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T> 
1266 Executes a shell command one time before conky displays anything and puts output as text.
1267
1268 .TP 
1269 \fB\*(T<\fBprocesses\fR\*(T>\fR 
1270 Total processes (sleeping and running)
1271
1272 .TP 
1273 \fB\*(T<\fBrunning_processes\fR\*(T>\fR 
1274 Running processes (not sleeping), requires Linux 2.6
1275
1276 .TP 
1277 \fB\*(T<\fBscroll\fR\*(T>\fR \*(T<\fBlength (step) text\fR\*(T> 
1278 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").
1279
1280 .TP 
1281 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T> 
1282 Change shading color
1283
1284 .TP 
1285 \fB\*(T<\fBsmapi\fR\*(T>\fR \*(T<\fB(ARGS)\fR\*(T> 
1286 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.
1287
1288 .TP 
1289 \fB\*(T<\fBsmapi_bat_bar\fR\*(T>\fR \*(T<\fB(INDEX),(height),(width)\fR\*(T> 
1290 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1291
1292 .TP 
1293 \fB\*(T<\fBsmapi_bat_perc\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T> 
1294 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.
1295
1296 .TP 
1297 \fB\*(T<\fBsmapi_bat_power\fR\*(T>\fR \*(T<\fBINDEX\fR\*(T> 
1298 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.
1299
1300 .TP 
1301 \fB\*(T<\fBsmapi_bat_temp\fR\*(T>\fR \*(T<\fBINDEX\fR\*(T> 
1302 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.
1303
1304 .TP 
1305 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T> 
1306 Stippled (dashed) horizontal line
1307
1308 .TP 
1309 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1310 Bar that shows amount of swap in use
1311
1312 .TP 
1313 \fB\*(T<\fBswap\fR\*(T>\fR 
1314 Amount of swap in use
1315
1316 .TP 
1317 \fB\*(T<\fBswapmax\fR\*(T>\fR 
1318 Total amount of swap
1319
1320 .TP 
1321 \fB\*(T<\fBswapperc\fR\*(T>\fR 
1322 Percentage of swap in use
1323
1324 .TP 
1325 \fB\*(T<\fBsysname\fR\*(T>\fR 
1326 System name, Linux for example
1327
1328 .TP 
1329 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR 
1330 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1331
1332 \fBcount\fR - total number of connections in the range
1333 .br
1334 \fBrip\fR - remote ip address
1335 .br
1336 \fBrhost\fR - remote host name
1337 .br
1338 \fBrport\fR - remote port number
1339 .br
1340 \fBrservice\fR - remote service name from /etc/services
1341 .br
1342 \fBlip\fR - local ip address
1343 .br
1344 \fBlhost\fR - local host name
1345 .br
1346 \fBlport\fR - local port number
1347 .br
1348 \fBlservice\fR - local service name from /etc/services
1349
1350 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.
1351
1352 Examples:
1353 .br
1354 \fB${tcp_portmon 6881 6999 count}\fR -
1355 displays the number of connections in the bittorrent port range
1356 .br
1357 \fB${tcp_portmon 22 22 rip 0}\fR -
1358 displays the remote host ip of the first sshd connection
1359 .br
1360 \fB${tcp_portmon 22 22 rip 9}\fR -
1361 displays the remote host ip of the tenth sshd connection
1362 .br
1363 \fB${tcp_portmon 1 1024 rhost 0}\fR -
1364 displays the remote host name of the first connection on a privileged port
1365 .br
1366 \fB${tcp_portmon 1 1024 rport 4}\fR -
1367 displays the remote host port of the fifth connection on a privileged port
1368 .br
1369 \fB${tcp_portmon 1 65535 lservice 14}\fR -
1370 displays the local service name of the fifteenth connection in the range of all ports
1371
1372 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.
1373 .TP 
1374 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T> 
1375 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.
1376
1377 .TP 
1378 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1379 Move text over by N pixels. See also $voffset.
1380
1381 .TP 
1382 \fB\*(T<\fBrss\fR\*(T>\fR \*(T<\fBurl delay_in_minutes action item_num\fR\*(T> 
1383 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.
1384
1385 .TP 
1386 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T> 
1387 Puts a tab of the specified width, starting from column 'start'.
1388
1389 .TP 
1390 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T> 
1391 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.
1392
1393 .TP 
1394 \fB\*(T<\fBtemplateN\fR\*(T>\fR \*(T<\fB(arg1)\fR\*(T> \*(T<\fB(arg2)\fR\*(T> \*(T<\fB(arg3 ...)\fR\*(T> 
1395 Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
1396 applying substitutions as described in the documentation of the corresponding configuration variable.
1397 The number of arguments is optional, but must match the highest referred index in the template. You can use the
1398 same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
1399 to contain a whitespace. Also simple nesting of templates is possible this way.
1400
1401 Here are some examples of template definitions:
1402
1403 template0 $\e1\e2
1404 .br
1405 template1 \e1: ${fs_used \e2} / ${fs_size \e2}
1406 .br
1407 template2 \e1 \e2
1408
1409 The following list shows sample usage of the templates defined above,
1410 with the equivalent syntax when not using any template at all:
1411 .TS
1412 l l.
1413 T{
1414 using template
1415 T}      T{
1416 same without template
1417 T}
1418 .T&
1419 _ _
1420 l l
1421 l l
1422 l l.
1423 T{
1424 ${template0 node name}
1425 T}      T{
1426 $nodename
1427 T}
1428 T{
1429 ${template1 root /}
1430 T}      T{
1431 root: ${fs_free /} / ${fs_size /}
1432 T}
1433 T{
1434 .nf
1435 \*(T<${template1 ${template2\e disk\e root} /}\*(T>
1436 .fi
1437 T}      T{
1438 .nf
1439 \*(T<disk root: ${fs_free /} / ${fs_size /}\*(T>
1440 .fi
1441 T}
1442 .TE
1443
1444 .TP 
1445 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1446 Local time, see man strftime to get more information about format
1447
1448 .TP 
1449 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T> 
1450 Display time in UTC (universal coordinate time).
1451
1452 .TP 
1453 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T> 
1454 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.
1455
1456 .TP 
1457 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1458 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.
1459
1460 .TP 
1461 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1462 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.
1463
1464 .TP 
1465 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1466 Same as top, except sorted by mem usage instead of cpu
1467
1468 .TP 
1469 \fB\*(T<\fBtop_time\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T> 
1470 Same as top, except sorted by total CPU time instead of current CPU usage
1471
1472 .TP 
1473 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1474 Total upload, this one too, may overflow
1475
1476 .TP 
1477 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T> 
1478 for debugging
1479
1480 .TP 
1481 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1482 Upload speed in KiB
1483
1484 .TP 
1485 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1486 Upload speed in KiB with one decimal
1487
1488 .TP 
1489 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T> 
1490 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".
1491
1492 .TP 
1493 \fB\*(T<\fBuptime\fR\*(T>\fR 
1494 Uptime
1495
1496 .TP 
1497 \fB\*(T<\fBuptime_short\fR\*(T>\fR 
1498 Uptime in a shorter format
1499
1500 .TP 
1501 \fB\*(T<\fBuser_number\fR\*(T>\fR 
1502 Number of users logged in
1503
1504 .TP 
1505 \fB\*(T<\fBuser_names\fR\*(T>\fR 
1506 Lists the names of the users logged in
1507
1508 .TP 
1509 \fB\*(T<\fBuser_terms\fR\*(T>\fR 
1510 Lists the consoles in use
1511
1512 .TP 
1513 \fB\*(T<\fBuser_times\fR\*(T>\fR 
1514 Lists how long users have been logged in for
1515
1516 .TP 
1517 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T> 
1518 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1519
1520 .TP 
1521 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1522 Returns CPU #n's voltage in mV. CPUs are
1523 counted from 1. If omitted, the parameter
1524 defaults to 1.
1525
1526 .TP 
1527 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T> 
1528 Returns CPU #n's voltage in V. CPUs are
1529 counted from 1. If omitted, the parameter
1530 defaults to 1.
1531
1532 .TP 
1533 \fB\*(T<\fBwireless_essid\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1534 Wireless access point ESSID (Linux only)
1535
1536 .TP 
1537 \fB\*(T<\fBwireless_mode\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1538 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1539
1540 .TP 
1541 \fB\*(T<\fBwireless_bitrate\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1542 Wireless bitrate (ie 11 Mb/s) (Linux only)
1543
1544 .TP 
1545 \fB\*(T<\fBwireless_ap\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1546 Wireless access point MAC address (Linux only)
1547
1548 .TP 
1549 \fB\*(T<\fBwireless_link_qual\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1550 Wireless link quality (Linux only)
1551
1552 .TP 
1553 \fB\*(T<\fBwireless_link_qual_max\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1554 Wireless link quality maximum value (Linux only)
1555
1556 .TP 
1557 \fB\*(T<\fBwireless_link_qual_perc\fR\*(T>\fR \*(T<\fBnet\fR\*(T> 
1558 Wireless link quality in percents (Linux only)
1559
1560 .TP 
1561 \fB\*(T<\fBwireless_link_bar\fR\*(T>\fR \*(T<\fB(height), (width) net\fR\*(T> 
1562 Wireless link quality bar (Linux only)
1563
1564 .TP 
1565 \fB\*(T<\fBwords\fR\*(T>\fR \*(T<\fBtextfile\fR\*(T> 
1566 Displays the number of words in the given file
1567
1568 .TP 
1569 \fB\*(T<\fBxmms2_artist\fR\*(T>\fR 
1570 Artist in current XMMS2 song
1571
1572 .TP 
1573 \fB\*(T<\fBxmms2_album\fR\*(T>\fR 
1574 Album in current XMMS2 song
1575
1576 .TP 
1577 \fB\*(T<\fBxmms2_title\fR\*(T>\fR 
1578 Title in current XMMS2 song
1579
1580 .TP 
1581 \fB\*(T<\fBxmms2_genre\fR\*(T>\fR 
1582 Genre in current XMMS2 song
1583
1584 .TP 
1585 \fB\*(T<\fBxmms2_comment\fR\*(T>\fR 
1586 Comment in current XMMS2 song
1587
1588 .TP 
1589 \fB\*(T<\fBxmms2_decoder\fR\*(T>\fR 
1590 Decoder plugin used
1591
1592 .TP 
1593 \fB\*(T<\fBxmms2_transport\fR\*(T>\fR 
1594 Transport plugin used
1595
1596 .TP 
1597 \fB\*(T<\fBxmms2_url\fR\*(T>\fR 
1598 Full path to current song
1599
1600 .TP 
1601 \fB\*(T<\fBxmms2_tracknr\fR\*(T>\fR 
1602 Track number in current XMMS2 song
1603
1604 .TP 
1605 \fB\*(T<\fBxmms2_bitrate\fR\*(T>\fR 
1606 Bitrate of current song
1607
1608 .TP 
1609 \fB\*(T<\fBxmms2_id\fR\*(T>\fR 
1610 XMMS2 id of current song
1611
1612 .TP 
1613 \fB\*(T<\fBxmms2_duration\fR\*(T>\fR 
1614 Duration of current song
1615
1616 .TP 
1617 \fB\*(T<\fBxmms2_elapsed\fR\*(T>\fR 
1618 Song's elapsed time
1619
1620 .TP 
1621 \fB\*(T<\fBxmms2_size\fR\*(T>\fR 
1622 Size of current song
1623
1624 .TP 
1625 \fB\*(T<\fBxmms2_percent\fR\*(T>\fR 
1626 Percent of song's progress
1627
1628 .TP 
1629 \fB\*(T<\fBxmms2_status\fR\*(T>\fR 
1630 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1631
1632 .TP 
1633 \fB\*(T<\fBxmms2_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T> 
1634 Bar of XMMS2's progress
1635
1636 .TP 
1637 \fB\*(T<\fBxmms2_smart\fR\*(T>\fR 
1638 Prints the song name in either the form "artist - title" or file name, depending on whats available
1639
1640 .TP 
1641 \fB\*(T<\fBif_xmms2_connected\fR\*(T>\fR 
1642 Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
1643
1644 .TP 
1645 \fB\*(T<\fBeve\fR\*(T>\fR \*(T<\fBapi_userid api_key character_id\fR\*(T> 
1646 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.
1647
1648 .SH EXAMPLES
1649 .TP 
1650 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%M}' \-o \-u 30\fR\*(T>
1651 Start Conky in its own window with date and clock as text and 30 sec update interval.
1652 .TP 
1653 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1654 Start Conky to background at coordinates (5, 500).
1655 .SH FILES
1656 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1657 .SH BUGS
1658 Drawing to root or some other desktop window directly doesn't work with
1659 all window managers. Especially doesn't work well with Gnome and it has
1660 been reported that it doesn't work with KDE either. Nautilus can be
1661 disabled from drawing to desktop with program gconf-editor. Uncheck
1662 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1663 to set some specific window id. You might find xwininfo -tree useful to
1664 find the window to draw to. You can also use -o argument which makes
1665 Conky to create its own window. If you do try running Conky in its own
1666 window, be sure to read up on the own_window_type settings and experiment.
1667 .SH "SEE ALSO"
1668 \(lahttp://conky.sourceforge.net/\(ra
1669 .PP
1670 \(lahttp://www.sourceforge.net/projects/conky\(ra
1671 .PP
1672 #conky on irc.freenode.net
1673 .SH COPYING
1674 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al.
1675 Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy).
1676 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).
1677 .SH AUTHORS
1678 The Conky dev team (see AUTHORS for a full list of contributors).