1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>conky</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="conky"><a name="id470378"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>conky — A system monitor for X originally based on the
2 torsmo code, but more kickass. It just keeps on given'er.
3 Yeah.</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">conky</code> [
4 <em class="replaceable"><code>options</code></em>
5 ]</p></div></div><div class="refsect1" title="Description"><a name="id504448"></a><h2>Description</h2><p>Conky is a system monitor for X originally based on
6 torsmo. Since its inception, Conky has changed
7 significantly from its predecessor, while maintaining
8 simplicity and configurability. Conky can display just
9 about anything, either on your root desktop or in its own
10 window. Not only does Conky have many built-in objects, it
11 can also display just about any piece of information by
12 using scripts and other external programs.
13 </p><p>Conky has more than 250 built in objects, including
14 support for a plethora of OS stats (uname, uptime, CPU
15 usage, mem usage, disk usage, "top" like process stats, and
16 network monitoring, just to name a few), built in IMAP and
17 POP3 support, built in support for many popular music
18 players (MPD, XMMS2, BMPx, Audacious), and much much more.
19 Conky can display this info either as text, or using simple
20 progress bars and graph widgets, with different fonts and
22 </p><p>We are always looking for help, whether its reporting
23 bugs, writing patches, or writing docs. Please use the
24 facilities at SourceForge to make bug reports, feature
25 requests, and submit patches, or stop by #conky on
26 irc.freenode.net if you have questions or want to
27 contribute.</p><p>Thanks for your interest in Conky.
28 </p></div><div class="refsect1" title="Compiling"><a name="id469043"></a><h2>Compiling</h2><p>For users compiling from source on a binary distro,
29 make sure you have the X development libraries installed
30 (Unless you provide configure with "--disable-x11"). This
31 should be a package along the lines of "libx11-dev" or
32 "xorg-x11-dev" for X11 libs, and similar "-dev" format for
33 the other libs required (depending on your configure
34 options). You should be able to see which extra packages
35 you need to install by reading errors that you get from
36 './configure'. You can enable/disable stuff by giving
37 options to configure, but be careful with disabling. For
38 example: with --disable-math you won't get errors but
39 logarithmic graphs will be normal graphs and gauges
41 </p><p>Conky has (for some time) been available in the
42 repositories of most popular distributions. Here are some
43 installation instructions for a few:
44 </p><p>Gentoo users -- Conky is in Gentoo's Portage...
45 simply use "emerge app-admin/conky" for
47 </p><p>Debian, etc. users -- Conky should be in your
48 repositories, and can be installed by doing "aptitude
50 </p><p>Example to compile and run Conky with all optional
51 components (note that some configure options may differ for
53 </p><div class="variablelist"><dl><dt><span class="term">
54 <span class="command"><strong>
55 <code class="option">sh autogen.sh</code>
57 <code class="option"># Only required if building from the
59 </span></dt><dd></dd><dt><span class="term">
60 <span class="command"><strong>
61 <code class="option">./configure</code>
63 <code class="option">--prefix=/usr --mandir=/usr/share/man
64 --infodir=/usr/share/info --datadir=/usr/share
65 --sysconfdir=/etc --localstatedir=/var/lib
67 --enable-audacious[=yes|no|legacy]
68 --enable-bmpx --disable-hddtemp --disable-mpd
69 --enable-xmms2 --disable-portmon
70 --disable-network --enable-debug --disable-x11
71 --disable-double-buffer --disable-xdamage
73 </span></dt><dd></dd><dt><span class="term">
74 <span class="command"><strong>
75 <code class="option">make</code>
77 </span></dt><dd></dd><dt><span class="term">
78 <span class="command"><strong>
79 <code class="option">make install</code>
81 <code class="option"># Optional</code>
82 </span></dt><dd></dd><dt><span class="term">
83 <span class="command"><strong>
84 <code class="option">src/conky</code>
86 </span></dt><dd></dd></dl></div><p>Conky has been tested to be compatible with C99 C,
87 however it has not been tested with anything other than
88 gcc, and is not guaranteed to work with other
90 </p><p></p></div><div class="refsect1" title="You Should Know"><a name="id469655"></a><h2>You Should Know</h2><p>Conky is generally very good on resources. That said,
91 the more you try to make Conky do, the more resources it is
93 </p><p>An easy way to force Conky to reload your ~/.conkyrc:
94 "killall -SIGUSR1 conky". Saves you the trouble of having
95 to kill and then restart. You can now also do the same with
97 </p></div><div class="refsect1" title="Options"><a name="id469671"></a><h2>Options</h2><p>Command line options override configurations defined in
99 </p><div class="variablelist"><dl><dt><span class="term">
100 <span class="command"><strong>
101 <code class="option">-v | -V | --version</code>
103 </span></dt><dd>Prints version and exits
104 <p></p></dd><dt><span class="term">
105 <span class="command"><strong>
106 <code class="option">-q | --quiet</code>
108 </span></dt><dd>Run Conky in 'quiet mode' (ie. no output)
109 <p></p></dd><dt><span class="term">
110 <span class="command"><strong>
111 <code class="option">-D | --debug</code>
113 </span></dt><dd>Increase debugging output, ie. -DD for more
115 <p></p></dd><dt><span class="term">
116 <span class="command"><strong>
117 <code class="option">-a | --alignment=</code>
119 <code class="option">ALIGNMENT</code>
120 </span></dt><dd>Text alignment on screen,
121 {top,bottom,middle}_{left,right,middle} or none. Can also
122 be abbreviated with first chars of position, ie. tr for
124 <p></p></dd><dt><span class="term">
125 <span class="command"><strong>
126 <code class="option">-b | --double-buffer</code>
128 </span></dt><dd>Use double buffering (eliminates "flicker")
129 <p></p></dd><dt><span class="term">
130 <span class="command"><strong>
131 <code class="option">-c | --config=</code>
133 <code class="option">FILE</code>
134 </span></dt><dd>Config file to load instead of $HOME/.conkyrc
135 <p></p></dd><dt><span class="term">
136 <span class="command"><strong>
137 <code class="option">-C | --print-config</code>
139 </span></dt><dd>Print builtin default config to stdout. See also
140 the section EXAMPLES for more information.
141 <p></p></dd><dt><span class="term">
142 <span class="command"><strong>
143 <code class="option">-d | --daemonize</code>
145 </span></dt><dd>Daemonize Conky, aka fork to background
146 <p></p></dd><dt><span class="term">
147 <span class="command"><strong>
148 <code class="option">-f | --font=</code>
150 <code class="option">FONT</code>
151 </span></dt><dd>Font to use
152 <p></p></dd><dt><span class="term">
153 <span class="command"><strong>
154 <code class="option">-h | --help</code>
156 </span></dt><dd>Prints command line help and exits
157 <p></p></dd><dt><span class="term">
158 <span class="command"><strong>
159 <code class="option">-o | --own-window</code>
161 </span></dt><dd>Create own window to draw
162 <p></p></dd><dt><span class="term">
163 <span class="command"><strong>
164 <code class="option">-t | --text=</code>
166 <code class="option">TEXT</code>
167 </span></dt><dd>Text to render, remember single quotes, like -t '
169 <p></p></dd><dt><span class="term">
170 <span class="command"><strong>
171 <code class="option">-p | --pause=</code>
173 <code class="option">SECONDS</code>
174 </span></dt><dd>Time to pause before actually starting Conky
175 <p></p></dd><dt><span class="term">
176 <span class="command"><strong>
177 <code class="option">-u | --interval=</code>
179 <code class="option">SECONDS</code>
180 </span></dt><dd>Update interval
181 <p></p></dd><dt><span class="term">
182 <span class="command"><strong>
183 <code class="option">-w | --window-id=</code>
185 <code class="option">WIN_ID</code>
186 </span></dt><dd>Window id to draw
187 <p></p></dd><dt><span class="term">
188 <span class="command"><strong>
189 <code class="option">-X | --display=</code>
191 <code class="option">DISPLAY</code>
192 </span></dt><dd>X11 display to use
193 <p></p></dd><dt><span class="term">
194 <span class="command"><strong>
195 <code class="option">-x</code>
197 <code class="option">X_COORDINATE</code>
198 </span></dt><dd>X position
199 <p></p></dd><dt><span class="term">
200 <span class="command"><strong>
201 <code class="option">-y</code>
203 <code class="option">Y_COORDINATE</code>
204 </span></dt><dd>Y position
205 <p></p></dd><dt><span class="term">
206 <span class="command"><strong>
207 <code class="option">-i</code>
209 <code class="option">COUNT</code>
210 </span></dt><dd>Number of times to update Conky (and quit)
211 <p></p></dd></dl></div></div><div class="refsect1" title="Configuration Settings"><a name="id514306"></a><h2>Configuration Settings</h2><p>Default configuration file location is $HOME/.conkyrc or
212 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is
213 /etc, and you can find the sample config file there
214 (/etc/conky/conky.conf).
215 </p><p>You might want to copy it to $HOME/.conkyrc and then
216 start modifying it. Other configs can be found at
218 </p><div class="variablelist"><dl><dt><span class="term">
219 <span class="command"><strong>
220 <code class="option">TEXT</code>
222 </span></dt><dd>After this begins text to be formatted on screen.
223 Backslash (\) escapes newlines in the text section. This
224 can be useful for cleaning up config files where conky is
225 used to pipe input to dzen2.
226 <p></p></dd><dt><span class="term">
227 <span class="command"><strong>
228 <code class="option">alignment</code>
230 </span></dt><dd>Aligned position on screen, may be top_left,
231 top_right, top_middle, bottom_left, bottom_right,
232 bottom_middle, middle_left, middle_middle, middle_right, or
233 none (also can be abreviated as tl, tr, tm, bl, br, bm, ml,
234 mm, mr). See also gap_x and gap_y.
235 <p></p></dd><dt><span class="term">
236 <span class="command"><strong>
237 <code class="option">append_file</code>
239 </span></dt><dd>Append the file given as argument.
240 <p></p></dd><dt><span class="term">
241 <span class="command"><strong>
242 <code class="option">background</code>
244 </span></dt><dd>Boolean value, if true, Conky will be forked to
245 background when started.
246 <p></p></dd><dt><span class="term">
247 <span class="command"><strong>
248 <code class="option">border_inner_margin</code>
250 </span></dt><dd>Inner border margin in pixels (the margin between
251 the border and text).
252 <p></p></dd><dt><span class="term">
253 <span class="command"><strong>
254 <code class="option">border_outer_margin</code>
256 </span></dt><dd>Outer border margin in pixels (the margin between
257 the border and the edge of the window).
258 <p></p></dd><dt><span class="term">
259 <span class="command"><strong>
260 <code class="option">border_width</code>
262 </span></dt><dd>Border width in pixels.
263 <p></p></dd><dt><span class="term">
264 <span class="command"><strong>
265 <code class="option">colorN</code>
267 </span></dt><dd>Predefine a color for use inside TEXT segments.
268 Substitute N by a digit between 0 and 9, inclusively. When
269 specifying the color value in hex, omit the leading hash
271 <p></p></dd><dt><span class="term">
272 <span class="command"><strong>
273 <code class="option">cpu_avg_samples</code>
275 </span></dt><dd>The number of samples to average for CPU
277 <p></p></dd><dt><span class="term">
278 <span class="command"><strong>
279 <code class="option">default_bar_size</code>
281 </span></dt><dd>Specify a default width and height for bars.
282 Example: 'default_bar_size 0 6'. This is particularly
283 useful for execbar and execibar as they do not take size
285 <p></p></dd><dt><span class="term">
286 <span class="command"><strong>
287 <code class="option">default_color</code>
289 </span></dt><dd>Default color and border color
290 <p></p></dd><dt><span class="term">
291 <span class="command"><strong>
292 <code class="option">default_gauge_size</code>
294 </span></dt><dd>Specify a default width and height for gauges.
295 Example: 'default_gauge_size 25 25'. This is particularly
296 useful for execgauge and execigauge as they do not take
298 <p></p></dd><dt><span class="term">
299 <span class="command"><strong>
300 <code class="option">default_graph_size</code>
302 </span></dt><dd>Specify a default width and height for graphs.
303 Example: 'default_graph_size 0 25'. This is particularly
304 useful for execgraph and execigraph as they do not take
306 <p></p></dd><dt><span class="term">
307 <span class="command"><strong>
308 <code class="option">default_outline_color</code>
310 </span></dt><dd>Default outline color
311 <p></p></dd><dt><span class="term">
312 <span class="command"><strong>
313 <code class="option">default_shade_color</code>
315 </span></dt><dd>Default shading color and border's shading color
316 <p></p></dd><dt><span class="term">
317 <span class="command"><strong>
318 <code class="option">disable_auto_reload</code>
320 </span></dt><dd>Enable to disable the inotify-based auto config reload feature.
321 <p></p></dd><dt><span class="term">
322 <span class="command"><strong>
323 <code class="option">diskio_avg_samples</code>
325 </span></dt><dd>The number of samples to average for disk I/O
327 <p></p></dd><dt><span class="term">
328 <span class="command"><strong>
329 <code class="option">display</code>
331 </span></dt><dd>Specify an X display to connect to.
332 <p></p></dd><dt><span class="term">
333 <span class="command"><strong>
334 <code class="option">double_buffer</code>
336 </span></dt><dd>Use the Xdbe extension? (eliminates flicker) It
337 is highly recommended to use own window with this one so
338 double buffer won't be so big.
339 <p></p></dd><dt><span class="term">
340 <span class="command"><strong>
341 <code class="option">draw_borders</code>
343 </span></dt><dd>Draw borders around text?
344 <p></p></dd><dt><span class="term">
345 <span class="command"><strong>
346 <code class="option">draw_graph_borders</code>
348 </span></dt><dd>Draw borders around graphs?
349 <p></p></dd><dt><span class="term">
350 <span class="command"><strong>
351 <code class="option">draw_outline</code>
353 </span></dt><dd>Draw outlines?
354 <p></p></dd><dt><span class="term">
355 <span class="command"><strong>
356 <code class="option">draw_shades</code>
358 </span></dt><dd>Draw shades?
359 <p></p></dd><dt><span class="term">
360 <span class="command"><strong>
361 <code class="option">extra_newline</code>
363 </span></dt><dd>Put an extra newline at the end when writing to
364 stdout, useful for writing to awesome's wiboxes.
365 <p></p></dd><dt><span class="term">
366 <span class="command"><strong>
367 <code class="option">font</code>
369 </span></dt><dd>Font name in X, xfontsel can be used to get a
371 <p></p></dd><dt><span class="term">
372 <span class="command"><strong>
373 <code class="option">format_human_readable</code>
375 </span></dt><dd>If enabled, values which are in bytes will be
376 printed in human readable format (i.e., KiB, MiB, etc). If
377 disabled, the number of bytes is printed instead.
378 <p></p></dd><dt><span class="term">
379 <span class="command"><strong>
380 <code class="option">gap_x</code>
382 </span></dt><dd>Gap, in pixels, between right or left border of
383 screen, same as passing -x at command line, e.g. gap_x 10.
384 For other position related stuff, see 'alignment'.
385 <p></p></dd><dt><span class="term">
386 <span class="command"><strong>
387 <code class="option">gap_y</code>
389 </span></dt><dd>Gap, in pixels, between top or bottom border of
390 screen, same as passing -y at command line, e.g. gap_y 10.
391 For other position related stuff, see 'alignment'.
392 <p></p></dd><dt><span class="term">
393 <span class="command"><strong>
394 <code class="option">hddtemp_host</code>
396 </span></dt><dd>Hostname to connect to for hddtemp objects. Defaults
398 <p></p></dd><dt><span class="term">
399 <span class="command"><strong>
400 <code class="option">hddtemp_port</code>
402 </span></dt><dd>Port to use for hddtemp connections. Defaults to
404 <p></p></dd><dt><span class="term">
405 <span class="command"><strong>
406 <code class="option">if_up_strictness</code>
408 </span></dt><dd>How strict should if_up be when testing an
409 interface for being up? The value is one of up, link or
410 address, to check for the interface being solely up, being
411 up and having link or being up, having link and an assigned
413 <p></p></dd><dt><span class="term">
414 <span class="command"><strong>
415 <code class="option">imap</code>
417 </span></dt><dd>Default global IMAP server. Arguments are: "host
418 user pass [-i interval (in seconds)] [-f 'folder'] [-p port]
419 [-e 'command'] [-r retries]". Default port is 143, default
420 folder is 'INBOX', default interval is 5 minutes, and
421 default number of retries before giving up is 5. If the
422 password is supplied as '*', you will be prompted to enter
423 the password when Conky starts.
424 <p></p></dd><dt><span class="term">
425 <span class="command"><strong>
426 <code class="option">imlib_cache_flush_interval</code>
428 </span></dt><dd>Interval (in seconds) to flush Imlib2 cache.
429 <p></p></dd><dt><span class="term">
430 <span class="command"><strong>
431 <code class="option">imlib_cache_size</code>
434 Imlib2 image cache size, in bytes. Defaults to
435 4MiB. Increase this value if you use $image lots. Set
436 to 0 to disable the image cache.<p></p></dd><dt><span class="term">
437 <span class="command"><strong>
438 <code class="option">lua_draw_hook_post</code>
440 <code class="option">function_name [function arguments]</code>
442 This function, if defined, will be called by
443 Conky through each iteration after drawing to the
444 window. Requires X support. Takes any number of
445 optional arguments. Use this hook for drawing things on
446 top of what Conky draws. Conky puts 'conky_' in front
447 of function_name to prevent accidental calls to the
448 wrong function unless you place 'conky_' in front of it
449 yourself.<p></p></dd><dt><span class="term">
450 <span class="command"><strong>
451 <code class="option">lua_draw_hook_pre</code>
453 <code class="option">function_name [function arguments]</code>
455 This function, if defined, will be called by
456 Conky through each iteration before drawing to the
457 window. Requires X support. Takes any number of
458 optional arguments. Use this hook for drawing things on
459 top of what Conky draws. Conky puts 'conky_' in front
460 of function_name to prevent accidental calls to the
461 wrong function unless you place 'conky_' in front of it
462 yourself.<p></p></dd><dt><span class="term">
463 <span class="command"><strong>
464 <code class="option">lua_load</code>
466 </span></dt><dd>Loads the Lua scripts separated by spaces.
467 <p></p></dd><dt><span class="term">
468 <span class="command"><strong>
469 <code class="option">lua_shutdown_hook</code>
471 <code class="option">function_name [function arguments]</code>
473 This function, if defined, will be called by
474 Conky at shutdown or when the configuration is
475 reloaded. Use this hook to clean up after yourself,
476 such as freeing memory which has been allocated by
477 external libraries via Lua. Conky puts 'conky_' in
478 front of function_name to prevent accidental calls to
479 the wrong function unless you place 'conky_' in
480 front of it yourself.<p></p></dd><dt><span class="term">
481 <span class="command"><strong>
482 <code class="option">lua_startup_hook</code>
484 <code class="option">function_name [function arguments]</code>
486 This function, if defined, will be called by
487 Conky at startup or when the configuration is reloaded.
488 Use this hook to initialize values, or for any run-once
489 applications. Conky puts 'conky_' in front of
490 function_name to prevent accidental calls to the wrong
491 function unless you place 'conky_' in front of
492 it yourself.<p></p></dd><dt><span class="term">
493 <span class="command"><strong>
494 <code class="option">mail_spool</code>
496 </span></dt><dd>Mail spool for mail checking
497 <p></p></dd><dt><span class="term">
498 <span class="command"><strong>
499 <code class="option">max_port_monitor_connections</code>
501 </span></dt><dd>Allow each port monitor to track at most this
502 many connections (if 0 or not set, default is 256)
503 <p></p></dd><dt><span class="term">
504 <span class="command"><strong>
505 <code class="option">max_specials</code>
507 </span></dt><dd>Maximum number of special things, e.g. fonts,
508 offsets, aligns, etc. (default is 512)
509 <p></p></dd><dt><span class="term">
510 <span class="command"><strong>
511 <code class="option">max_text_width</code>
513 <code class="option">width</code>
514 </span></dt><dd>When a line in the output contains 'width'
515 chars and the end isn't reached, the next char will start
516 on a new line. If you want to make sure that lines don't
517 get broken, set 'width' to 0
518 <p></p></dd><dt><span class="term">
519 <span class="command"><strong>
520 <code class="option">max_user_text</code>
522 <code class="option">bytes</code>
523 </span></dt><dd>Maximum size of user text buffer, i.e. layout
524 below TEXT line in config file (default is 16384 bytes)
525 <p></p></dd><dt><span class="term">
526 <span class="command"><strong>
527 <code class="option">maximum_width</code>
529 <code class="option">pixels</code>
530 </span></dt><dd>Maximum width of window
531 <p></p></dd><dt><span class="term">
532 <span class="command"><strong>
533 <code class="option">minimum_size</code>
535 <code class="option">width (height)</code>
536 </span></dt><dd>Minimum size of window
537 <p></p></dd><dt><span class="term">
538 <span class="command"><strong>
539 <code class="option">mpd_host</code>
541 </span></dt><dd>Host of MPD server
542 <p></p></dd><dt><span class="term">
543 <span class="command"><strong>
544 <code class="option">mpd_password</code>
546 </span></dt><dd>MPD server password
547 <p></p></dd><dt><span class="term">
548 <span class="command"><strong>
549 <code class="option">mpd_port</code>
551 </span></dt><dd>Port of MPD server
552 <p></p></dd><dt><span class="term">
553 <span class="command"><strong>
554 <code class="option">music_player_interval</code>
556 </span></dt><dd>Music player thread update interval (defaults to
557 Conky's update interval)
558 <p></p></dd><dt><span class="term">
559 <span class="command"><strong>
560 <code class="option">net_avg_samples</code>
562 </span></dt><dd>The number of samples to average for net data
563 <p></p></dd><dt><span class="term">
564 <span class="command"><strong>
565 <code class="option">no_buffers</code>
567 </span></dt><dd>Subtract (file system) buffers from used memory?
569 <p></p></dd><dt><span class="term">
570 <span class="command"><strong>
571 <code class="option">out_to_console</code>
573 </span></dt><dd>Print text to stdout.
574 <p></p></dd><dt><span class="term">
575 <span class="command"><strong>
576 <code class="option">out_to_ncurses</code>
578 </span></dt><dd>Print text in the console, but use ncurses so
579 that conky can print the text of a new update over the old
580 text. (In the future this will provide more useful things)
581 <p></p></dd><dt><span class="term">
582 <span class="command"><strong>
583 <code class="option">out_to_stderr</code>
585 </span></dt><dd>Print text to stderr.
586 <p></p></dd><dt><span class="term">
587 <span class="command"><strong>
588 <code class="option">out_to_x</code>
590 </span></dt><dd>When set to no, there will be no output in X
591 (useful when you also use things like out_to_console). If
592 you set it to no, make sure that it's placed before all
593 other X-related setting (take the first line of your
594 configfile to be sure). Default value is yes
595 <p></p></dd><dt><span class="term">
596 <span class="command"><strong>
597 <code class="option">override_utf8_locale</code>
599 </span></dt><dd>Force UTF8? requires XFT
600 <p></p></dd><dt><span class="term">
601 <span class="command"><strong>
602 <code class="option">overwrite_file</code>
604 </span></dt><dd>Overwrite the file given as argument.
605 <p></p></dd><dt><span class="term">
606 <span class="command"><strong>
607 <code class="option">own_window</code>
609 </span></dt><dd>Boolean, create own window to draw?
610 <p></p></dd><dt><span class="term">
611 <span class="command"><strong>
612 <code class="option">own_window_class</code>
614 </span></dt><dd>Manually set the WM_CLASS name. Defaults to
616 <p></p></dd><dt><span class="term">
617 <span class="command"><strong>
618 <code class="option">own_window_colour</code>
620 <code class="option">colour</code>
621 </span></dt><dd>If own_window_transparent no, set a specified
622 background colour (defaults to black). Takes either a hex
623 value (e.g. ffffff, note the lack of '#') or a valid RGB
624 name (see /usr/lib/X11/rgb.txt)
625 <p></p></dd><dt><span class="term">
626 <span class="command"><strong>
627 <code class="option">own_window_hints</code>
629 <code class="option">
630 undecorated,below,above,sticky,skip_taskbar,skip_pager</code>
631 </span></dt><dd>If own_window is yes, you may use these window
632 manager hints to affect the way Conky displays. Notes: Use
633 own_window_type desktop as another way to implement many of
634 these hints implicitly. If you use own_window_type
635 override, window manager hints have no meaning and are
637 <p></p></dd><dt><span class="term">
638 <span class="command"><strong>
639 <code class="option">own_window_title</code>
641 </span></dt><dd>Manually set the window name. Defaults to
642 "<hostname> - conky".
643 <p></p></dd><dt><span class="term">
644 <span class="command"><strong>
645 <code class="option">own_window_argb_visual</code>
647 </span></dt><dd>Boolean, use ARGB visual? ARGB can be used for real
648 transparency, note that a composite manager is required for real
649 transparency. This option will not work as desired (in most cases)
650 in conjunction with 'own_window_type override'.
651 <p></p></dd><dt><span class="term">
652 <span class="command"><strong>
653 <code class="option">own_window_argb_value</code>
655 </span></dt><dd>When ARGB visuals are enabled, this use this to modify the alpha value used. Valid range is 0-255, where 0 is 0% opacity, and 255 is 100% opacity. Note that if own_window_transparent is enabled, this value has no effect.
656 <p></p></dd><dt><span class="term">
657 <span class="command"><strong>
658 <code class="option">own_window_transparent</code>
660 </span></dt><dd>Boolean, set transparency? If ARGB visual is enabled, sets
661 background opacity to 0%.
662 <p></p></dd><dt><span class="term">
663 <span class="command"><strong>
664 <code class="option">own_window_type</code>
666 </span></dt><dd>if own_window is yes, you may specify type
667 normal, desktop, dock, panel or override (default: normal).
668 Desktop windows are special windows that have no window
669 decorations; are always visible on your desktop; do not
670 appear in your pager or taskbar; and are sticky across all
671 workspaces. Panel windows reserve space along a desktop
672 edge, just like panels and taskbars, preventing maximized
673 windows from overlapping them. The edge is chosen based on
674 the alignment option. Override windows are not under the
675 control of the window manager. Hints are ignored. This type
676 of window can be useful for certain situations.
677 <p></p></dd><dt><span class="term">
678 <span class="command"><strong>
679 <code class="option">pad_percents</code>
681 </span></dt><dd>Pad percentages to this many decimals (0 = no
683 <p></p></dd><dt><span class="term">
684 <span class="command"><strong>
685 <code class="option">pop3</code>
687 </span></dt><dd>Default global POP3 server. Arguments are: "host
688 user pass [-i interval (in seconds)] [-p port] [-e 'command']
689 [-r retries]". Default port is 110, default interval is 5
690 minutes, and default number of retries before giving up is
691 5. If the password is supplied as '*', you will be prompted
692 to enter the password when Conky starts.
693 <p></p></dd><dt><span class="term">
694 <span class="command"><strong>
695 <code class="option">short_units</code>
697 </span></dt><dd>Shortens units to a single character (kiB->k,
698 GiB->G, etc.). Default is off.
699 <p></p></dd><dt><span class="term">
700 <span class="command"><strong>
701 <code class="option">show_graph_range</code>
703 </span></dt><dd>Shows the time range covered by a graph.
704 <p></p></dd><dt><span class="term">
705 <span class="command"><strong>
706 <code class="option">show_graph_scale</code>
708 </span></dt><dd>Shows the maximum value in scaled graphs.
709 <p></p></dd><dt><span class="term">
710 <span class="command"><strong>
711 <code class="option">stippled_borders</code>
713 </span></dt><dd>Border stippling (dashing) in pixels
714 <p></p></dd><dt><span class="term">
715 <span class="command"><strong>
716 <code class="option">temperature_unit</code>
718 </span></dt><dd>Desired output unit of all objects displaying a
719 temperature. Parameters are either "fahrenheit" or
720 "celsius". The default unit is degree Celsius.
721 <p></p></dd><dt><span class="term">
722 <span class="command"><strong>
723 <code class="option">templateN</code>
725 </span></dt><dd>Define a template for later use inside TEXT
726 segments. Substitute N by a digit between 0 and 9,
727 inclusively. The value of the variable is being inserted
728 into the stuff below TEXT at the corresponding position,
729 but before some substitutions are applied:
730 <table border="0" summary="Simple list" class="simplelist"><tr><td>'\n' -> newline</td></tr><tr><td>'\\' -> backslash</td></tr><tr><td>'\ ' -> space</td></tr><tr><td>'\N' -> template argument N</td></tr></table><p></p></dd><dt><span class="term">
731 <span class="command"><strong>
732 <code class="option">text_buffer_size</code>
734 <code class="option">bytes</code>
735 </span></dt><dd>Size of the standard text buffer (default is 256
736 bytes). This buffer is used for intermediary text, such as
737 individual lines, output from $exec vars, and various other
738 variables. Increasing the size of this buffer can
739 drastically reduce Conky's performance, but will allow for
740 more text display per variable. The size of this buffer
741 cannot be smaller than the default value of 256 bytes.
742 <p></p></dd><dt><span class="term">
743 <span class="command"><strong>
744 <code class="option">times_in_seconds</code>
746 </span></dt><dd>If true, variables that output times output a number
747 that represents seconds. This doesn't affect $time, $tztime and
749 <p></p></dd><dt><span class="term">
750 <span class="command"><strong>
751 <code class="option">top_cpu_separate</code>
753 </span></dt><dd>If true, cpu in top will show usage of one
754 processor's power. If false, cpu in top will show the usage
755 of all processors' power combined.
756 <p></p></dd><dt><span class="term">
757 <span class="command"><strong>
758 <code class="option">top_name_width</code>
760 </span></dt><dd>Width for $top name value (defaults to 15
762 <p></p></dd><dt><span class="term">
763 <span class="command"><strong>
764 <code class="option">total_run_times</code>
766 </span></dt><dd>Total number of times for Conky to update before
767 quitting. Zero makes Conky run forever
768 <p></p></dd><dt><span class="term">
769 <span class="command"><strong>
770 <code class="option">update_interval</code>
772 <code class="option">seconds</code>
773 </span></dt><dd>Update interval
774 <p></p></dd><dt><span class="term">
775 <span class="command"><strong>
776 <code class="option">update_interval_on_battery</code>
778 <code class="option">seconds</code>
779 </span></dt><dd>Update interval when running on batterypower
780 <p></p></dd><dt><span class="term">
781 <span class="command"><strong>
782 <code class="option">uppercase</code>
784 </span></dt><dd>Boolean value, if true, text is rendered in upper
786 <p></p></dd><dt><span class="term">
787 <span class="command"><strong>
788 <code class="option">use_spacer</code>
790 </span></dt><dd>Adds spaces around certain objects to stop them
791 from moving other things around. Arguments are left, right,
792 and none (default). The old true/false values are
793 deprecated and default to right/none respectively. Note
794 that this only helps if you are using a mono font, such as
795 Bitstream Vera Sans Mono.
796 <p></p></dd><dt><span class="term">
797 <span class="command"><strong>
798 <code class="option">use_xft</code>
800 </span></dt><dd>Use Xft (anti-aliased font and stuff)
801 <p></p></dd><dt><span class="term">
802 <span class="command"><strong>
803 <code class="option">xftalpha</code>
805 </span></dt><dd>Alpha of Xft font. Must be a value at or between
807 <p></p></dd><dt><span class="term">
808 <span class="command"><strong>
809 <code class="option">xftfont</code>
811 </span></dt><dd>Xft font to use.
812 <p></p></dd></dl></div></div><div class="refsect1" title="Objects/Variables"><a name="id518012"></a><h2>Objects/Variables</h2><p>Colours are parsed using XParsecolor(), there might be a
813 list of them: /usr/share/X11/rgb.txt.
814 Colour can be also in
815 #rrggbb format (hex).
817 Some objects may create threads, and sometimes these threads will
818 not be destroyed until Conky terminates. There is no way to
819 destroy or clean up threads while Conky is running. For example,
820 if you use an MPD variable, the MPD thread will keep running until
821 Conky dies. Some threaded objects will use one of the parameters
822 as a 'key', so that you only have 1 relevant thread running (for
823 example, the $curl, $rss and $weather objects launch one thread per
825 </p><div class="variablelist"><dl><dt><span class="term">
826 <span class="command"><strong>
827 <code class="option">acpiacadapter</code>
829 <code class="option">(adapter)</code>
830 </span></dt><dd>ACPI ac adapter state. On linux, the adapter option specifies the
831 subfolder of /sys/class/power_supply containing the state information (defaults
832 to "AC"). Other systems ignore it.
833 <p></p></dd><dt><span class="term">
834 <span class="command"><strong>
835 <code class="option">acpifan</code>
837 </span></dt><dd>ACPI fan state
838 <p></p></dd><dt><span class="term">
839 <span class="command"><strong>
840 <code class="option">acpitemp</code>
842 </span></dt><dd>ACPI temperature in C.
843 <p></p></dd><dt><span class="term">
844 <span class="command"><strong>
845 <code class="option">addr</code>
847 <code class="option">(interface)</code>
848 </span></dt><dd>IP address for an interface, or "No Address" if
849 no address is assigned.
850 <p></p></dd><dt><span class="term">
851 <span class="command"><strong>
852 <code class="option">addrs</code>
854 <code class="option">(interface)</code>
855 </span></dt><dd>IP addresses for an interface (if one - works
856 like addr). Linux only.
857 <p></p></dd><dt><span class="term">
858 <span class="command"><strong>
859 <code class="option">adt746xcpu</code>
861 </span></dt><dd>CPU temperature from therm_adt746x
862 <p></p></dd><dt><span class="term">
863 <span class="command"><strong>
864 <code class="option">adt746xfan</code>
866 </span></dt><dd>Fan speed from therm_adt746x
867 <p></p></dd><dt><span class="term">
868 <span class="command"><strong>
869 <code class="option">alignc</code>
871 <code class="option">(num)</code>
872 </span></dt><dd>Align text to centre
873 <p></p></dd><dt><span class="term">
874 <span class="command"><strong>
875 <code class="option">alignr</code>
877 <code class="option">(num)</code>
878 </span></dt><dd>Right-justify text, with space of N
879 <p></p></dd><dt><span class="term">
880 <span class="command"><strong>
881 <code class="option">apcupsd</code>
883 <code class="option">host</code>
884 <code class="option">port</code>
885 </span></dt><dd>Sets up the connection to apcupsd daemon. Prints
886 nothing, defaults to localhost:3551
887 <p></p></dd><dt><span class="term">
888 <span class="command"><strong>
889 <code class="option">apcupsd_cable</code>
891 </span></dt><dd>Prints the UPS connection type.
892 <p></p></dd><dt><span class="term">
893 <span class="command"><strong>
894 <code class="option">apcupsd_charge</code>
896 </span></dt><dd>Current battery capacity in percent.
897 <p></p></dd><dt><span class="term">
898 <span class="command"><strong>
899 <code class="option">apcupsd_lastxfer</code>
901 </span></dt><dd>Reason for last transfer from line to battery.
902 <p></p></dd><dt><span class="term">
903 <span class="command"><strong>
904 <code class="option">apcupsd_linev</code>
906 </span></dt><dd>Nominal input voltage.
907 <p></p></dd><dt><span class="term">
908 <span class="command"><strong>
909 <code class="option">apcupsd_load</code>
911 </span></dt><dd>Current load in percent.
912 <p></p></dd><dt><span class="term">
913 <span class="command"><strong>
914 <code class="option">apcupsd_loadbar</code>
916 </span></dt><dd>Bar showing current load.
917 <p></p></dd><dt><span class="term">
918 <span class="command"><strong>
919 <code class="option">apcupsd_loadgauge</code>
921 <code class="option">(height),(width)</code>
922 </span></dt><dd>Gauge that shows current load.
923 <p></p></dd><dt><span class="term">
924 <span class="command"><strong>
925 <code class="option">apcupsd_loadgraph</code>
927 <code class="option">(height),(width) (gradient colour 1) (gradient
928 colour 2) (scale) (-t) (-l)</code>
929 </span></dt><dd>History graph of current load.
930 <p></p></dd><dt><span class="term">
931 <span class="command"><strong>
932 <code class="option">apcupsd_model</code>
934 </span></dt><dd>Prints the model of the UPS.
935 <p></p></dd><dt><span class="term">
936 <span class="command"><strong>
937 <code class="option">apcupsd_name</code>
939 </span></dt><dd>Prints the UPS user-defined name.
940 <p></p></dd><dt><span class="term">
941 <span class="command"><strong>
942 <code class="option">apcupsd_status</code>
944 </span></dt><dd>Prints current status (on-line, on-battery).
945 <p></p></dd><dt><span class="term">
946 <span class="command"><strong>
947 <code class="option">apcupsd_temp</code>
949 </span></dt><dd>Current internal temperature.
950 <p></p></dd><dt><span class="term">
951 <span class="command"><strong>
952 <code class="option">apcupsd_timeleft</code>
954 </span></dt><dd>Time left to run on battery.
955 <p></p></dd><dt><span class="term">
956 <span class="command"><strong>
957 <code class="option">apcupsd_upsmode</code>
959 </span></dt><dd>Prints the UPS mode (e.g. standalone).
960 <p></p></dd><dt><span class="term">
961 <span class="command"><strong>
962 <code class="option">apm_adapter</code>
964 </span></dt><dd>Display APM AC adapter status (FreeBSD only)
965 <p></p></dd><dt><span class="term">
966 <span class="command"><strong>
967 <code class="option">apm_battery_life</code>
969 </span></dt><dd>Display APM battery life in percent (FreeBSD
971 <p></p></dd><dt><span class="term">
972 <span class="command"><strong>
973 <code class="option">apm_battery_time</code>
975 </span></dt><dd>Display remaining APM battery life in hh:mm:ss or
976 "unknown" if AC adapterstatus is on-line or charging
978 <p></p></dd><dt><span class="term">
979 <span class="command"><strong>
980 <code class="option">audacious_bar</code>
982 <code class="option">(height),(width)</code>
983 </span></dt><dd>Progress bar
984 <p></p></dd><dt><span class="term">
985 <span class="command"><strong>
986 <code class="option">audacious_bitrate</code>
988 </span></dt><dd>Bitrate of current tune
989 <p></p></dd><dt><span class="term">
990 <span class="command"><strong>
991 <code class="option">audacious_channels</code>
993 </span></dt><dd>Number of audio channels of current tune
994 <p></p></dd><dt><span class="term">
995 <span class="command"><strong>
996 <code class="option">audacious_filename</code>
998 </span></dt><dd>Full path and filename of current tune
999 <p></p></dd><dt><span class="term">
1000 <span class="command"><strong>
1001 <code class="option">audacious_frequency</code>
1003 </span></dt><dd>Sampling frequency of current tune
1004 <p></p></dd><dt><span class="term">
1005 <span class="command"><strong>
1006 <code class="option">audacious_length</code>
1008 </span></dt><dd>Total length of current tune as MM:SS
1009 <p></p></dd><dt><span class="term">
1010 <span class="command"><strong>
1011 <code class="option">audacious_length_seconds</code>
1013 </span></dt><dd>Total length of current tune in seconds
1014 <p></p></dd><dt><span class="term">
1015 <span class="command"><strong>
1016 <code class="option">audacious_main_volume</code>
1018 </span></dt><dd>The current volume fetched from Audacious
1019 <p></p></dd><dt><span class="term">
1020 <span class="command"><strong>
1021 <code class="option">audacious_playlist_length</code>
1023 </span></dt><dd>Number of tunes in playlist
1024 <p></p></dd><dt><span class="term">
1025 <span class="command"><strong>
1026 <code class="option">audacious_playlist_position</code>
1028 </span></dt><dd>Playlist position of current tune
1029 <p></p></dd><dt><span class="term">
1030 <span class="command"><strong>
1031 <code class="option">audacious_position</code>
1033 </span></dt><dd>Position of current tune (MM:SS)
1034 <p></p></dd><dt><span class="term">
1035 <span class="command"><strong>
1036 <code class="option">audacious_position_seconds</code>
1038 </span></dt><dd>Position of current tune in seconds
1039 <p></p></dd><dt><span class="term">
1040 <span class="command"><strong>
1041 <code class="option">audacious_status</code>
1043 </span></dt><dd>Player status (Playing/Paused/Stopped/Not
1045 <p></p></dd><dt><span class="term">
1046 <span class="command"><strong>
1047 <code class="option">audacious_title</code>
1049 <code class="option">(max length)</code>
1050 </span></dt><dd>Title of current tune with optional maximum
1052 <p></p></dd><dt><span class="term">
1053 <span class="command"><strong>
1054 <code class="option">battery</code>
1056 <code class="option">(num)</code>
1057 </span></dt><dd>Battery status and remaining percentage capacity
1058 of ACPI or APM battery. ACPI battery number can be given as
1059 argument (default is BAT0).
1060 <p></p></dd><dt><span class="term">
1061 <span class="command"><strong>
1062 <code class="option">battery_bar</code>
1064 <code class="option">(height),(width) (num)</code>
1065 </span></dt><dd>Battery percentage remaining of ACPI battery in a
1066 bar. ACPI battery number can be given as argument (default
1068 <p></p></dd><dt><span class="term">
1069 <span class="command"><strong>
1070 <code class="option">battery_percent</code>
1072 <code class="option">(num)</code>
1073 </span></dt><dd>Battery percentage remaining for ACPI battery.
1074 ACPI battery number can be given as argument (default is
1076 <p></p></dd><dt><span class="term">
1077 <span class="command"><strong>
1078 <code class="option">battery_short</code>
1080 <code class="option">(num)</code>
1081 </span></dt><dd>Battery status and remaining percentage capacity
1082 of ACPI or APM battery. ACPI battery number can be given as
1083 argument (default is BAT0). This mode display a short
1084 status, which means that C is displayed instead of
1085 charging, D for discharging, F for full, N for not present,
1086 E for empty and U for unknown.
1087 <p></p></dd><dt><span class="term">
1088 <span class="command"><strong>
1089 <code class="option">battery_time</code>
1091 <code class="option">(num)</code>
1092 </span></dt><dd>Battery charge/discharge time remaining of ACPI
1093 battery. ACPI battery number can be given as argument
1095 <p></p></dd><dt><span class="term">
1096 <span class="command"><strong>
1097 <code class="option">blink</code>
1099 <code class="option">text_and_other_conky_vars</code>
1100 </span></dt><dd>Let 'text_and_other_conky_vars' blink on and off.
1102 <p></p></dd><dt><span class="term">
1103 <span class="command"><strong>
1104 <code class="option">bmpx_album</code>
1106 </span></dt><dd>Album in current BMPx track
1107 <p></p></dd><dt><span class="term">
1108 <span class="command"><strong>
1109 <code class="option">bmpx_artist</code>
1111 </span></dt><dd>Artist in current BMPx track
1112 <p></p></dd><dt><span class="term">
1113 <span class="command"><strong>
1114 <code class="option">bmpx_bitrate</code>
1116 </span></dt><dd>Bitrate of the current BMPx track
1117 <p></p></dd><dt><span class="term">
1118 <span class="command"><strong>
1119 <code class="option">bmpx_title</code>
1121 </span></dt><dd>Title of the current BMPx track
1122 <p></p></dd><dt><span class="term">
1123 <span class="command"><strong>
1124 <code class="option">bmpx_track</code>
1126 </span></dt><dd>Track number of the current BMPx track
1127 <p></p></dd><dt><span class="term">
1128 <span class="command"><strong>
1129 <code class="option">bmpx_uri</code>
1131 </span></dt><dd>URI of the current BMPx track
1132 <p></p></dd><dt><span class="term">
1133 <span class="command"><strong>
1134 <code class="option">buffers</code>
1136 </span></dt><dd>Amount of memory buffered
1137 <p></p></dd><dt><span class="term">
1138 <span class="command"><strong>
1139 <code class="option">cached</code>
1141 </span></dt><dd>Amount of memory cached
1142 <p></p></dd><dt><span class="term">
1143 <span class="command"><strong>
1144 <code class="option">cmdline_to_pid</code>
1146 <code class="option">string</code>
1147 </span></dt><dd>PID of the first process that has string in it's
1149 <p></p></dd><dt><span class="term">
1150 <span class="command"><strong>
1151 <code class="option">color</code>
1153 <code class="option">(color)</code>
1154 </span></dt><dd>Change drawing color to 'color' which is a name of
1155 a color or a hexcode preceded with # (for example #0A1B2C ).
1156 If you use ncurses only the following colors are supported:
1157 red,green,yellow,blue,magenta,cyan,black,white.
1158 <p></p></dd><dt><span class="term">
1159 <span class="command"><strong>
1160 <code class="option">colorN</code>
1162 </span></dt><dd>Change drawing color to colorN configuration
1163 option, where N is a digit between 0 and 9, inclusively.
1164 <p></p></dd><dt><span class="term">
1165 <span class="command"><strong>
1166 <code class="option">combine</code>
1168 <code class="option">var1 var2</code>
1169 </span></dt><dd>Places the lines of var2 to the right of the
1170 lines of var1 separated by the chars that are put between
1171 var1 and var2. For example: ${combine ${head /proc/cpuinfo
1172 2} - ${head /proc/meminfo 1}} gives as output
1173 "cpuinfo_line1 - meminfo_line1" on line 1 and
1174 "cpuinfo_line2 -" on line 2. $combine vars can also be
1175 nested to place more vars next to each other.
1176 <p></p></dd><dt><span class="term">
1177 <span class="command"><strong>
1178 <code class="option">conky_build_arch</code>
1180 </span></dt><dd>CPU architecture Conky was built for
1181 <p></p></dd><dt><span class="term">
1182 <span class="command"><strong>
1183 <code class="option">conky_build_date</code>
1185 </span></dt><dd>Date Conky was built
1186 <p></p></dd><dt><span class="term">
1187 <span class="command"><strong>
1188 <code class="option">conky_version</code>
1190 </span></dt><dd>Conky version
1191 <p></p></dd><dt><span class="term">
1192 <span class="command"><strong>
1193 <code class="option">cpu</code>
1195 <code class="option">(cpuN)</code>
1196 </span></dt><dd>CPU usage in percents. For SMP machines, the CPU
1197 number can be provided as an argument. ${cpu cpu0} is the
1198 total usage, and ${cpu cpuX} (X >= 1) are individual
1200 <p></p></dd><dt><span class="term">
1201 <span class="command"><strong>
1202 <code class="option">cpubar</code>
1204 <code class="option">(cpuN) (height),(width)</code>
1205 </span></dt><dd>Bar that shows CPU usage, height is bar's height
1206 in pixels. See $cpu for more info on SMP.
1207 <p></p></dd><dt><span class="term">
1208 <span class="command"><strong>
1209 <code class="option">cpugauge</code>
1211 <code class="option">(cpuN) (height),(width)</code>
1212 </span></dt><dd>Elliptical gauge that shows CPU usage, height and
1213 width are gauge's vertical and horizontal axis
1214 respectively. See $cpu for more info on SMP.
1215 <p></p></dd><dt><span class="term">
1216 <span class="command"><strong>
1217 <code class="option">cpugraph</code>
1219 <code class="option">(cpuN) (height),(width) (gradient colour 1)
1220 (gradient colour 2) (scale) (-t) (-l)</code>
1221 </span></dt><dd>CPU usage graph, with optional colours in hex,
1222 minus the #. See $cpu for more info on SMP. Uses a
1223 logarithmic scale (to see small numbers) when you use the
1224 -l switch. Takes the switch '-t' to use a temperature
1225 gradient, which makes the gradient values change depending
1226 on the amplitude of a particular graph value (try it and
1228 <p></p></dd><dt><span class="term">
1229 <span class="command"><strong>
1230 <code class="option">curl</code>
1232 <code class="option">url (interval_in_minutes)</code>
1233 </span></dt><dd><p>Download data from URI using Curl at the
1234 specified interval. The interval may be a floating
1235 point value greater than 0, otherwise defaults to 15
1236 minutes. Most useful when used in conjunction with Lua
1237 and the Lua API. This object is threaded, and once a
1238 thread is created it can't be explicitly destroyed.
1239 One thread will run for each URI specified. You can use
1240 any protocol that Curl supports.</p></dd><dt><span class="term">
1241 <span class="command"><strong>
1242 <code class="option">desktop</code>
1244 </span></dt><dd>Number of the desktop on which conky is running
1245 or the message "Not running in X" if this is the case.
1246 <p></p></dd><dt><span class="term">
1247 <span class="command"><strong>
1248 <code class="option">desktop_name</code>
1250 </span></dt><dd>Name of the desktop on which conky is running or
1251 the message "Not running in X" if this is the case.
1252 <p></p></dd><dt><span class="term">
1253 <span class="command"><strong>
1254 <code class="option">desktop_number</code>
1256 </span></dt><dd>Number of desktops or the message "Not running in
1257 X" if this is the case.
1258 <p></p></dd><dt><span class="term">
1259 <span class="command"><strong>
1260 <code class="option">disk_protect</code>
1262 <code class="option">device</code>
1263 </span></dt><dd>Disk protection status, if supported (needs
1264 kernel-patch). Prints either "frozen" or "free " (note the
1266 <p></p></dd><dt><span class="term">
1267 <span class="command"><strong>
1268 <code class="option">diskio</code>
1270 <code class="option">(device)</code>
1271 </span></dt><dd>Displays current disk IO. Device is optional, and
1272 takes the form of sda for /dev/sda. Individual partitions
1274 <p></p></dd><dt><span class="term">
1275 <span class="command"><strong>
1276 <code class="option">diskio_read</code>
1278 <code class="option">(device)</code>
1279 </span></dt><dd>Displays current disk IO for reads. Device as in
1281 <p></p></dd><dt><span class="term">
1282 <span class="command"><strong>
1283 <code class="option">diskio_write</code>
1285 <code class="option">(device)</code>
1286 </span></dt><dd>Displays current disk IO for writes. Device as in
1288 <p></p></dd><dt><span class="term">
1289 <span class="command"><strong>
1290 <code class="option">diskiograph</code>
1292 <code class="option">(device) (height),(width) (gradient colour 1)
1293 (gradient colour 2) (scale) (-t) (-l)</code>
1294 </span></dt><dd>Disk IO graph, colours defined in hex, minus the
1295 #. If scale is non-zero, it becomes the scale for the
1296 graph. Uses a logarithmic scale (to see small numbers) when
1297 you use -l switch. Takes the switch '-t' to use a
1298 temperature gradient, which makes the gradient values
1299 change depending on the amplitude of a particular graph
1300 value (try it and see).
1301 <p></p></dd><dt><span class="term">
1302 <span class="command"><strong>
1303 <code class="option">diskiograph_read</code>
1305 <code class="option">(device) (height),(width) (gradient colour 1)
1306 (gradient colour 2) (scale) (-t) (-l)</code>
1307 </span></dt><dd>Disk IO graph for reads, colours defined in hex,
1308 minus the #. If scale is non-zero, it becomes the scale for
1309 the graph. Device as in diskio. Uses a logarithmic scale
1310 (to see small numbers) when you use -l switch. Takes the
1311 switch '-t' to use a temperature gradient, which makes the
1312 gradient values change depending on the amplitude of a
1313 particular graph value (try it and see).
1314 <p></p></dd><dt><span class="term">
1315 <span class="command"><strong>
1316 <code class="option">diskiograph_write</code>
1318 <code class="option">(device) (height),(width) (gradient colour 1)
1319 (gradient colour 2) (scale) (-t) (-l)</code>
1320 </span></dt><dd>Disk IO graph for writes, colours defined in hex,
1321 minus the #. If scale is non-zero, it becomes the scale for
1322 the graph. Device as in diskio. Uses a logarithmic scale
1323 (to see small numbers) when you use -l switch. Takes the
1324 switch '-t' to use a temperature gradient, which makes the
1325 gradient values change depending on the amplitude of a
1326 particular graph value (try it and see).
1327 <p></p></dd><dt><span class="term">
1328 <span class="command"><strong>
1329 <code class="option">downspeed</code>
1331 <code class="option">(net)</code>
1332 </span></dt><dd>Download speed in suitable IEC units
1333 <p></p></dd><dt><span class="term">
1334 <span class="command"><strong>
1335 <code class="option">downspeedf</code>
1337 <code class="option">(net)</code>
1338 </span></dt><dd>Download speed in KiB with one decimal
1339 <p></p></dd><dt><span class="term">
1340 <span class="command"><strong>
1341 <code class="option">downspeedgraph</code>
1343 <code class="option">(netdev) (height),(width) (gradient colour 1)
1344 (gradient colour 2) (scale) (-t) (-l)</code>
1345 </span></dt><dd>Download speed graph, colours defined in hex,
1346 minus the #. If scale is non-zero, it becomes the scale for
1347 the graph. Uses a logarithmic scale (to see small numbers)
1348 when you use -l switch. Takes the switch '-t' to use a
1349 temperature gradient, which makes the gradient values
1350 change depending on the amplitude of a particular graph
1351 value (try it and see).
1352 <p></p></dd><dt><span class="term">
1353 <span class="command"><strong>
1354 <code class="option">draft_mails</code>
1356 <code class="option">(maildir)</code>
1357 <code class="option">(interval)</code>
1358 </span></dt><dd>Number of mails marked as draft in the specified
1359 mailbox or mail spool if not. Only maildir type mailboxes
1360 are supported, mbox type will return -1.
1361 <p></p></dd><dt><span class="term">
1362 <span class="command"><strong>
1363 <code class="option">else</code>
1365 </span></dt><dd>Text to show if any of the above are not true
1366 <p></p></dd><dt><span class="term">
1367 <span class="command"><strong>
1368 <code class="option">endif</code>
1370 <code class="option"></code>
1371 </span></dt><dd>Ends an $if block.
1372 <p></p></dd><dt><span class="term">
1373 <span class="command"><strong>
1374 <code class="option">entropy_avail</code>
1376 </span></dt><dd>Current entropy available for crypto freaks
1377 <p></p></dd><dt><span class="term">
1378 <span class="command"><strong>
1379 <code class="option">entropy_bar</code>
1381 <code class="option">(height),(width)</code>
1382 </span></dt><dd>Normalized bar of available entropy for crypto
1384 <p></p></dd><dt><span class="term">
1385 <span class="command"><strong>
1386 <code class="option">entropy_perc</code>
1388 </span></dt><dd>Percentage of entropy available in comparison to
1390 <p></p></dd><dt><span class="term">
1391 <span class="command"><strong>
1392 <code class="option">entropy_poolsize</code>
1394 </span></dt><dd>Total size of system entropy pool for crypto
1396 <p></p></dd><dt><span class="term">
1397 <span class="command"><strong>
1398 <code class="option">eval</code>
1400 <code class="option">string</code>
1401 </span></dt><dd>Evaluates given string according to the rules of
1402 TEXT interpretation, i.e. parsing any contained text object
1403 specifications into their output, any occuring '$$' into a
1404 single '$' and so on. The output is then being parsed
1406 <p></p></dd><dt><span class="term">
1407 <span class="command"><strong>
1408 <code class="option">eve</code>
1410 <code class="option">api_userid api_key character_id</code>
1411 </span></dt><dd>Fetches your currently training skill from the
1412 Eve Online API servers (http://www.eve-online.com/) and
1413 displays the skill along with the remaining training time.
1414 <p></p></dd><dt><span class="term">
1415 <span class="command"><strong>
1416 <code class="option">exec</code>
1418 <code class="option">command</code>
1419 </span></dt><dd>Executes a shell command and displays the output
1420 in conky. warning: this takes a lot more resources than
1421 other variables. I'd recommend coding wanted behaviour in C
1422 and posting a patch.
1423 <p></p></dd><dt><span class="term">
1424 <span class="command"><strong>
1425 <code class="option">execbar</code>
1427 <code class="option">command</code>
1428 </span></dt><dd>Same as exec, except if the first value return is
1429 a value between 0-100, it will use that number for a bar.
1430 The size for bars can be controlled via the
1431 default_bar_size config setting.
1432 <p></p></dd><dt><span class="term">
1433 <span class="command"><strong>
1434 <code class="option">execgauge</code>
1436 <code class="option">command</code>
1437 </span></dt><dd>Same as exec, except if the first value returned
1438 is a value between 0-100, it will use that number for a
1439 gauge. The size for gauges can be controlled via the
1440 default_gauge_size config setting.
1441 <p></p></dd><dt><span class="term">
1442 <span class="command"><strong>
1443 <code class="option">execgraph</code>
1445 <code class="option">(-t) (-l) command</code>
1446 </span></dt><dd>Same as execbar, but graphs values. Uses a
1447 logaritmic scale when the log option (-l switch) is given
1448 (to see small numbers). Values still have to be between 0
1449 and 100. The size for graphs can be controlled via the
1450 default_graph_size config setting. Takes the switch '-t' to
1451 use a temperature gradient, which makes the gradient values
1452 change depending on the amplitude of a particular graph
1453 value (try it and see). If -t or -l is your first argument,
1454 you may need to preceed it by a space (' ').
1455 <p></p></dd><dt><span class="term">
1456 <span class="command"><strong>
1457 <code class="option">execi</code>
1459 <code class="option">interval command</code>
1460 </span></dt><dd>Same as exec but with specific interval. Interval
1461 can't be less than update_interval in configuration. See
1463 <p></p></dd><dt><span class="term">
1464 <span class="command"><strong>
1465 <code class="option">execibar</code>
1467 <code class="option">interval command</code>
1468 </span></dt><dd>Same as execbar, except with an interval
1469 <p></p></dd><dt><span class="term">
1470 <span class="command"><strong>
1471 <code class="option">execigauge</code>
1473 <code class="option">interval command</code>
1474 </span></dt><dd>Same as execgauge, but takes an interval arg and
1476 <p></p></dd><dt><span class="term">
1477 <span class="command"><strong>
1478 <code class="option">execigraph</code>
1480 <code class="option">interval (-t) (-l) command</code>
1481 </span></dt><dd>Same as execgraph, but takes an interval arg and
1482 graphs values. If -t or -l is your first argument, you may
1483 need to preceed it by a space (' ').
1484 <p></p></dd><dt><span class="term">
1485 <span class="command"><strong>
1486 <code class="option">execp</code>
1488 <code class="option">command</code>
1489 </span></dt><dd>Executes a shell command and displays the output
1490 in conky. warning: this takes a lot more resources than
1491 other variables. I'd recommend coding wanted behaviour in C
1492 and posting a patch. This differs from $exec in that it
1493 parses the output of the command, so you can insert things
1494 like ${color red}hi!${color} in your script and have it
1495 correctly parsed by Conky. Caveats: Conky parses and
1496 evaluates the output of $execp every time Conky loops, and
1497 then destroys all the objects. If you try to use anything
1498 like $execi within an $execp statement, it will
1499 functionally run at the same interval that the $execp
1500 statement runs, as it is created and destroyed at every
1502 <p></p></dd><dt><span class="term">
1503 <span class="command"><strong>
1504 <code class="option">execpi</code>
1506 <code class="option">interval command</code>
1507 </span></dt><dd>Same as execp but with specific interval.
1508 Interval can't be less than update_interval in
1509 configuration. Note that the output from the $execpi
1510 command is still parsed and evaluated at every interval.
1511 <p></p></dd><dt><span class="term">
1512 <span class="command"><strong>
1513 <code class="option">flagged_mails</code>
1515 <code class="option">(maildir)</code>
1516 <code class="option">(interval)</code>
1517 </span></dt><dd>Number of mails marked as flagged in the
1518 specified mailbox or mail spool if not. Only maildir type
1519 mailboxes are supported, mbox type will return -1.
1520 <p></p></dd><dt><span class="term">
1521 <span class="command"><strong>
1522 <code class="option">font</code>
1524 <code class="option">(font)</code>
1525 </span></dt><dd>Specify a different font. This new font will
1526 apply to the current line and everything following. You can
1527 use a $font with no arguments to change back to the default
1528 font (much like with $color)
1529 <p></p></dd><dt><span class="term">
1530 <span class="command"><strong>
1531 <code class="option">format_time</code>
1533 <code class="option">seconds format</code>
1534 </span></dt><dd>Format time given in seconds. This var only works when
1535 the times_in_seconds configuration setting is on. Format is a string
1536 that should start and end with a "-char. The "-chars are not
1537 part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
1538 weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
1539 it's value will be expressed in the highest unite lower then the
1540 one left out. Text between ()-chars will not be visible if a
1541 replaced unit in this text is 0. If seconds is a decimal number
1542 then you can see the numbers behind the point by using \S
1543 followed by a number that specifies the amount of
1544 digits behind the point that you want to see (maximum 9).
1545 You can also place a 'x' behind \S so you have all digits behind
1546 the point and no trailing zero's. (also maximum 9)
1547 <p></p></dd><dt><span class="term">
1548 <span class="command"><strong>
1549 <code class="option">forwarded_mails</code>
1551 <code class="option">(maildir)</code>
1552 <code class="option">(interval)</code>
1553 </span></dt><dd>Number of mails marked as forwarded in the
1554 specified mailbox or mail spool if not. Only maildir type
1555 mailboxes are supported, mbox type will return -1.
1556 <p></p></dd><dt><span class="term">
1557 <span class="command"><strong>
1558 <code class="option">freq</code>
1560 <code class="option">(n)</code>
1561 </span></dt><dd>Returns CPU #n's frequency in MHz. CPUs are
1562 counted from 1. If omitted, the parameter defaults to 1.
1563 <p></p></dd><dt><span class="term">
1564 <span class="command"><strong>
1565 <code class="option">freq_g</code>
1567 <code class="option">(n)</code>
1568 </span></dt><dd>Returns CPU #n's frequency in GHz. CPUs are
1569 counted from 1. If omitted, the parameter defaults to 1.
1570 <p></p></dd><dt><span class="term">
1571 <span class="command"><strong>
1572 <code class="option">fs_bar</code>
1574 <code class="option">(height),(width) fs</code>
1575 </span></dt><dd>Bar that shows how much space is used on a file
1576 system. height is the height in pixels. fs is any file on
1578 <p></p></dd><dt><span class="term">
1579 <span class="command"><strong>
1580 <code class="option">fs_bar_free</code>
1582 <code class="option">(height),(width) fs</code>
1583 </span></dt><dd>Bar that shows how much space is free on a file
1584 system. height is the height in pixels. fs is any file on
1586 <p></p></dd><dt><span class="term">
1587 <span class="command"><strong>
1588 <code class="option">fs_free</code>
1590 <code class="option">(fs)</code>
1591 </span></dt><dd>Free space on a file system available for users.
1592 <p></p></dd><dt><span class="term">
1593 <span class="command"><strong>
1594 <code class="option">fs_free_perc</code>
1596 <code class="option">(fs)</code>
1597 </span></dt><dd>Free percentage of space on a file system
1598 available for users.
1599 <p></p></dd><dt><span class="term">
1600 <span class="command"><strong>
1601 <code class="option">fs_size</code>
1603 <code class="option">(fs)</code>
1604 </span></dt><dd>File system size.
1605 <p></p></dd><dt><span class="term">
1606 <span class="command"><strong>
1607 <code class="option">fs_type</code>
1609 <code class="option">(fs)</code>
1610 </span></dt><dd>File system type.
1611 <p></p></dd><dt><span class="term">
1612 <span class="command"><strong>
1613 <code class="option">fs_used</code>
1615 <code class="option">(fs)</code>
1616 </span></dt><dd>File system used space.
1617 <p></p></dd><dt><span class="term">
1618 <span class="command"><strong>
1619 <code class="option">fs_used_perc</code>
1621 <code class="option">(fs)</code>
1622 </span></dt><dd>Percent of file system used space.
1623 <p></p></dd><dt><span class="term">
1624 <span class="command"><strong>
1625 <code class="option">goto</code>
1627 <code class="option">x</code>
1628 </span></dt><dd>The next element will be printed at position 'x'.
1630 <p></p></dd><dt><span class="term">
1631 <span class="command"><strong>
1632 <code class="option">gw_iface</code>
1634 </span></dt><dd>Displays the default route's interface or
1635 "multiple"/"none" accordingly.
1636 <p></p></dd><dt><span class="term">
1637 <span class="command"><strong>
1638 <code class="option">gw_ip</code>
1640 </span></dt><dd>Displays the default gateway's IP or
1641 "multiple"/"none" accordingly.
1642 <p></p></dd><dt><span class="term">
1643 <span class="command"><strong>
1644 <code class="option">hddtemp</code>
1646 <code class="option">(dev)</code>
1647 </span></dt><dd>Displays temperature of a selected hard disk
1648 drive as reported by the hddtemp daemon. Use hddtemp_host
1649 and hddtemp_port to specify a host and port for all hddtemp
1650 objects. If no dev parameter is given, the first disk returned
1651 by the hddtemp daemon is used.
1652 <p></p></dd><dt><span class="term">
1653 <span class="command"><strong>
1654 <code class="option">head</code>
1656 <code class="option">logfile lines (next_check)</code>
1657 </span></dt><dd>Displays first N lines of supplied text file. The
1658 file is checked every 'next_check' update. If next_check is
1659 not supplied, Conky defaults to 2. Max of 30 lines can be
1660 displayed, or until the text buffer is filled.
1661 <p></p></dd><dt><span class="term">
1662 <span class="command"><strong>
1663 <code class="option">hr</code>
1665 <code class="option">(height)</code>
1666 </span></dt><dd>Horizontal line, height is the height in pixels
1667 <p></p></dd><dt><span class="term">
1668 <span class="command"><strong>
1669 <code class="option">hwmon</code>
1671 <code class="option">(dev) type n (factor offset)</code>
1672 </span></dt><dd>Hwmon sensor from sysfs (Linux 2.6). Parameter
1673 dev may be omitted if you have only one hwmon device.
1674 Parameter type is either 'in' or 'vol' meaning voltage;
1675 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1676 is number of the sensor. See /sys/class/hwmon/ on your
1677 local computer. The optional arguments 'factor' and
1678 'offset' allow precalculation of the raw input, which is
1679 being modified as follows: 'input = input * factor +
1680 offset'. Note that they have to be given as decimal values
1681 (i.e. contain at least one decimal place).
1682 <p></p></dd><dt><span class="term">
1683 <span class="command"><strong>
1684 <code class="option">i2c</code>
1686 <code class="option">(dev) type n (factor offset)</code>
1687 </span></dt><dd>I2C sensor from sysfs (Linux 2.6). Parameter dev
1688 may be omitted if you have only one I2C device. Parameter
1689 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1690 fan; 'temp' meaning temperature. Parameter n is number of
1691 the sensor. See /sys/bus/i2c/devices/ on your local
1692 computer. The optional arguments 'factor' and 'offset'
1693 allow precalculation of the raw input, which is being
1694 modified as follows: 'input = input * factor + offset'.
1695 Note that they have to be given as decimal values (i.e.
1696 contain at least one decimal place).
1697 <p></p></dd><dt><span class="term">
1698 <span class="command"><strong>
1699 <code class="option">i8k_ac_status</code>
1701 <code class="option"></code>
1702 </span></dt><dd>If running the i8k kernel driver for Inspiron
1703 laptops, displays whether ac power is on, as listed in
1704 /proc/i8k (translated to human-readable). Beware that this
1705 is by default not enabled by i8k itself.
1706 <p></p></dd><dt><span class="term">
1707 <span class="command"><strong>
1708 <code class="option">i8k_bios</code>
1710 <code class="option"></code>
1711 </span></dt><dd>If running the i8k kernel driver for Inspiron
1712 laptops, displays the bios version as listed in /proc/i8k.
1713 <p></p></dd><dt><span class="term">
1714 <span class="command"><strong>
1715 <code class="option">i8k_buttons_status</code>
1717 <code class="option"></code>
1718 </span></dt><dd>If running the i8k kernel driver for Inspiron
1719 laptops, displays the volume buttons status as listed in
1721 <p></p></dd><dt><span class="term">
1722 <span class="command"><strong>
1723 <code class="option">i8k_cpu_temp</code>
1725 <code class="option"></code>
1726 </span></dt><dd>If running the i8k kernel driver for Inspiron
1727 laptops, displays the cpu temperature in Celsius, as
1728 reported by /proc/i8k.
1729 <p></p></dd><dt><span class="term">
1730 <span class="command"><strong>
1731 <code class="option">i8k_left_fan_rpm</code>
1733 <code class="option"></code>
1734 </span></dt><dd>If running the i8k kernel driver for Inspiron
1735 laptops, displays the left fan's rate of rotation, in
1736 revolutions per minute as listed in /proc/i8k. Beware, some
1737 laptops i8k reports these fans in reverse order.
1738 <p></p></dd><dt><span class="term">
1739 <span class="command"><strong>
1740 <code class="option">i8k_left_fan_status</code>
1742 <code class="option"></code>
1743 </span></dt><dd>If running the i8k kernel driver for Inspiron
1744 laptops, displays the left fan status as listed in
1745 /proc/i8k (translated to human-readable). Beware, some
1746 laptops i8k reports these fans in reverse order.
1747 <p></p></dd><dt><span class="term">
1748 <span class="command"><strong>
1749 <code class="option">i8k_right_fan_rpm</code>
1751 <code class="option"></code>
1752 </span></dt><dd>If running the i8k kernel driver for Inspiron
1753 laptops, displays the right fan's rate of rotation, in
1754 revolutions per minute as listed in /proc/i8k. Beware, some
1755 laptops i8k reports these fans in reverse order.
1756 <p></p></dd><dt><span class="term">
1757 <span class="command"><strong>
1758 <code class="option">i8k_right_fan_status</code>
1760 <code class="option"></code>
1761 </span></dt><dd>If running the i8k kernel driver for Inspiron
1762 laptops, displays the right fan status as listed in
1763 /proc/i8k (translated to human-readable). Beware, some
1764 laptops i8k reports these fans in reverse order.
1765 <p></p></dd><dt><span class="term">
1766 <span class="command"><strong>
1767 <code class="option">i8k_serial</code>
1769 <code class="option"></code>
1770 </span></dt><dd>If running the i8k kernel driver for Inspiron
1771 laptops, displays your laptop serial number as listed in
1773 <p></p></dd><dt><span class="term">
1774 <span class="command"><strong>
1775 <code class="option">i8k_version</code>
1777 <code class="option"></code>
1778 </span></dt><dd>If running the i8k kernel driver for Inspiron
1779 laptops, displays the version formatting of /proc/i8k.
1780 <p></p></dd><dt><span class="term">
1781 <span class="command"><strong>
1782 <code class="option">ibm_brightness</code>
1784 </span></dt><dd>If running the IBM ACPI, displays the brigtness
1785 of the laptops's LCD (0-7).
1786 <p></p></dd><dt><span class="term">
1787 <span class="command"><strong>
1788 <code class="option">ibm_fan</code>
1790 </span></dt><dd>If running the IBM ACPI, displays the fan speed.
1791 <p></p></dd><dt><span class="term">
1792 <span class="command"><strong>
1793 <code class="option">ibm_temps</code>
1795 <code class="option">N</code>
1796 </span></dt><dd>If running the IBM ACPI, displays the
1797 temperatures from the IBM temperature sensors (N=0..7)
1798 Sensor 0 is on the CPU, 3 is on the GPU.
1799 <p></p></dd><dt><span class="term">
1800 <span class="command"><strong>
1801 <code class="option">ibm_volume</code>
1803 </span></dt><dd>If running the IBM ACPI, displays the "master"
1804 volume, controlled by the volume keys (0-14).
1805 <p></p></dd><dt><span class="term">
1806 <span class="command"><strong>
1807 <code class="option">iconv_start</code>
1809 <code class="option">codeset_from codeset_to</code>
1810 </span></dt><dd>Convert text from one codeset to another using
1811 GNU iconv. Needs to be stopped with iconv_stop.
1812 <p></p></dd><dt><span class="term">
1813 <span class="command"><strong>
1814 <code class="option">iconv_stop</code>
1816 <code class="option"></code>
1817 </span></dt><dd>Stop iconv codeset conversion.
1818 <p></p></dd><dt><span class="term">
1819 <span class="command"><strong>
1820 <code class="option">if_empty</code>
1822 <code class="option">(var)</code>
1823 </span></dt><dd>if conky variable VAR is empty, display
1824 everything between $if_empty and the matching $endif
1825 <p></p></dd><dt><span class="term">
1826 <span class="command"><strong>
1827 <code class="option">if_existing</code>
1829 <code class="option">file (string)</code>
1830 </span></dt><dd>if FILE exists, display everything between
1831 if_existing and the matching $endif. The optional second
1832 paramater checks for FILE containing the specified string
1833 and prints everything between $if_existing and the matching
1835 <p></p></dd><dt><span class="term">
1836 <span class="command"><strong>
1837 <code class="option">if_gw</code>
1839 </span></dt><dd>if there is at least one default gateway, display
1840 everything between $if_gw and the matching $endif
1841 <p></p></dd><dt><span class="term">
1842 <span class="command"><strong>
1843 <code class="option">if_match</code>
1845 <code class="option">expression</code>
1846 </span></dt><dd>Evaluates the given boolean expression, printing
1847 everything between $if_match and the matching $endif
1848 depending on whether the evaluation returns true or not.
1849 Valid expressions consist of a left side, an operator and a
1850 right side. Left and right sides are being parsed for
1851 contained text objects before evaluation. Recognised left
1852 and right side types are:
1853 <table border="0" summary="Simple list" class="simplelist"><tr><td>
1854 <span class="command"><strong>double</strong></span>Argument consists of only
1855 digits and a single dot.</td></tr><tr><td>
1856 <span class="command"><strong>long</strong></span>Argument consists of only
1857 digits.</td></tr><tr><td>
1858 <span class="command"><strong>string</strong></span>Argument is enclosed in
1859 quotation marks (")</td></tr></table>Valid operands are: '>', '<', '>=',
1860 '<=', '==', '!='.
1861 <p></p></dd><dt><span class="term">
1862 <span class="command"><strong>
1863 <code class="option">if_mixer_mute</code>
1865 <code class="option">(mixer)</code>
1866 </span></dt><dd>If mixer exists, display everything between
1867 $if_mixer_mute and the matching $endif. If no mixer is
1868 specified, "Master" is used.
1869 <p></p></dd><dt><span class="term">
1870 <span class="command"><strong>
1871 <code class="option">if_mounted</code>
1873 <code class="option">(mountpoint)</code>
1874 </span></dt><dd>if MOUNTPOINT is mounted, display everything
1875 between $if_mounted and the matching $endif
1876 <p></p></dd><dt><span class="term">
1877 <span class="command"><strong>
1878 <code class="option">if_mpd_playing</code>
1880 </span></dt><dd>if mpd is playing or paused, display everything
1881 between $if_mpd_playing and the matching $endif
1882 <p></p></dd><dt><span class="term">
1883 <span class="command"><strong>
1884 <code class="option">if_running</code>
1886 <code class="option">(process)</code>
1887 </span></dt><dd>if PROCESS is running, display everything
1888 $if_running and the matching $endif. This uses the
1889 ``pidof'' command, so the -x switch is also supported.
1890 <p></p></dd><dt><span class="term">
1891 <span class="command"><strong>
1892 <code class="option">if_smapi_bat_installed</code>
1894 <code class="option">(INDEX)</code>
1895 </span></dt><dd>when using smapi, if the battery with index INDEX
1896 is installed, display everything between
1897 $if_smapi_bat_installed and the matching $endif
1898 <p></p></dd><dt><span class="term">
1899 <span class="command"><strong>
1900 <code class="option">if_up</code>
1902 <code class="option">(interface)</code>
1903 </span></dt><dd>if INTERFACE exists and is up, display everything
1904 between $if_up and the matching $endif
1905 <p></p></dd><dt><span class="term">
1906 <span class="command"><strong>
1907 <code class="option">if_updatenr</code>
1909 <code class="option">(updatenr)</code>
1910 </span></dt><dd>If it's the UPDATENR-th time that conky updates,
1911 display everything between $if_updatenr and the matching
1912 $endif. The counter resets when the highest UPDATENR is
1913 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1914 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1915 time followed by bar 25% of the time followed by nothing
1916 the other half of the time.
1917 <p></p></dd><dt><span class="term">
1918 <span class="command"><strong>
1919 <code class="option">if_xmms2_connected</code>
1921 </span></dt><dd>Display everything between $if_xmms2_connected
1922 and the matching $endif if xmms2 is running.
1923 <p></p></dd><dt><span class="term">
1924 <span class="command"><strong>
1925 <code class="option">image</code>
1927 <code class="option"><path to image> (-p x,y) (-s WxH) (-n)
1928 (-f interval)</code>
1929 </span></dt><dd>Renders an image from the path specified using
1930 Imlib2. Takes 4 optional arguments: a position, a size, a
1931 no-cache switch, and a cache flush interval. Changing the
1932 x,y position will move the position of the image, and
1933 changing the WxH will scale the image. If you specify the
1934 no-cache flag (-n), the image will not be cached.
1935 Alternately, you can specify the -f int switch to specify a
1936 cache flust interval for a particular image. Example:
1937 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1938 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1939 pixels. Conky does not make any attempt to adjust the
1940 position (or any other formatting) of images, they are just
1941 rendered as per the arguments passed. The only reason
1942 $image is part of the TEXT section, is to allow for runtime
1943 modifications, through $execp $lua_parse, or some other
1945 <p></p></dd><dt><span class="term">
1946 <span class="command"><strong>
1947 <code class="option">imap_messages</code>
1949 <code class="option">(args)</code>
1950 </span></dt><dd>Displays the number of messages in your global
1951 IMAP inbox by default. You can define individual IMAP
1952 inboxes separately by passing arguments to this object.
1953 Arguments are: "host user pass [-i interval (in seconds)]
1954 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1955 port is 143, default folder is 'INBOX', default interval is
1956 5 minutes, and default number of retries before giving up
1957 is 5. If the password is supplied as '*', you will be
1958 prompted to enter the password when Conky starts.
1959 <p></p></dd><dt><span class="term">
1960 <span class="command"><strong>
1961 <code class="option">imap_unseen</code>
1963 <code class="option">(args)</code>
1964 </span></dt><dd>Displays the number of unseen messages in your
1965 global IMAP inbox by default. You can define individual
1966 IMAP inboxes separately by passing arguments to this
1967 object. Arguments are: "host user pass [-i interval (in
1968 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1969 Default port is 143, default folder is 'INBOX', default
1970 interval is 5 minutes, and default number of retries before
1971 giving up is 5. If the password is supplied as '*', you
1972 will be prompted to enter the password when Conky starts.
1973 <p></p></dd><dt><span class="term">
1974 <span class="command"><strong>
1975 <code class="option">include</code>
1977 <code class="option">path</code>
1978 </span></dt><dd><p>Loads the configfile at path, places the
1979 configsettings behind the configsettings in the orginal
1980 config and places the vars where the includevar
1981 stood.</p></dd><dt><span class="term">
1982 <span class="command"><strong>
1983 <code class="option">ioscheduler</code>
1985 <code class="option">disk</code>
1986 </span></dt><dd>Prints the current ioscheduler used for the given
1987 disk name (i.e. e.g. "hda" or "sdb")
1988 <p></p></dd><dt><span class="term">
1989 <span class="command"><strong>
1990 <code class="option">kernel</code>
1992 </span></dt><dd>Kernel version
1993 <p></p></dd><dt><span class="term">
1994 <span class="command"><strong>
1995 <code class="option">laptop_mode</code>
1997 </span></dt><dd>The value of /proc/sys/vm/laptop_mode
1998 <p></p></dd><dt><span class="term">
1999 <span class="command"><strong>
2000 <code class="option">lines</code>
2002 <code class="option">textfile</code>
2003 </span></dt><dd>Displays the number of lines in the given file
2004 <p></p></dd><dt><span class="term">
2005 <span class="command"><strong>
2006 <code class="option">loadavg</code>
2008 <code class="option">(1|2|3)</code>
2009 </span></dt><dd>System load average, 1 is for past 1 minute, 2
2010 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
2011 all three values separated by whitespace.
2012 <p></p></dd><dt><span class="term">
2013 <span class="command"><strong>
2014 <code class="option">loadgraph</code>
2016 <code class="option">(height),(width) (gradient colour 1)
2017 (gradient colour 2) (scale) (-t) (-l)</code>
2018 </span></dt><dd>Load1 average graph, similar to xload, with
2019 optional colours in hex, minus the #. Uses a logarithmic
2020 scale (to see small numbers) when you use the -l switch.
2021 Takes the switch '-t' to use a temperature gradient, which
2022 makes the gradient values change depending on the amplitude
2023 of a particular graph value (try it and see).
2024 <p></p></dd><dt><span class="term">
2025 <span class="command"><strong>
2026 <code class="option">lua</code>
2028 <code class="option">function_name (function parameters)</code>
2029 </span></dt><dd>Executes a Lua function with given parameters,
2030 then prints the returned string. See also 'lua_load' on how
2031 to load scripts. Conky puts 'conky_' in front of
2032 function_name to prevent accidental calls to the wrong
2033 function unless you put you place 'conky_' in front of it
2035 <p></p></dd><dt><span class="term">
2036 <span class="command"><strong>
2037 <code class="option">lua_bar</code>
2039 <code class="option">(height, width) function_name (function
2041 </span></dt><dd>Executes a Lua function with given parameters and
2042 draws a bar. Expects result value to be an integer between
2043 0 and 100. See also 'lua_load' on how to load scripts.
2044 Conky puts 'conky_' in front of function_name to prevent
2045 accidental calls to the wrong function unless you put you
2046 place 'conky_' in front of it yourself.
2047 <p></p></dd><dt><span class="term">
2048 <span class="command"><strong>
2049 <code class="option">lua_gauge</code>
2051 <code class="option">(height, width) function_name (function
2053 </span></dt><dd>Executes a Lua function with given parameters and
2054 draws a gauge. Expects result value to be an integer
2055 between 0 and 100. See also 'lua_load' on how to load
2056 scripts. Conky puts 'conky_' in front of function_name to
2057 prevent accidental calls to the wrong function unless you
2058 put you place 'conky_' in front of it yourself.
2059 <p></p></dd><dt><span class="term">
2060 <span class="command"><strong>
2061 <code class="option">lua_graph</code>
2063 <code class="option">function_name (height),(width) (gradient colour
2064 1) (gradient colour 2) (scale) (-t) (-l)</code>
2065 </span></dt><dd>Executes a Lua function with and draws a graph.
2066 Expects result value to be any number, and by default will
2067 scale to show the full range. See also 'lua_load' on how to
2068 load scripts. Takes the switch '-t' to use a temperature
2069 gradient, which makes the gradient values change depending
2070 on the amplitude of a particular graph value (try it and
2071 see). Conky puts 'conky_' in front of function_name to
2072 prevent accidental calls to the wrong function unless you
2073 put you place 'conky_' in front of it yourself.
2074 <p></p></dd><dt><span class="term">
2075 <span class="command"><strong>
2076 <code class="option">lua_parse</code>
2078 <code class="option">function_name (function parameters)</code>
2079 </span></dt><dd>Executes a Lua function with given parameters as
2080 per $lua, then parses and prints the result value as per
2081 the syntax for Conky's TEXT section. See also 'lua_load' on
2082 how to load scripts. Conky puts 'conky_' in front of
2083 function_name to prevent accidental calls to the wrong
2084 function unless you put you place 'conky_' in front of it
2086 <p></p></dd><dt><span class="term">
2087 <span class="command"><strong>
2088 <code class="option">machine</code>
2090 </span></dt><dd>Machine, i686 for example
2091 <p></p></dd><dt><span class="term">
2092 <span class="command"><strong>
2093 <code class="option">mails</code>
2095 <code class="option">(mailbox)</code>
2096 <code class="option">(interval)</code>
2097 </span></dt><dd>Mail count in the specified mailbox or your mail
2098 spool if not. Both mbox and maildir type mailboxes are
2099 supported. You can use a program like fetchmail to get
2100 mails from some server using your favourite protocol. See
2102 <p></p></dd><dt><span class="term">
2103 <span class="command"><strong>
2104 <code class="option">mboxscan</code>
2106 <code class="option">(-n number of messages to print) (-fw from
2107 width) (-sw subject width) mbox</code>
2108 </span></dt><dd>Print a summary of recent messages in an mbox
2109 format mailbox. mbox parameter is the filename of the
2110 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
2111 10 "/home/brenden/some box"}
2112 <p></p></dd><dt><span class="term">
2113 <span class="command"><strong>
2114 <code class="option">mem</code>
2116 </span></dt><dd>Amount of memory in use
2117 <p></p></dd><dt><span class="term">
2118 <span class="command"><strong>
2119 <code class="option">membar</code>
2121 <code class="option">(height),(width)</code>
2122 </span></dt><dd>Bar that shows amount of memory in use
2123 <p></p></dd><dt><span class="term">
2124 <span class="command"><strong>
2125 <code class="option">memeasyfree</code>
2127 </span></dt><dd>Amount of free memory including the memory that
2128 is very easily freed (buffers/cache)
2129 <p></p></dd><dt><span class="term">
2130 <span class="command"><strong>
2131 <code class="option">memfree</code>
2133 </span></dt><dd>Amount of free memory
2134 <p></p></dd><dt><span class="term">
2135 <span class="command"><strong>
2136 <code class="option">memgauge</code>
2138 <code class="option">(height),(width)</code>
2139 </span></dt><dd>Gauge that shows amount of memory in use (see
2141 <p></p></dd><dt><span class="term">
2142 <span class="command"><strong>
2143 <code class="option">memgraph</code>
2145 <code class="option">(height),(width) (gradient colour 1) (gradient
2146 colour 2) (scale) (-t) (-l)</code>
2147 </span></dt><dd>Memory usage graph. Uses a logarithmic scale (to
2148 see small numbers) when you use the -l switch. Takes the
2149 switch '-t' to use a temperature gradient, which makes the
2150 gradient values change depending on the amplitude of a
2151 particular graph value (try it and see).
2152 <p></p></dd><dt><span class="term">
2153 <span class="command"><strong>
2154 <code class="option">memmax</code>
2156 </span></dt><dd>Total amount of memory
2157 <p></p></dd><dt><span class="term">
2158 <span class="command"><strong>
2159 <code class="option">memperc</code>
2161 </span></dt><dd>Percentage of memory in use
2162 <p></p></dd><dt><span class="term">
2163 <span class="command"><strong>
2164 <code class="option">mixer</code>
2166 <code class="option">(device)</code>
2167 </span></dt><dd>Prints the mixer value as reported by the OS.
2168 Default mixer is "Master", but you can specify one of the
2169 available ALSA Simple mixer controls.
2170 You can find the list of those available on your system
2172 <p></p></dd><dt><span class="term">
2173 <span class="command"><strong>
2174 <code class="option">mixerbar</code>
2176 <code class="option">(device)</code>
2177 </span></dt><dd>Displays mixer value in a bar as reported by the
2178 OS. See docs for $mixer for details on arguments.
2179 <p></p></dd><dt><span class="term">
2180 <span class="command"><strong>
2181 <code class="option">mixerl</code>
2183 <code class="option">(device)</code>
2184 </span></dt><dd>Prints the left channel mixer value as reported
2185 by the OS. See docs for $mixer for details on arguments.
2186 <p></p></dd><dt><span class="term">
2187 <span class="command"><strong>
2188 <code class="option">mixerlbar</code>
2190 <code class="option">(device)</code>
2191 </span></dt><dd>Displays the left channel mixer value in a bar as
2192 reported by the OS. See docs for $mixer for details on
2194 <p></p></dd><dt><span class="term">
2195 <span class="command"><strong>
2196 <code class="option">mixerr</code>
2198 <code class="option">(device)</code>
2199 </span></dt><dd>Prints the right channel mixer value as reported
2200 by the OS. See docs for $mixer for details on arguments.
2201 <p></p></dd><dt><span class="term">
2202 <span class="command"><strong>
2203 <code class="option">mixerrbar</code>
2205 <code class="option">(device)</code>
2206 </span></dt><dd>Displays the right channel mixer value in a bar
2207 as reported by the OS. See docs for $mixer for details on
2209 <p></p></dd><dt><span class="term">
2210 <span class="command"><strong>
2211 <code class="option">moc_album</code>
2213 </span></dt><dd>Album of the current MOC song
2214 <p></p></dd><dt><span class="term">
2215 <span class="command"><strong>
2216 <code class="option">moc_artist</code>
2218 </span></dt><dd>Artist of the current MOC song
2219 <p></p></dd><dt><span class="term">
2220 <span class="command"><strong>
2221 <code class="option">moc_bitrate</code>
2223 </span></dt><dd>Bitrate in the current MOC song
2224 <p></p></dd><dt><span class="term">
2225 <span class="command"><strong>
2226 <code class="option">moc_curtime</code>
2228 </span></dt><dd>Current time of the current MOC song
2229 <p></p></dd><dt><span class="term">
2230 <span class="command"><strong>
2231 <code class="option">moc_file</code>
2233 </span></dt><dd>File name of the current MOC song
2234 <p></p></dd><dt><span class="term">
2235 <span class="command"><strong>
2236 <code class="option">moc_rate</code>
2238 </span></dt><dd>Rate of the current MOC song
2239 <p></p></dd><dt><span class="term">
2240 <span class="command"><strong>
2241 <code class="option">moc_song</code>
2243 </span></dt><dd>The current song name being played in MOC.
2244 <p></p></dd><dt><span class="term">
2245 <span class="command"><strong>
2246 <code class="option">moc_state</code>
2248 </span></dt><dd>Current state of MOC; playing, stopped etc.
2249 <p></p></dd><dt><span class="term">
2250 <span class="command"><strong>
2251 <code class="option">moc_timeleft</code>
2253 </span></dt><dd>Time left in the current MOC song
2254 <p></p></dd><dt><span class="term">
2255 <span class="command"><strong>
2256 <code class="option">moc_title</code>
2258 </span></dt><dd>Title of the current MOC song
2259 <p></p></dd><dt><span class="term">
2260 <span class="command"><strong>
2261 <code class="option">moc_totaltime</code>
2263 </span></dt><dd>Total length of the current MOC song
2264 <p></p></dd><dt><span class="term">
2265 <span class="command"><strong>
2266 <code class="option">monitor</code>
2268 </span></dt><dd>Number of the monitor on which conky is running
2269 or the message "Not running in X" if this is the case.
2270 <p></p></dd><dt><span class="term">
2271 <span class="command"><strong>
2272 <code class="option">monitor_number</code>
2274 </span></dt><dd>Number of monitors or the message "Not running in
2275 X" if this is the case.
2276 <p></p></dd><dt><span class="term">
2277 <span class="command"><strong>
2278 <code class="option">mpd_album</code>
2280 </span></dt><dd>Album in current MPD song
2281 <p></p></dd><dt><span class="term">
2282 <span class="command"><strong>
2283 <code class="option">mpd_artist</code>
2285 </span></dt><dd>Artist in current MPD song must be enabled at
2287 <p></p></dd><dt><span class="term">
2288 <span class="command"><strong>
2289 <code class="option">mpd_bar</code>
2291 <code class="option">(height),(width)</code>
2292 </span></dt><dd>Bar of mpd's progress
2293 <p></p></dd><dt><span class="term">
2294 <span class="command"><strong>
2295 <code class="option">mpd_bitrate</code>
2297 </span></dt><dd>Bitrate of current song
2298 <p></p></dd><dt><span class="term">
2299 <span class="command"><strong>
2300 <code class="option">mpd_elapsed</code>
2302 </span></dt><dd>Song's elapsed time
2303 <p></p></dd><dt><span class="term">
2304 <span class="command"><strong>
2305 <code class="option">mpd_file</code>
2307 </span></dt><dd>Prints the file name of the current MPD song
2308 <p></p></dd><dt><span class="term">
2309 <span class="command"><strong>
2310 <code class="option">mpd_length</code>
2312 </span></dt><dd>Song's length
2313 <p></p></dd><dt><span class="term">
2314 <span class="command"><strong>
2315 <code class="option">mpd_name</code>
2317 </span></dt><dd>Prints the MPD name field
2318 <p></p></dd><dt><span class="term">
2319 <span class="command"><strong>
2320 <code class="option">mpd_percent</code>
2322 </span></dt><dd>Percent of song's progress
2323 <p></p></dd><dt><span class="term">
2324 <span class="command"><strong>
2325 <code class="option">mpd_random</code>
2327 </span></dt><dd>Random status (On/Off)
2328 <p></p></dd><dt><span class="term">
2329 <span class="command"><strong>
2330 <code class="option">mpd_repeat</code>
2332 </span></dt><dd>Repeat status (On/Off)
2333 <p></p></dd><dt><span class="term">
2334 <span class="command"><strong>
2335 <code class="option">mpd_smart</code>
2337 <code class="option">(max length)</code>
2338 </span></dt><dd>Prints the song name in either the form "artist -
2339 title" or file name, depending on whats available
2340 <p></p></dd><dt><span class="term">
2341 <span class="command"><strong>
2342 <code class="option">mpd_status</code>
2344 </span></dt><dd>Playing, stopped, et cetera.
2345 <p></p></dd><dt><span class="term">
2346 <span class="command"><strong>
2347 <code class="option">mpd_title</code>
2349 <code class="option">(max length)</code>
2350 </span></dt><dd>Title of current MPD song
2351 <p></p></dd><dt><span class="term">
2352 <span class="command"><strong>
2353 <code class="option">mpd_track</code>
2355 </span></dt><dd>Prints the MPD track field
2356 <p></p></dd><dt><span class="term">
2357 <span class="command"><strong>
2358 <code class="option">mpd_vol</code>
2360 </span></dt><dd>MPD's volume
2361 <p></p></dd><dt><span class="term">
2362 <span class="command"><strong>
2363 <code class="option">nameserver</code>
2365 <code class="option">(index)</code>
2366 </span></dt><dd>Print a nameserver from /etc/resolv.conf. Index
2367 starts at and defaults to 0.
2368 <p></p></dd><dt><span class="term">
2369 <span class="command"><strong>
2370 <code class="option">new_mails</code>
2372 <code class="option">(mailbox)</code>
2373 <code class="option">(interval)</code>
2374 </span></dt><dd>Unread mail count in the specified mailbox or
2375 mail spool if not. Both mbox and maildir type mailboxes are
2377 <p></p></dd><dt><span class="term">
2378 <span class="command"><strong>
2379 <code class="option">nodename</code>
2381 </span></dt><dd>Hostname
2382 <p></p></dd><dt><span class="term">
2383 <span class="command"><strong>
2384 <code class="option">nvidia</code>
2386 <code class="option">threshold</code>
2387 <code class="option">temp</code>
2388 <code class="option">ambient</code>
2389 <code class="option">gpufreq</code>
2390 <code class="option">memfreq</code>
2391 <code class="option">imagequality</code>
2392 </span></dt><dd>Nvidia graficcard support for the XNVCtrl
2393 library. Each option can be shortened to the least
2394 significant part. Temperatures are printed as float, all
2395 other values as integer.
2396 <table border="0" summary="Simple list" class="simplelist"><tr><td>
2397 <span class="command"><strong>threshold</strong></span>
2398 <code class="option">The thresholdtemperature at
2399 which the gpu slows down</code>
2401 <span class="command"><strong>temp</strong></span>
2402 <code class="option">Gives the gpu current
2405 <span class="command"><strong>ambient</strong></span>
2406 <code class="option">Gives current air temperature near GPU
2409 <span class="command"><strong>gpufreq</strong></span>
2410 <code class="option">Gives the current gpu frequency</code>
2412 <span class="command"><strong>memfreq</strong></span>
2413 <code class="option">Gives the current mem frequency</code>
2415 <span class="command"><strong>imagequality</strong></span>
2416 <code class="option">Which imagequality should be chosen by
2417 OpenGL applications</code>
2418 </td></tr></table><p></p></dd><dt><span class="term">
2419 <span class="command"><strong>
2420 <code class="option">offset</code>
2422 <code class="option">(pixels)</code>
2423 </span></dt><dd>Move text over by N pixels. See also $voffset.
2424 <p></p></dd><dt><span class="term">
2425 <span class="command"><strong>
2426 <code class="option">outlinecolor</code>
2428 <code class="option">(color)</code>
2429 </span></dt><dd>Change outline color
2430 <p></p></dd><dt><span class="term">
2431 <span class="command"><strong>
2432 <code class="option">pb_battery</code>
2434 <code class="option">item</code>
2435 </span></dt><dd>If running on Apple powerbook/ibook, display
2436 information on battery status. The item parameter
2437 specifies, what information to display. Exactly one item
2438 must be specified. Valid items are:
2439 <table border="0" summary="Simple list" class="simplelist"><tr><td>
2440 <span class="command"><strong>status</strong></span>
2441 <code class="option">Display if battery is fully charged,
2442 charging, discharging or absent (running on
2445 <span class="command"><strong>percent</strong></span>
2446 <code class="option">Display charge of battery in percent, if
2447 charging or discharging. Nothing will be displayed,
2448 if battery is fully charged or absent.</code>
2450 <span class="command"><strong>time</strong></span>
2451 <code class="option">Display the time remaining until the
2452 battery will be fully charged or discharged at
2453 current rate. Nothing is displayed, if battery is
2454 absent or if it's present but fully charged and not
2456 </td></tr></table><p></p></dd><dt><span class="term">
2457 <span class="command"><strong>
2458 <code class="option">pid_chroot</code>
2460 <code class="option">pid</code>
2461 </span></dt><dd>Directory used as rootdirectory by the process
2462 (this will be "/" unless the process did a chroot syscall)
2463 <p></p></dd><dt><span class="term">
2464 <span class="command"><strong>
2465 <code class="option">pid_cmdline</code>
2467 <code class="option">pid</code>
2468 </span></dt><dd>Command line this process was invoked with
2469 <p></p></dd><dt><span class="term">
2470 <span class="command"><strong>
2471 <code class="option">pid_cwd</code>
2473 <code class="option">pid</code>
2474 </span></dt><dd>Current working directory of the process
2475 <p></p></dd><dt><span class="term">
2476 <span class="command"><strong>
2477 <code class="option">pid_environ</code>
2479 <code class="option">pid varname</code>
2480 </span></dt><dd>Contents of a environment-var of the process
2481 <p></p></dd><dt><span class="term">
2482 <span class="command"><strong>
2483 <code class="option">pid_environ_list</code>
2485 <code class="option">pid</code>
2486 </span></dt><dd>List of environment-vars that the process can see
2487 <p></p></dd><dt><span class="term">
2488 <span class="command"><strong>
2489 <code class="option">pid_exe</code>
2491 <code class="option">pid</code>
2492 </span></dt><dd>Path to executed command that started the process
2493 <p></p></dd><dt><span class="term">
2494 <span class="command"><strong>
2495 <code class="option">pid_nice</code>
2497 <code class="option">pid</code>
2498 </span></dt><dd>The nice value of the process
2499 <p></p></dd><dt><span class="term">
2500 <span class="command"><strong>
2501 <code class="option">pid_openfiles</code>
2503 <code class="option">pid</code>
2504 </span></dt><dd>List of files that the process has open
2505 <p></p></dd><dt><span class="term">
2506 <span class="command"><strong>
2507 <code class="option">pid_parent</code>
2509 <code class="option">pid</code>
2510 </span></dt><dd>The pid of the parent of the process
2511 <p></p></dd><dt><span class="term">
2512 <span class="command"><strong>
2513 <code class="option">pid_priority</code>
2515 <code class="option">pid</code>
2516 </span></dt><dd>The priority of the process (see 'priority' in "man 5 proc")
2517 <p></p></dd><dt><span class="term">
2518 <span class="command"><strong>
2519 <code class="option">pid_read</code>
2521 <code class="option">pid</code>
2522 </span></dt><dd>Total number of bytes read by the process
2523 <p></p></dd><dt><span class="term">
2524 <span class="command"><strong>
2525 <code class="option">pid_state</code>
2527 <code class="option">pid</code>
2528 </span></dt><dd>State of the process
2529 <p></p></dd><dt><span class="term">
2530 <span class="command"><strong>
2531 <code class="option">pid_state_short</code>
2533 <code class="option">pid</code>
2534 </span></dt><dd>One of the chars in "RSDZTW" representing the state
2535 of the process where R is running, S is sleeping in an
2536 interruptible wait, D is waiting in uninterruptible disk sleep,
2537 Z is zombie, T is traced or stopped (on a signal), and W is paging
2538 <p></p></dd><dt><span class="term">
2539 <span class="command"><strong>
2540 <code class="option">pid_stderr</code>
2542 <code class="option">pid</code>
2543 </span></dt><dd>Filedescriptor binded to the STDERR of the process
2544 <p></p></dd><dt><span class="term">
2545 <span class="command"><strong>
2546 <code class="option">pid_stdin</code>
2548 <code class="option">pid</code>
2549 </span></dt><dd>Filedescriptor binded to the STDIN of the process
2550 <p></p></dd><dt><span class="term">
2551 <span class="command"><strong>
2552 <code class="option">pid_stdout</code>
2554 <code class="option">pid</code>
2555 </span></dt><dd>Filedescriptor binded to the STDOUT of the process
2556 <p></p></dd><dt><span class="term">
2557 <span class="command"><strong>
2558 <code class="option">pid_threads</code>
2560 <code class="option">pid</code>
2561 </span></dt><dd>Number of threads in process containing this thread
2562 <p></p></dd><dt><span class="term">
2563 <span class="command"><strong>
2564 <code class="option">pid_thread_list</code>
2566 <code class="option">pid</code>
2567 </span></dt><dd>List with pid's from threads from this process
2568 <p></p></dd><dt><span class="term">
2569 <span class="command"><strong>
2570 <code class="option">pid_time_kernelmode</code>
2572 <code class="option">pid</code>
2573 </span></dt><dd>Amount of time that the process has been scheduled in kernel mode in seconds
2574 <p></p></dd><dt><span class="term">
2575 <span class="command"><strong>
2576 <code class="option">pid_time_usermode</code>
2578 <code class="option">pid</code>
2579 </span></dt><dd>Amount of time that the process has been scheduled in user mode in seconds
2580 <p></p></dd><dt><span class="term">
2581 <span class="command"><strong>
2582 <code class="option">pid_time</code>
2584 <code class="option">pid</code>
2585 </span></dt><dd>Sum of $pid_time_kernelmode and $pid_time_usermode
2586 <p></p></dd><dt><span class="term">
2587 <span class="command"><strong>
2588 <code class="option">pid_uid</code>
2590 <code class="option">pid</code>
2591 </span></dt><dd>The real uid of the process
2592 <p></p></dd><dt><span class="term">
2593 <span class="command"><strong>
2594 <code class="option">pid_euid</code>
2596 <code class="option">pid</code>
2597 </span></dt><dd>The effective uid of the process
2598 <p></p></dd><dt><span class="term">
2599 <span class="command"><strong>
2600 <code class="option">pid_suid</code>
2602 <code class="option">pid</code>
2603 </span></dt><dd>The saved set uid of the process
2604 <p></p></dd><dt><span class="term">
2605 <span class="command"><strong>
2606 <code class="option">pid_fsuid</code>
2608 <code class="option">pid</code>
2609 </span></dt><dd>The file system uid of the process
2610 <p></p></dd><dt><span class="term">
2611 <span class="command"><strong>
2612 <code class="option">pid_gid</code>
2614 <code class="option">pid</code>
2615 </span></dt><dd>The real gid of the process
2616 <p></p></dd><dt><span class="term">
2617 <span class="command"><strong>
2618 <code class="option">pid_egid</code>
2620 <code class="option">pid</code>
2621 </span></dt><dd>The effective gid of the process
2622 <p></p></dd><dt><span class="term">
2623 <span class="command"><strong>
2624 <code class="option">pid_sgid</code>
2626 <code class="option">pid</code>
2627 </span></dt><dd>The saved set gid of the process
2628 <p></p></dd><dt><span class="term">
2629 <span class="command"><strong>
2630 <code class="option">pid_fsgid</code>
2632 <code class="option">pid</code>
2633 </span></dt><dd>The file system gid of the process
2634 <p></p></dd><dt><span class="term">
2635 <span class="command"><strong>
2636 <code class="option">pid_vmpeak</code>
2638 <code class="option">pid</code>
2639 </span></dt><dd>Peak virtual memory size of the process
2640 <p></p></dd><dt><span class="term">
2641 <span class="command"><strong>
2642 <code class="option">pid_vmsize</code>
2644 <code class="option">pid</code>
2645 </span></dt><dd>Virtual memory size of the process
2646 <p></p></dd><dt><span class="term">
2647 <span class="command"><strong>
2648 <code class="option">pid_vmlck</code>
2650 <code class="option">pid</code>
2651 </span></dt><dd>Locked memory size of the process
2652 <p></p></dd><dt><span class="term">
2653 <span class="command"><strong>
2654 <code class="option">pid_vmhwm</code>
2656 <code class="option">pid</code>
2657 </span></dt><dd>Peak resident set size ("high water mark") of the process
2658 <p></p></dd><dt><span class="term">
2659 <span class="command"><strong>
2660 <code class="option">pid_vmrss</code>
2662 <code class="option">pid</code>
2663 </span></dt><dd>Resident set size of the process
2664 <p></p></dd><dt><span class="term">
2665 <span class="command"><strong>
2666 <code class="option">pid_vmdata</code>
2668 <code class="option">pid</code>
2669 </span></dt><dd>Data segment size of the process
2670 <p></p></dd><dt><span class="term">
2671 <span class="command"><strong>
2672 <code class="option">pid_vmstk</code>
2674 <code class="option">pid</code>
2675 </span></dt><dd>Stack segment size of the process
2676 <p></p></dd><dt><span class="term">
2677 <span class="command"><strong>
2678 <code class="option">pid_vmexe</code>
2680 <code class="option">pid</code>
2681 </span></dt><dd>Text segment size of the process
2682 <p></p></dd><dt><span class="term">
2683 <span class="command"><strong>
2684 <code class="option">pid_vmlib</code>
2686 <code class="option">pid</code>
2687 </span></dt><dd>Shared library code size of the process
2688 <p></p></dd><dt><span class="term">
2689 <span class="command"><strong>
2690 <code class="option">pid_vmpte</code>
2692 <code class="option">pid</code>
2693 </span></dt><dd>Page table entries size of the process
2694 <p></p></dd><dt><span class="term">
2695 <span class="command"><strong>
2696 <code class="option">pid_write</code>
2698 <code class="option">pid</code>
2699 </span></dt><dd>Total number of bytes written by the process
2700 <p></p></dd><dt><span class="term">
2701 <span class="command"><strong>
2702 <code class="option">platform</code>
2704 <code class="option">(dev) type n (factor offset)</code>
2705 </span></dt><dd>Platform sensor from sysfs (Linux 2.6). Parameter
2706 dev may be omitted if you have only one platform device.
2707 Platform type is either 'in' or 'vol' meaning voltage;
2708 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2709 is number of the sensor. See /sys/bus/platform/devices/ on
2710 your local computer. The optional arguments 'factor' and
2711 'offset' allow precalculation of the raw input, which is
2712 being modified as follows: 'input = input * factor +
2713 offset'. Note that they have to be given as decimal values
2714 (i.e. contain at least one decimal place).
2715 <p></p></dd><dt><span class="term">
2716 <span class="command"><strong>
2717 <code class="option">pop3_unseen</code>
2719 <code class="option">(args)</code>
2720 </span></dt><dd>Displays the number of unseen messages in your
2721 global POP3 inbox by default. You can define individual
2722 POP3 inboxes separately by passing arguments to this
2723 object. Arguments are: "host user pass [-i interval (in
2724 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2725 port is 110, default interval is 5 minutes, and default
2726 number of retries before giving up is 5. If the password is
2727 supplied as '*', you will be prompted to enter the password
2729 <p></p></dd><dt><span class="term">
2730 <span class="command"><strong>
2731 <code class="option">pop3_used</code>
2733 <code class="option">(args)</code>
2734 </span></dt><dd>Displays the amount of space (in MiB, 2^20) used
2735 in your global POP3 inbox by default. You can define
2736 individual POP3 inboxes separately by passing arguments to
2737 this object. Arguments are: "host user pass [-i interval
2738 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2739 port is 110, default interval is 5 minutes, and default
2740 number of retries before giving up is 5. If the password is
2741 supplied as '*', you will be prompted to enter the password
2743 <p></p></dd><dt><span class="term">
2744 <span class="command"><strong>
2745 <code class="option">pre_exec</code>
2747 <code class="option">shell command</code>
2748 </span></dt><dd>Executes a shell command one time before conky
2749 displays anything and puts output as text.
2750 <p></p></dd><dt><span class="term">
2751 <span class="command"><strong>
2752 <code class="option">processes</code>
2754 </span></dt><dd>Total processes (sleeping and running)
2755 <p></p></dd><dt><span class="term">
2756 <span class="command"><strong>
2757 <code class="option">read_tcp</code>
2759 <code class="option">(host) port</code>
2760 </span></dt><dd>Connects to a tcp port on a host (default is
2761 localhost), reads every char available at the moment and
2763 <p></p></dd><dt><span class="term">
2764 <span class="command"><strong>
2765 <code class="option">replied_mails</code>
2767 <code class="option">(maildir)</code>
2768 <code class="option">(interval)</code>
2769 </span></dt><dd>Number of mails marked as replied in the
2770 specified mailbox or mail spool if not. Only maildir type
2771 mailboxes are supported, mbox type will return -1.
2772 <p></p></dd><dt><span class="term">
2773 <span class="command"><strong>
2774 <code class="option">rss</code>
2776 <code class="option">uri interval_in_minutes action (num_par
2777 (spaces_in_front))</code>
2778 </span></dt><dd><p>Download and parse RSS feeds. The interval may be
2779 a floating point value greater than 0, otherwise
2780 defaults to 15 minutes. Action may be one of the
2781 following: feed_title, item_title (with num par),
2782 item_desc (with num par) and item_titles (when using
2783 this action and spaces_in_front is given conky places
2784 that many spaces in front of each item). This object is
2785 threaded, and once a thread is created it can't be
2786 explicitly destroyed. One thread will run for each URI
2787 specified. You can use any protocol that Curl
2788 supports.</p></dd><dt><span class="term">
2789 <span class="command"><strong>
2790 <code class="option">running_processes</code>
2792 </span></dt><dd>Running processes (not sleeping), requires Linux
2794 <p></p></dd><dt><span class="term">
2795 <span class="command"><strong>
2796 <code class="option">running_threads</code>
2798 </span></dt><dd>Number of running (runnable) threads. Linux only.
2799 <p></p></dd><dt><span class="term">
2800 <span class="command"><strong>
2801 <code class="option">scroll</code>
2803 <code class="option">length (step) text</code>
2804 </span></dt><dd>Scroll 'text' by 'step' characters showing
2805 'length' number of characters at the same time. The text
2806 may also contain variables. 'step' is optional and defaults
2807 to 1 if not set. If a var creates output on multiple lines
2808 then the lines are placed behind each other separated with
2809 a '|'-sign. If you change the textcolor inside $scroll it
2810 will automatically have it's old value back at the end of
2811 $scroll. The end and the start of text will be separated by
2812 'length' number of spaces.
2813 <p></p></dd><dt><span class="term">
2814 <span class="command"><strong>
2815 <code class="option">seen_mails</code>
2817 <code class="option">(maildir)</code>
2818 <code class="option">(interval)</code>
2819 </span></dt><dd>Number of mails marked as seen in the specified
2820 mailbox or mail spool if not. Only maildir type mailboxes
2821 are supported, mbox type will return -1.
2822 <p></p></dd><dt><span class="term">
2823 <span class="command"><strong>
2824 <code class="option">shadecolor</code>
2826 <code class="option">(color)</code>
2827 </span></dt><dd>Change shading color
2828 <p></p></dd><dt><span class="term">
2829 <span class="command"><strong>
2830 <code class="option">smapi</code>
2832 <code class="option">(ARGS)</code>
2833 </span></dt><dd>when using smapi, display contents of the
2834 /sys/devices/platform/smapi directory. ARGS are either
2835 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2836 corresponding files' content. This is a very raw method of
2837 accessing the smapi values. When available, better use one
2838 of the smapi_* variables instead.
2839 <p></p></dd><dt><span class="term">
2840 <span class="command"><strong>
2841 <code class="option">smapi_bat_bar</code>
2843 <code class="option">(INDEX),(height),(width)</code>
2844 </span></dt><dd>when using smapi, display the remaining capacity
2845 of the battery with index INDEX as a bar.
2846 <p></p></dd><dt><span class="term">
2847 <span class="command"><strong>
2848 <code class="option">smapi_bat_perc</code>
2850 <code class="option">(INDEX)</code>
2851 </span></dt><dd>when using smapi, display the remaining capacity
2852 in percent of the battery with index INDEX. This is a
2853 separate variable because it supports the 'use_spacer'
2854 configuration option.
2855 <p></p></dd><dt><span class="term">
2856 <span class="command"><strong>
2857 <code class="option">smapi_bat_power</code>
2859 <code class="option">INDEX</code>
2860 </span></dt><dd>when using smapi, display the current power of
2861 the battery with index INDEX in watt. This is a separate
2862 variable because the original read out value is being
2863 converted from mW. The sign of the output reflects charging
2864 (positive) or discharging (negative) state.
2865 <p></p></dd><dt><span class="term">
2866 <span class="command"><strong>
2867 <code class="option">smapi_bat_temp</code>
2869 <code class="option">INDEX</code>
2870 </span></dt><dd>when using smapi, display the current temperature
2871 of the battery with index INDEX in degree Celsius. This is
2872 a separate variable because the original read out value is
2873 being converted from milli degree Celsius.
2874 <p></p></dd><dt><span class="term">
2875 <span class="command"><strong>
2876 <code class="option">sony_fanspeed</code>
2878 </span></dt><dd>Displays the Sony VAIO fanspeed information if
2879 sony-laptop kernel support is enabled. Linux only.
2880 <p></p></dd><dt><span class="term">
2881 <span class="command"><strong>
2882 <code class="option">stippled_hr</code>
2884 <code class="option">(space)</code>
2885 </span></dt><dd>Stippled (dashed) horizontal line
2886 <p></p></dd><dt><span class="term">
2887 <span class="command"><strong>
2888 <code class="option">swap</code>
2890 </span></dt><dd>Amount of swap in use
2891 <p></p></dd><dt><span class="term">
2892 <span class="command"><strong>
2893 <code class="option">swapbar</code>
2895 <code class="option">(height),(width)</code>
2896 </span></dt><dd>Bar that shows amount of swap in use
2897 <p></p></dd><dt><span class="term">
2898 <span class="command"><strong>
2899 <code class="option">swapfree</code>
2901 </span></dt><dd>Amount of free swap
2902 <p></p></dd><dt><span class="term">
2903 <span class="command"><strong>
2904 <code class="option">swapmax</code>
2906 </span></dt><dd>Total amount of swap
2907 <p></p></dd><dt><span class="term">
2908 <span class="command"><strong>
2909 <code class="option">swapperc</code>
2911 </span></dt><dd>Percentage of swap in use
2912 <p></p></dd><dt><span class="term">
2913 <span class="command"><strong>
2914 <code class="option">sysname</code>
2916 </span></dt><dd>System name, Linux for example
2917 <p></p></dd><dt><span class="term">
2918 <span class="command"><strong>
2919 <code class="option">tab</code>
2921 <code class="option">(width, (start))</code>
2922 </span></dt><dd>Puts a tab of the specified width, starting from
2923 column 'start'. The unit is pixels for both arguments.
2924 <p></p></dd><dt><span class="term">
2925 <span class="command"><strong>
2926 <code class="option">tail</code>
2928 <code class="option">logfile lines (next_check)</code>
2929 </span></dt><dd>Displays last N lines of supplied text file. The
2930 file is checked every 'next_check' update. If next_check is
2931 not supplied, Conky defaults to 2. Max of 30 lines can be
2932 displayed, or until the text buffer is filled.
2933 <p></p></dd><dt><span class="term">
2934 <span class="command"><strong>
2935 <code class="option">tcp_portmon</code>
2937 <code class="option">port_begin port_end item (index)</code>
2938 </span></dt><dd><p>TCP port (both IPv6 and IPv4) monitor for
2939 specified local ports. Port numbers must be in
2940 the range 1 to 65535. Valid items are:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>
2941 <span class="command"><strong>count</strong></span>
2942 <code class="option">Total number of connections in the
2945 <span class="command"><strong>rip</strong></span>
2946 <code class="option">Remote ip address</code>
2948 <span class="command"><strong>rhost</strong></span>
2949 <code class="option">Remote host name</code>
2951 <span class="command"><strong>rport</strong></span>
2952 <code class="option">Remote port number</code>
2954 <span class="command"><strong>rservice</strong></span>
2955 <code class="option">Remote service name from
2956 /etc/services</code>
2958 <span class="command"><strong>lip</strong></span>
2959 <code class="option">Local ip address</code>
2961 <span class="command"><strong>lhost</strong></span>
2962 <code class="option">Local host name</code>
2964 <span class="command"><strong>lport</strong></span>
2965 <code class="option">Local port number</code>
2967 <span class="command"><strong>lservice</strong></span>
2968 <code class="option">Local service name from
2969 /etc/services</code>
2970 </td></tr></table><p>The connection index provides you with access to
2971 each connection in the port monitor. The monitor will
2972 return information for index values from 0 to n-1
2973 connections. Values higher than n-1 are simply ignored.
2974 For the "count" item, the connection index must be
2975 omitted. It is required for all other items.</p><p>Examples:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>
2976 <span class="command"><strong>${tcp_portmon 6881 6999
2977 count}</strong></span>
2978 <code class="option">Displays the number of connections in
2979 the bittorrent port range</code>
2981 <span class="command"><strong>${tcp_portmon 22 22 rip 0}</strong></span>
2982 <code class="option">Displays the remote host ip of the
2983 first sshd connection</code>
2985 <span class="command"><strong>${tcp_portmon 22 22 rip 9}</strong></span>
2986 <code class="option">Displays the remote host ip of the
2987 tenth sshd connection</code>
2989 <span class="command"><strong>${tcp_portmon 1 1024 rhost
2991 <code class="option">Displays the remote host name of the
2992 first connection on a privileged port</code>
2994 <span class="command"><strong>${tcp_portmon 1 1024 rport
2996 <code class="option">Displays the remote host port of the
2997 fifth connection on a privileged port</code>
2999 <span class="command"><strong>${tcp_portmon 1 65535 lservice
3001 <code class="option">Displays the local service name of the
3002 fifteenth connection in the range of all
3004 </td></tr></table><p>Note that port monitor variables which share the
3005 same port range actually refer to the same monitor, so
3006 many references to a single port range for different
3007 items and different indexes all use the same monitor
3008 internally. In other words, the program avoids creating
3009 redundant monitors.</p></dd><dt><span class="term">
3010 <span class="command"><strong>
3011 <code class="option">templateN</code>
3013 <code class="option">(arg1)</code>
3014 <code class="option">(arg2)</code>
3015 <code class="option">(arg3 ...)</code>
3016 </span></dt><dd><p>Evaluate the content of the templateN
3017 configuration variable (where N is a value between 0
3018 and 9, inclusively), applying substitutions as
3019 described in the documentation of the corresponding
3020 configuration variable. The number of arguments is
3021 optional, but must match the highest referred index in
3022 the template. You can use the same special sequences in
3023 each argument as the ones valid for a template
3024 definition, e.g. to allow an argument to contain a
3025 whitespace. Also simple nesting of templates is
3026 possible this way.</p><p>Here are some examples of template
3027 definitions:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>template0 $\1\2</td></tr><tr><td>template1 \1: ${fs_used \2} / ${fs_size
3028 \2}</td></tr><tr><td>template2 \1 \2</td></tr></table><p>The following list shows sample usage of the
3029 templates defined above, with the equivalent syntax
3030 when not using any template at all:</p><div class="table"><a name="id525157"></a><p class="title"><b>Table 1. </b></p><div class="table-contents"><table border="1"><colgroup><col><col></colgroup><thead><tr><th>using template</th><th>same without template</th></tr></thead><tbody><tr><td>${template0 node name}</td><td>$nodename</td></tr><tr><td>${template1 root /}</td><td>root: ${fs_free /} / ${fs_size
3031 /}</td></tr><tr><td>
3033 ${template2\ disk\ root}
3037 ${fs_free /} / ${fs_size
3039 </td></tr></tbody></table></div></div><br class="table-break"></dd><dt><span class="term">
3040 <span class="command"><strong>
3041 <code class="option">texeci</code>
3043 <code class="option">interval command</code>
3044 </span></dt><dd>Runs a command at an interval inside a thread and
3045 displays the output. Same as $execi, except the command is
3046 run inside a thread. Use this if you have a slow script to
3047 keep Conky updating. You should make the interval slightly
3048 longer then the time it takes your script to execute. For
3049 example, if you have a script that take 5 seconds to
3050 execute, you should make the interval at least 6 seconds.
3051 See also $execi. This object will clean up the thread when
3052 it is destroyed, so it can safely be used in a nested
3053 fashion, though it may not produce the desired behaviour if
3055 <p></p></dd><dt><span class="term">
3056 <span class="command"><strong>
3057 <code class="option">threads</code>
3059 </span></dt><dd>Total threads
3060 <p></p></dd><dt><span class="term">
3061 <span class="command"><strong>
3062 <code class="option">time</code>
3064 <code class="option">(format)</code>
3065 </span></dt><dd>Local time, see man strftime to get more
3066 information about format
3067 <p></p></dd><dt><span class="term">
3068 <span class="command"><strong>
3069 <code class="option">to_bytes</code>
3071 <code class="option">size</code>
3072 </span></dt><dd>If 'size' is a number followed by a size-unit
3073 (kilobyte,mb,GiB,...) then it converts the size to bytes
3074 and shows it without unit, otherwise it just shows 'size'.
3075 <p></p></dd><dt><span class="term">
3076 <span class="command"><strong>
3077 <code class="option">top</code>
3079 <code class="option">type num</code>
3080 </span></dt><dd>This takes arguments in the form:top (name)
3081 (number) Basically, processes are ranked from highest to
3082 lowest in terms of cpu usage, which is what (num)
3083 represents. The types are: "name", "pid", "cpu", "mem",
3084 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3085 "io_write". There can be a max of 10 processes listed.
3086 <p></p></dd><dt><span class="term">
3087 <span class="command"><strong>
3088 <code class="option">top_io</code>
3090 <code class="option">type num</code>
3091 </span></dt><dd>Same as top, except sorted by the amount of I/O
3092 the process has done during the update interval
3093 <p></p></dd><dt><span class="term">
3094 <span class="command"><strong>
3095 <code class="option">top_mem</code>
3097 <code class="option">type num</code>
3098 </span></dt><dd>Same as top, except sorted by mem usage instead
3100 <p></p></dd><dt><span class="term">
3101 <span class="command"><strong>
3102 <code class="option">top_time</code>
3104 <code class="option">type num</code>
3105 </span></dt><dd>Same as top, except sorted by total CPU time
3106 instead of current CPU usage
3107 <p></p></dd><dt><span class="term">
3108 <span class="command"><strong>
3109 <code class="option">totaldown</code>
3111 <code class="option">(net)</code>
3112 </span></dt><dd>Total download, overflows at 4 GB on Linux with
3113 32-bit arch and there doesn't seem to be a way to know how
3114 many times it has already done that before conky has
3116 <p></p></dd><dt><span class="term">
3117 <span class="command"><strong>
3118 <code class="option">totalup</code>
3120 <code class="option">(net)</code>
3121 </span></dt><dd>Total upload, this one too, may overflow
3122 <p></p></dd><dt><span class="term">
3123 <span class="command"><strong>
3124 <code class="option">trashed_mails</code>
3126 <code class="option">(maildir)</code>
3127 <code class="option">(interval)</code>
3128 </span></dt><dd>Number of mails marked as trashed in the
3129 specified mailbox or mail spool if not. Only maildir type
3130 mailboxes are supported, mbox type will return -1.
3131 <p></p></dd><dt><span class="term">
3132 <span class="command"><strong>
3133 <code class="option">tztime</code>
3135 <code class="option">(timezone (format))</code>
3136 </span></dt><dd>Local time for specified timezone, see man
3137 strftime to get more information about format. The timezone
3138 argument is specified in similar fashion as TZ environment
3139 variable. For hints, look in /usr/share/zoneinfo. e.g.
3140 US/Pacific, Europe/Zurich, etc.
3141 <p></p></dd><dt><span class="term">
3142 <span class="command"><strong>
3143 <code class="option">gid_name</code>
3145 <code class="option">gid</code>
3146 </span></dt><dd>Name of group with this gid
3147 <p></p></dd><dt><span class="term">
3148 <span class="command"><strong>
3149 <code class="option">uid_name</code>
3151 <code class="option">uid</code>
3152 </span></dt><dd>Username of user with this uid
3153 <p></p></dd><dt><span class="term">
3154 <span class="command"><strong>
3155 <code class="option">unflagged_mails</code>
3157 <code class="option">(maildir)</code>
3158 <code class="option">(interval)</code>
3159 </span></dt><dd>Number of mails not marked as flagged in the
3160 specified mailbox or mail spool if not. Only maildir type
3161 mailboxes are supported, mbox type will return -1.
3162 <p></p></dd><dt><span class="term">
3163 <span class="command"><strong>
3164 <code class="option">unforwarded_mails</code>
3166 <code class="option">(maildir)</code>
3167 <code class="option">(interval)</code>
3168 </span></dt><dd>Number of mails not marked as forwarded in the
3169 specified mailbox or mail spool if not. Only maildir type
3170 mailboxes are supported, mbox type will return -1.
3171 <p></p></dd><dt><span class="term">
3172 <span class="command"><strong>
3173 <code class="option">unreplied_mails</code>
3175 <code class="option">(maildir)</code>
3176 <code class="option">(interval)</code>
3177 </span></dt><dd>Number of mails not marked as replied in the
3178 specified mailbox or mail spool if not. Only maildir type
3179 mailboxes are supported, mbox type will return -1.
3180 <p></p></dd><dt><span class="term">
3181 <span class="command"><strong>
3182 <code class="option">unseen_mails</code>
3184 <code class="option">(maildir)</code>
3185 <code class="option">(interval)</code>
3186 </span></dt><dd>Number of new or unseen mails in the specified
3187 mailbox or mail spool if not. Only maildir type mailboxes
3188 are supported, mbox type will return -1.
3189 <p></p></dd><dt><span class="term">
3190 <span class="command"><strong>
3191 <code class="option">updates</code>
3193 <code class="option">Number of updates</code>
3194 </span></dt><dd>for debugging
3195 <p></p></dd><dt><span class="term">
3196 <span class="command"><strong>
3197 <code class="option">upspeed</code>
3199 <code class="option">(net)</code>
3200 </span></dt><dd>Upload speed in suitable IEC units
3201 <p></p></dd><dt><span class="term">
3202 <span class="command"><strong>
3203 <code class="option">upspeedf</code>
3205 <code class="option">(net)</code>
3206 </span></dt><dd>Upload speed in KiB with one decimal
3207 <p></p></dd><dt><span class="term">
3208 <span class="command"><strong>
3209 <code class="option">upspeedgraph</code>
3211 <code class="option">(netdev) (height),(width) (gradient colour 1)
3212 (gradient colour 2) (scale) (-t) (-l)</code>
3213 </span></dt><dd>Upload speed graph, colours defined in hex, minus
3214 the #. If scale is non-zero, it becomes the scale for the
3215 graph. Uses a logarithmic scale (to see small numbers) when
3216 you use the -l switch. Takes the switch '-t' to use a
3217 temperature gradient, which makes the gradient values
3218 change depending on the amplitude of a particular graph
3219 value (try it and see).
3220 <p></p></dd><dt><span class="term">
3221 <span class="command"><strong>
3222 <code class="option">uptime</code>
3224 </span></dt><dd>Uptime
3225 <p></p></dd><dt><span class="term">
3226 <span class="command"><strong>
3227 <code class="option">uptime_short</code>
3229 </span></dt><dd>Uptime in a shorter format
3230 <p></p></dd><dt><span class="term">
3231 <span class="command"><strong>
3232 <code class="option">user_names</code>
3234 </span></dt><dd>Lists the names of the users logged in
3235 <p></p></dd><dt><span class="term">
3236 <span class="command"><strong>
3237 <code class="option">user_number</code>
3239 </span></dt><dd>Number of users logged in
3240 <p></p></dd><dt><span class="term">
3241 <span class="command"><strong>
3242 <code class="option">user_terms</code>
3244 </span></dt><dd>Lists the consoles in use
3245 <p></p></dd><dt><span class="term">
3246 <span class="command"><strong>
3247 <code class="option">user_times</code>
3249 </span></dt><dd>Lists how long users have been logged in for
3250 <p></p></dd><dt><span class="term">
3251 <span class="command"><strong>
3252 <code class="option">user_time</code>
3254 <code class="option">console</code>
3255 </span></dt><dd>Lists how long the user for the given console has been
3257 <p></p></dd><dt><span class="term">
3258 <span class="command"><strong>
3259 <code class="option">utime</code>
3261 <code class="option">(format)</code>
3262 </span></dt><dd>Display time in UTC (universal coordinate time).
3263 <p></p></dd><dt><span class="term">
3264 <span class="command"><strong>
3265 <code class="option">voffset</code>
3267 <code class="option">(pixels)</code>
3268 </span></dt><dd>Change vertical offset by N pixels. Negative
3269 values will cause text to overlap. See also $offset.
3270 <p></p></dd><dt><span class="term">
3271 <span class="command"><strong>
3272 <code class="option">voltage_mv</code>
3274 <code class="option">(n)</code>
3275 </span></dt><dd>Returns CPU #n's voltage in mV. CPUs are counted
3276 from 1. If omitted, the parameter defaults to 1.
3277 <p></p></dd><dt><span class="term">
3278 <span class="command"><strong>
3279 <code class="option">voltage_v</code>
3281 <code class="option">(n)</code>
3282 </span></dt><dd>Returns CPU #n's voltage in V. CPUs are counted
3283 from 1. If omitted, the parameter defaults to 1.
3284 <p></p></dd><dt><span class="term">
3285 <span class="command"><strong>
3286 <code class="option">weather</code>
3288 <code class="option">URI locID data_type
3289 (interval_in_minutes)</code>
3290 </span></dt><dd><p>Download, parse and display METAR data.</p><p>For the 'URI', there are two
3291 possibilities:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>
3292 http://weather.noaa.gov/pub/data/observations/metar/stations/</td></tr><tr><td>
3293 http://xoap.weather.com/weather/local/</td></tr></table><p>The first one is free to use but the second
3294 requires you to register and obtain your partner ID and
3295 license key. These two must be written, separated by a
3296 space, into a file called .xoaprc which needs to be
3297 placed into your home directory.</p><p>'locID' must be a valid location identifier for
3298 the required uri. For the NOAA site this must be a
3299 valid ICAO (see for instance
3300 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3301 weather.com site this must be a valid location ID (see
3303 http://aspnetresources.com/tools/locid.aspx).</p><p>'data_type' must be one of the following:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>
3304 <span class="command"><strong>last_update</strong></span>
3305 <p>The date and time stamp of the data.
3306 The result depends on the URI used. For the
3307 NOAA site it is date (yyyy/mm/dd) and UTC time.
3308 For the weather.com one it is date
3309 ([m]m/[d]d/yy) and Local Time of the
3312 <span class="command"><strong>temperature</strong></span>
3313 <p>Air temperature (you can use the
3314 'temperature_unit' config setting to change
3317 <span class="command"><strong>cloud_cover</strong></span>
3318 <p>The highest cloud cover status</p>
3320 <span class="command"><strong>pressure</strong></span>
3321 <p>Air pressure in millibar</p>
3323 <span class="command"><strong>wind_speed</strong></span>
3324 <p>Wind speed in km/h</p>
3326 <span class="command"><strong>wind_dir</strong></span>
3327 <p>Wind direction</p>
3329 <span class="command"><strong>wind_dir_DEG</strong></span>
3330 <p>Compass wind direction</p>
3332 <span class="command"><strong>humidity</strong></span>
3333 <p>Relative humidity in %</p>
3335 <span class="command"><strong>weather</strong></span>
3336 <p>Any relevant weather event (rain, snow,
3337 etc.). This is not used if you are querying the
3338 weather.com site since this data is aggregated
3339 into the cloud_cover one</p>
3341 <span class="command"><strong>icon</strong></span>
3342 <p>Weather icon (only for
3343 www.weather.com). Can be used together with the
3344 icon kit provided upon registering to their
3346 </td></tr></table><p>'delay_in_minutes' (optional, default 30) cannot
3347 be less than 30 minutes.</p><p>This object is threaded, and once a thread is
3348 created it can't be explicitly destroyed. One thread
3349 will run for each URI specified.</p><p>Note that these variables are still EXPERIMENTAL
3350 and can be subject to many future changes.</p></dd><dt><span class="term">
3351 <span class="command"><strong>
3352 <code class="option">weather_forecast</code>
3354 <code class="option">URI locID day data_type
3355 (interval_in_minutes)</code>
3356 </span></dt><dd><p>Download, parse and display weather forecast data
3357 for a given day (daytime only).</p><p>For the 'URI', for the time being only
3358 http://xoap.weather.com/weather/local/ is
3359 supported. See 'weather' above for details of usage</p><p>'locID', see 'weather' above.</p><p>'day' is a number from 0 (today) to 4 (3 days
3360 after tomorrow).</p><p>'data_type' must be one of the following:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>
3361 <span class="command"><strong>day</strong></span>
3362 <code class="option">Day of the week</code>
3364 <span class="command"><strong>date</strong></span>
3365 <code class="option">Date, in the form MMM DD (ie. Jul 14)</code>
3367 <span class="command"><strong>low</strong></span>
3368 <code class="option">Minimun temperature (you can use the
3369 'temperature_unit' config setting to change
3372 <span class="command"><strong>hi</strong></span>
3373 <code class="option">Maximum temperature (you can use the
3374 'temperature_unit' config setting to change
3377 <span class="command"><strong>icon</strong></span>
3378 <code class="option">Weather icon. Can be used together with the
3379 icon kit provided upon registering to the weather.com
3382 <span class="command"><strong>forecast</strong></span>
3383 <code class="option">Weather forecast (sunny, rainy, etc.)</code>
3385 <span class="command"><strong>wind_speed</strong></span>
3386 <code class="option">Wind speed in km/h</code>
3388 <span class="command"><strong>wind_dir</strong></span>
3389 <code class="option">Wind direction</code>
3391 <span class="command"><strong>wind_dir_DEG</strong></span>
3392 <code class="option">Compass wind direction</code>
3394 <span class="command"><strong>humidity</strong></span>
3395 <code class="option">Relative humidity in %</code>
3397 <span class="command"><strong>precipitation</strong></span>
3398 <code class="option">Probability of having a
3399 precipitation (in %)</code>
3400 </td></tr></table><p>'delay_in_minutes' (optional, default 210) cannot
3401 be lower than 210 min.</p><p>This object is threaded, and once a thread is
3402 created it can't be explicitly destroyed. One thread
3403 will run for each URI specified. You can use any
3404 protocol that Curl supports.</p><p>Note that these variables are still EXPERIMENTAL
3405 and can be subject to many future changes.</p></dd><dt><span class="term">
3406 <span class="command"><strong>
3407 <code class="option">wireless_ap</code>
3409 <code class="option">(net)</code>
3410 </span></dt><dd>Wireless access point MAC address (Linux only)
3411 <p></p></dd><dt><span class="term">
3412 <span class="command"><strong>
3413 <code class="option">wireless_bitrate</code>
3415 <code class="option">(net)</code>
3416 </span></dt><dd>Wireless bitrate (ie 11 Mb/s) (Linux only)
3417 <p></p></dd><dt><span class="term">
3418 <span class="command"><strong>
3419 <code class="option">wireless_essid</code>
3421 <code class="option">(net)</code>
3422 </span></dt><dd>Wireless access point ESSID (Linux only)
3423 <p></p></dd><dt><span class="term">
3424 <span class="command"><strong>
3425 <code class="option">wireless_link_bar</code>
3427 <code class="option">(height),(width) (net)</code>
3428 </span></dt><dd>Wireless link quality bar (Linux only)
3429 <p></p></dd><dt><span class="term">
3430 <span class="command"><strong>
3431 <code class="option">wireless_link_qual</code>
3433 <code class="option">(net)</code>
3434 </span></dt><dd>Wireless link quality (Linux only)
3435 <p></p></dd><dt><span class="term">
3436 <span class="command"><strong>
3437 <code class="option">wireless_link_qual_max</code>
3439 <code class="option">(net)</code>
3440 </span></dt><dd>Wireless link quality maximum value (Linux only)
3441 <p></p></dd><dt><span class="term">
3442 <span class="command"><strong>
3443 <code class="option">wireless_link_qual_perc</code>
3445 <code class="option">(net)</code>
3446 </span></dt><dd>Wireless link quality in percents (Linux only)
3447 <p></p></dd><dt><span class="term">
3448 <span class="command"><strong>
3449 <code class="option">wireless_mode</code>
3451 <code class="option">(net)</code>
3452 </span></dt><dd>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3454 <p></p></dd><dt><span class="term">
3455 <span class="command"><strong>
3456 <code class="option">words</code>
3458 <code class="option">textfile</code>
3459 </span></dt><dd>Displays the number of words in the given file
3460 <p></p></dd><dt><span class="term">
3461 <span class="command"><strong>
3462 <code class="option">xmms2_album</code>
3464 </span></dt><dd>Album in current XMMS2 song
3465 <p></p></dd><dt><span class="term">
3466 <span class="command"><strong>
3467 <code class="option">xmms2_artist</code>
3469 </span></dt><dd>Artist in current XMMS2 song
3470 <p></p></dd><dt><span class="term">
3471 <span class="command"><strong>
3472 <code class="option">xmms2_bar</code>
3474 <code class="option">(height),(width)</code>
3475 </span></dt><dd>Bar of XMMS2's progress
3476 <p></p></dd><dt><span class="term">
3477 <span class="command"><strong>
3478 <code class="option">xmms2_bitrate</code>
3480 </span></dt><dd>Bitrate of current song
3481 <p></p></dd><dt><span class="term">
3482 <span class="command"><strong>
3483 <code class="option">xmms2_comment</code>
3485 </span></dt><dd>Comment in current XMMS2 song
3486 <p></p></dd><dt><span class="term">
3487 <span class="command"><strong>
3488 <code class="option">xmms2_date</code>
3490 </span></dt><dd>Returns song's date.
3491 <p></p></dd><dt><span class="term">
3492 <span class="command"><strong>
3493 <code class="option">xmms2_duration</code>
3495 </span></dt><dd>Duration of current song
3496 <p></p></dd><dt><span class="term">
3497 <span class="command"><strong>
3498 <code class="option">xmms2_elapsed</code>
3500 </span></dt><dd>Song's elapsed time
3501 <p></p></dd><dt><span class="term">
3502 <span class="command"><strong>
3503 <code class="option">xmms2_genre</code>
3505 </span></dt><dd>Genre in current XMMS2 song
3506 <p></p></dd><dt><span class="term">
3507 <span class="command"><strong>
3508 <code class="option">xmms2_id</code>
3510 </span></dt><dd>XMMS2 id of current song
3511 <p></p></dd><dt><span class="term">
3512 <span class="command"><strong>
3513 <code class="option">xmms2_percent</code>
3515 </span></dt><dd>Percent of song's progress
3516 <p></p></dd><dt><span class="term">
3517 <span class="command"><strong>
3518 <code class="option">xmms2_playlist</code>
3520 </span></dt><dd>Returns the XMMS2 playlist.
3521 <p></p></dd><dt><span class="term">
3522 <span class="command"><strong>
3523 <code class="option">xmms2_size</code>
3525 </span></dt><dd>Size of current song
3526 <p></p></dd><dt><span class="term">
3527 <span class="command"><strong>
3528 <code class="option">xmms2_smart</code>
3530 </span></dt><dd>Prints the song name in either the form "artist -
3531 title" or file name, depending on whats available
3532 <p></p></dd><dt><span class="term">
3533 <span class="command"><strong>
3534 <code class="option">xmms2_status</code>
3536 </span></dt><dd>XMMS2 status (Playing, Paused, Stopped, or
3538 <p></p></dd><dt><span class="term">
3539 <span class="command"><strong>
3540 <code class="option">xmms2_timesplayed</code>
3542 </span></dt><dd>Number of times a song was played (presumably).
3543 <p></p></dd><dt><span class="term">
3544 <span class="command"><strong>
3545 <code class="option">xmms2_title</code>
3547 </span></dt><dd>Title in current XMMS2 song
3548 <p></p></dd><dt><span class="term">
3549 <span class="command"><strong>
3550 <code class="option">xmms2_tracknr</code>
3552 </span></dt><dd>Track number in current XMMS2 song
3553 <p></p></dd><dt><span class="term">
3554 <span class="command"><strong>
3555 <code class="option">xmms2_url</code>
3557 </span></dt><dd>Full path to current song
3558 <p></p></dd></dl></div></div><div class="refsect1" title="Lua API"><a name="id535563"></a><h2>Lua API</h2><p>Conky features a Lua Programming API, and also ships with Lua
3559 bindings for some useful libraries. Conky defines certain global
3560 functions and variables which can be accessed from Lua code running
3562 </p><p>To use Lua Conky, you first need to make sure you have a version of Conky
3563 with Lua support enabled (``conky -v'' will report this). Scripts
3564 must first be loaded using the lua_load configuration option. You
3565 then call functions in Lua via Conky's $lua, $lua_read, and Lua
3568 Be careful when creating threaded objects through the Lua API. You
3569 could wind up with a whole bunch of threads running if a thread is
3570 created with each iteration.
3572 At this time, the Lua API should not be considered stable and may
3573 change drastically from one release to another as it matures.
3575 NOTE: In order to accommodate certain features in the cairo
3576 library's API, Conky will export a few additional functions for the
3577 creation of certain structures. These are documented below.
3578 </p><div class="variablelist"><dl><dt><span class="term">
3579 <span class="command"><strong>
3580 <code class="option">conky_parse(string)</code>
3582 <code class="option">function</code>
3583 </span></dt><dd><p>This function takes a string that is evaluated as
3584 per Conky's TEXT section, and then returns a string
3585 with the result.</p></dd><dt><span class="term">
3586 <span class="command"><strong>
3587 <code class="option">conky_set_update_interval(number)</code>
3589 <code class="option">function</code>
3590 </span></dt><dd><p>Sets Conky's update interval (in seconds) to
3591 'number'.</p></dd><dt><span class="term">
3592 <span class="command"><strong>
3593 <code class="option">conky_window</code>
3595 <code class="option">table</code>
3596 </span></dt><dd><p>This table contains some information about
3597 Conky's window. The following table describes the
3598 values contained:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>
3599 <span class="command"><strong>drawable</strong></span>
3600 <code class="option">Window's drawable (Xlib Drawable),
3601 requires Lua extras enabled at compile
3604 <span class="command"><strong>visual</strong></span>
3605 <code class="option">Window's visual (Xlib Visual), requires
3606 Lua extras enabled at compile time.</code>
3608 <span class="command"><strong>display</strong></span>
3609 <code class="option">Window's display (Xlib Display),
3610 requires Lua extras enabled at compile
3613 <span class="command"><strong>width</strong></span>
3614 <code class="option">Window width (in pixels).</code>
3616 <span class="command"><strong>height</strong></span>
3617 <code class="option">Window height (in pixels).</code>
3619 <span class="command"><strong>border_inner_margin</strong></span>
3620 <code class="option">Window's inner border margin (in
3623 <span class="command"><strong>border_outer_margin</strong></span>
3624 <code class="option">Window's outer border margin (in
3627 <span class="command"><strong>border_width</strong></span>
3628 <code class="option">Window's border width (in
3631 <span class="command"><strong>text_start_x</strong></span>
3632 <code class="option">The x component of the starting
3633 coordinate of text drawing.</code>
3635 <span class="command"><strong>text_start_y</strong></span>
3636 <code class="option">The y component of the starting
3637 coordinate of text drawing.</code>
3639 <span class="command"><strong>text_width</strong></span>
3640 <code class="option">The width of the text drawing
3643 <span class="command"><strong>text_height</strong></span>
3644 <code class="option">The height of the text drawing
3646 </td></tr></table><p>NOTE: This table is only defined when X support
3647 is enabled.</p></dd><dt><span class="term">
3648 <span class="command"><strong>
3649 <code class="option">conky_info</code>
3651 <code class="option">table</code>
3652 </span></dt><dd><p>This table contains some information about
3653 Conky's internal data. The following table describes
3654 the values contained:</p><table border="0" summary="Simple list" class="simplelist"><tr><td>
3655 <span class="command"><strong>update_interval</strong></span>
3656 <code class="option">Conky's update interval (in
3659 <span class="command"><strong>uptime</strong></span>
3660 <code class="option">System uptime, in seconds.</code>
3661 </td></tr></table></dd><dt><span class="term">
3662 <span class="command"><strong>
3663 <code class="option">conky_build_info</code>
3665 <code class="option">string</code>
3666 </span></dt><dd><p>A string containing the build info for this
3667 particular instance of Conky, including the version,
3668 build date, and architecture.</p></dd><dt><span class="term">
3669 <span class="command"><strong>
3670 <code class="option">conky_build_date</code>
3672 <code class="option">string</code>
3673 </span></dt><dd><p>A string containing the build date for this
3674 particular instance of Conky.</p></dd><dt><span class="term">
3675 <span class="command"><strong>
3676 <code class="option">conky_build_arch</code>
3678 <code class="option">string</code>
3679 </span></dt><dd><p>A string containing the build architecture for
3680 this particular instance of Conky.</p></dd><dt><span class="term">
3681 <span class="command"><strong>
3682 <code class="option">conky_version</code>
3684 <code class="option">string</code>
3685 </span></dt><dd><p>A string containing the version of the current
3686 instance of Conky.</p></dd><dt><span class="term">
3687 <span class="command"><strong>
3688 <code class="option">conky_config</code>
3690 <code class="option">string</code>
3691 </span></dt><dd><p>A string containing the path of the current Conky
3692 configuration file.</p></dd><dt><span class="term">
3693 <span class="command"><strong>
3694 <code class="option">cairo_text_extents_t:create()</code>
3696 <code class="option">function</code>
3698 Call this function to return a new cairo_text_extents_t structure. A creation function for this structure is not provided by the cairo API. After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
3699 </p></dd><dt><span class="term">
3700 <span class="command"><strong>
3701 <code class="option">cairo_font_extents_t:create()</code>
3703 <code class="option">function</code>
3705 Call this function to return a new cairo_font_extents_t structure. A creation function for this structure is not provided by the cairo API. After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
3706 </p></dd><dt><span class="term">
3707 <span class="command"><strong>
3708 <code class="option">cairo_matrix_t:create()</code>
3710 <code class="option">function</code>
3712 Call this function to return a new cairo_matrix_t structure. A creation function for this structure is not provided by the cairo API. After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
3713 </p></dd></dl></div></div><div class="refsect1" title="Examples"><a name="id536684"></a><h2>Examples</h2><div class="variablelist"><dl><dt><span class="term">
3714 <code class="varname">conky</code>
3715 <code class="option">-t '${time %D %H:%M}' -o -u 30</code>
3716 </span></dt><dd>Start Conky in its own window with date
3717 and clock as text and 30 sec update
3718 interval.</dd><dt><span class="term">
3719 <code class="varname">conky</code>
3720 <code class="option">-a top_left -x 5 -y 500 -d</code>
3721 </span></dt><dd>Start Conky to background at coordinates
3722 (5, 500).</dd><dt><span class="term">
3723 <code class="varname">conky</code>
3724 <code class="option">-C > ~/.conkyrc</code>
3725 </span></dt><dd>Do not start Conky, but have it output
3726 the builtin default config file to ~/.conkyrc for
3727 later customising.</dd></dl></div></div><div class="refsect1" title="Files"><a name="id536746"></a><h2>Files</h2><div class="variablelist"><dl><dt><span class="term">
3728 <code class="filename">
3729 ${sysconfdir}/conky/conky.conf</code>
3730 </span></dt><dd>Default system-wide configuration file.
3731 The value of ${sysconfdir} depends on the
3732 compile-time options (most likely /etc).</dd><dt><span class="term">
3733 <code class="filename">~/.conkyrc</code>
3734 </span></dt><dd>Default personal configuration
3735 file.</dd></dl></div></div><div class="refsect1" title="Bugs"><a name="id536788"></a><h2>Bugs</h2><p>Drawing to root or some other desktop window directly
3736 doesn't work with all window managers. Especially doesn't
3737 work well with Gnome and it has been reported that it
3738 doesn't work with KDE either. Nautilus can be disabled from
3739 drawing to desktop with program gconf-editor. Uncheck
3740 show_desktop in /apps/nautilus/preferences/. There is -w
3741 switch in Conky to set some specific window id. You might
3742 find xwininfo -tree useful to find the window to draw to.
3743 You can also use -o argument which makes Conky to create
3744 its own window. If you do try running Conky in its own
3745 window, be sure to read up on the own_window_type settings
3746 and experiment.</p></div><div class="refsect1" title="See Also"><a name="id536804"></a><h2>See Also</h2><p>
3747 <a class="ulink" href="http://conky.sourceforge.net/" target="_top">
3748 http://conky.sourceforge.net/</a>
3750 <a class="ulink" href="http://www.sourceforge.net/projects/conky" target="_top">
3751 http://www.sourceforge.net/projects/conky</a>
3753 <a class="ulink" href="http://wiki.conky.be" target="_top">
3754 http://wiki.conky.be</a>
3755 </p><p>#conky on irc.freenode.net</p></div><div class="refsect1" title="Copying"><a name="id536842"></a><h2>Copying</h2><p>Copyright (c) 2005-2010 Brenden Matthews, Philip
3756 Kovacs, et. al. Any original torsmo code is licensed under
3757 the BSD license (see LICENSE.BSD for a copy). All code
3758 written since the fork of torsmo is licensed under the GPL
3759 (see LICENSE.GPL for a copy), except where noted
3760 differently (such as in portmon code, timed thread code,
3761 and audacious code which are LGPL, and prss which is an
3762 MIT-style license).</p></div><div class="refsect1" title="Authors"><a name="id536856"></a><h2>Authors</h2><p>The Conky dev team (see AUTHORS for a full list of
3763 contributors).</p></div></div></body></html>
projects / monky / blob