changes related to temperature and layout
[monky] / doc / config_settings.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4 <title>Configuration Settings</title>
5 </head>
6 <body bgcolor="#FFFFFF"><table cellpadding="3">
7 <tr bgcolor="#eecfa1">
8 <th>Variable</th>
9 <th>Explanation</th>
10 </tr>
11 <tr bgcolor="#fffafa">
12 <td align="center">TEXT</td>
13 <td>After this begins text to be formatted on screen.
14         Backslash (\) escapes newlines in the text section. This
15         can be useful for cleaning up config files where conky is
16         used to pipe input to dzen2. 
17         <p></p>
18 </td>
19 </tr>
20 <tr bgcolor="#b4cdcd">
21 <td align="center">alignment</td>
22 <td>Aligned position on screen, may be top_left,
23         top_right, top_middle, bottom_left, bottom_right,
24         bottom_middle, middle_left, middle_middle, middle_right, or
25         none (also can be abreviated as tl, tr, tm, bl, br, bm, ml,
26         mm, mr). See also gap_x and gap_y.
27         <p></p>
28 </td>
29 </tr>
30 <tr bgcolor="#fffafa">
31 <td align="center">append_file</td>
32 <td>Append the file given as argument. 
33         <p></p>
34 </td>
35 </tr>
36 <tr bgcolor="#b4cdcd">
37 <td align="center">background</td>
38 <td>Boolean value, if true, Conky will be forked to
39         background when started. 
40         <p></p>
41 </td>
42 </tr>
43 <tr bgcolor="#fffafa">
44 <td align="center">border_inner_margin</td>
45 <td>Inner border margin in pixels (the margin between
46         the border and text). 
47         <p></p>
48 </td>
49 </tr>
50 <tr bgcolor="#b4cdcd">
51 <td align="center">border_outer_margin</td>
52 <td>Outer border margin in pixels (the margin between
53         the border and the edge of the window). 
54         <p></p>
55 </td>
56 </tr>
57 <tr bgcolor="#fffafa">
58 <td align="center">border_width</td>
59 <td>Border width in pixels. 
60         <p></p>
61 </td>
62 </tr>
63 <tr bgcolor="#b4cdcd">
64 <td align="center">colorN</td>
65 <td>Predefine a color for use inside TEXT segments.
66         Substitute N by a digit between 0 and 9, inclusively. When
67         specifying the color value in hex, omit the leading hash
68         (#). 
69         <p></p>
70 </td>
71 </tr>
72 <tr bgcolor="#fffafa">
73 <td align="center">cpu_avg_samples</td>
74 <td>The number of samples to average for CPU
75         monitoring. 
76         <p></p>
77 </td>
78 </tr>
79 <tr bgcolor="#b4cdcd">
80 <td align="center">default_bar_size</td>
81 <td>Specify a default width and height for bars.
82         Example: 'default_bar_size 0 6'. This is particularly
83         useful for execbar and execibar as they do not take size
84         arguments. 
85         <p></p>
86 </td>
87 </tr>
88 <tr bgcolor="#fffafa">
89 <td align="center">default_color</td>
90 <td>Default color and border color 
91         <p></p>
92 </td>
93 </tr>
94 <tr bgcolor="#b4cdcd">
95 <td align="center">default_gauge_size</td>
96 <td>Specify a default width and height for gauges.
97         Example: 'default_gauge_size 25 25'. This is particularly
98         useful for execgauge and execigauge as they do not take
99         size arguments 
100         <p></p>
101 </td>
102 </tr>
103 <tr bgcolor="#fffafa">
104 <td align="center">default_graph_size</td>
105 <td>Specify a default width and height for graphs.
106         Example: 'default_graph_size 0 25'. This is particularly
107         useful for execgraph and execigraph as they do not take
108         size arguments 
109         <p></p>
110 </td>
111 </tr>
112 <tr bgcolor="#b4cdcd">
113 <td align="center">default_outline_color</td>
114 <td>Default outline color 
115         <p></p>
116 </td>
117 </tr>
118 <tr bgcolor="#fffafa">
119 <td align="center">default_shade_color</td>
120 <td>Default shading color and border's shading color 
121         <p></p>
122 </td>
123 </tr>
124 <tr bgcolor="#b4cdcd">
125 <td align="center">disable_auto_reload</td>
126 <td>Enable to disable the inotify-based auto config reload feature.
127         <p></p>
128 </td>
129 </tr>
130 <tr bgcolor="#fffafa">
131 <td align="center">diskio_avg_samples</td>
132 <td>The number of samples to average for disk I/O
133         monitoring. 
134         <p></p>
135 </td>
136 </tr>
137 <tr bgcolor="#b4cdcd">
138 <td align="center">display</td>
139 <td>Specify an X display to connect to. 
140         <p></p>
141 </td>
142 </tr>
143 <tr bgcolor="#fffafa">
144 <td align="center">double_buffer</td>
145 <td>Use the Xdbe extension? (eliminates flicker) It
146         is highly recommended to use own window with this one so
147         double buffer won't be so big. 
148         <p></p>
149 </td>
150 </tr>
151 <tr bgcolor="#b4cdcd">
152 <td align="center">draw_borders</td>
153 <td>Draw borders around text? 
154         <p></p>
155 </td>
156 </tr>
157 <tr bgcolor="#fffafa">
158 <td align="center">draw_graph_borders</td>
159 <td>Draw borders around graphs? 
160         <p></p>
161 </td>
162 </tr>
163 <tr bgcolor="#b4cdcd">
164 <td align="center">draw_outline</td>
165 <td>Draw outlines? 
166         <p></p>
167 </td>
168 </tr>
169 <tr bgcolor="#fffafa">
170 <td align="center">draw_shades</td>
171 <td>Draw shades? 
172         <p></p>
173 </td>
174 </tr>
175 <tr bgcolor="#b4cdcd">
176 <td align="center">extra_newline</td>
177 <td>Put an extra newline at the end when writing to
178         stdout, useful for writing to awesome's wiboxes. 
179         <p></p>
180 </td>
181 </tr>
182 <tr bgcolor="#fffafa">
183 <td align="center">font</td>
184 <td>Font name in X, xfontsel can be used to get a
185         nice font 
186         <p></p>
187 </td>
188 </tr>
189 <tr bgcolor="#b4cdcd">
190 <td align="center">format_human_readable</td>
191 <td>If enabled, values which are in bytes will be
192         printed in human readable format (i.e., KiB, MiB, etc). If
193         disabled, the number of bytes is printed instead. 
194         <p></p>
195 </td>
196 </tr>
197 <tr bgcolor="#fffafa">
198 <td align="center">gap_x</td>
199 <td>Gap, in pixels, between right or left border of
200         screen, same as passing -x at command line, e.g. gap_x 10.
201         For other position related stuff, see 'alignment'. 
202         <p></p>
203 </td>
204 </tr>
205 <tr bgcolor="#b4cdcd">
206 <td align="center">gap_y</td>
207 <td>Gap, in pixels, between top or bottom border of
208         screen, same as passing -y at command line, e.g. gap_y 10.
209         For other position related stuff, see 'alignment'. 
210         <p></p>
211 </td>
212 </tr>
213 <tr bgcolor="#fffafa">
214 <td align="center">hddtemp_host</td>
215 <td>Hostname to connect to for hddtemp objects. Defaults
216                 to "127.0.0.1".
217         <p></p>
218 </td>
219 </tr>
220 <tr bgcolor="#b4cdcd">
221 <td align="center">hddtemp_port</td>
222 <td>Port to use for hddtemp connections. Defaults to
223                 7634.
224         <p></p>
225 </td>
226 </tr>
227 <tr bgcolor="#fffafa">
228 <td align="center">if_up_strictness</td>
229 <td>How strict should if_up be when testing an
230         interface for being up? The value is one of up, link or
231         address, to check for the interface being solely up, being
232         up and having link or being up, having link and an assigned
233         IP address. 
234         <p></p>
235 </td>
236 </tr>
237 <tr bgcolor="#b4cdcd">
238 <td align="center">imap</td>
239 <td>Default global IMAP server. Arguments are: "host
240         user pass [-i interval (in seconds)] [-f 'folder'] [-p port]
241         [-e 'command'] [-r retries]". Default port is 143, default
242         folder is 'INBOX', default interval is 5 minutes, and
243         default number of retries before giving up is 5. If the
244         password is supplied as '*', you will be prompted to enter
245         the password when Conky starts. 
246         <p></p>
247 </td>
248 </tr>
249 <tr bgcolor="#fffafa">
250 <td align="center">imlib_cache_flush_interval</td>
251 <td>Interval (in seconds) to flush Imlib2 cache. 
252         <p></p>
253 </td>
254 </tr>
255 <tr bgcolor="#b4cdcd">
256 <td align="center">imlib_cache_size</td>
257 <td>
258             Imlib2 image cache size, in bytes. Defaults to
259             4MiB. Increase this value if you use $image lots. Set
260             to 0 to disable the image cache.<p></p>
261         </td>
262 </tr>
263 <tr bgcolor="#fffafa">
264 <td align="center">lua_draw_hook_post</td>
265 <td>
266             This function, if defined, will be called by
267             Conky through each iteration after drawing to the
268             window. Requires X support. Takes any number of
269             optional arguments. Use this hook for drawing things on
270             top of what Conky draws. Conky puts 'conky_' in front
271             of function_name to prevent accidental calls to the
272             wrong function unless you place 'conky_' in front of it
273             yourself.<p></p>
274         </td>
275 </tr>
276 <tr bgcolor="#b4cdcd">
277 <td align="center">lua_draw_hook_pre</td>
278 <td>
279             This function, if defined, will be called by
280             Conky through each iteration before drawing to the
281             window. Requires X support. Takes any number of
282             optional arguments. Use this hook for drawing things on
283             top of what Conky draws. Conky puts 'conky_' in front
284             of function_name to prevent accidental calls to the
285             wrong function unless you place 'conky_' in front of it
286             yourself.<p></p>
287         </td>
288 </tr>
289 <tr bgcolor="#fffafa">
290 <td align="center">lua_load</td>
291 <td>Loads the Lua scripts separated by spaces. 
292         <p></p>
293 </td>
294 </tr>
295 <tr bgcolor="#b4cdcd">
296 <td align="center">lua_shutdown_hook</td>
297 <td>
298             This function, if defined, will be called by
299             Conky at shutdown or when the configuration is
300             reloaded. Use this hook to clean up after yourself,
301             such as freeing memory which has been allocated by
302             external libraries via Lua. Conky puts 'conky_' in
303             front of function_name to prevent accidental calls to
304             the wrong function unless you place 'conky_' in
305             front of it yourself.<p></p>
306         </td>
307 </tr>
308 <tr bgcolor="#fffafa">
309 <td align="center">lua_startup_hook</td>
310 <td>
311             This function, if defined, will be called by
312             Conky at startup or when the configuration is reloaded.
313             Use this hook to initialize values, or for any run-once
314             applications. Conky puts 'conky_' in front of
315             function_name to prevent accidental calls to the wrong
316             function unless you place 'conky_' in front of
317             it yourself.<p></p>
318         </td>
319 </tr>
320 <tr bgcolor="#b4cdcd">
321 <td align="center">mail_spool</td>
322 <td>Mail spool for mail checking 
323         <p></p>
324 </td>
325 </tr>
326 <tr bgcolor="#fffafa">
327 <td align="center">max_port_monitor_connections</td>
328 <td>Allow each port monitor to track at most this
329         many connections (if 0 or not set, default is 256) 
330         <p></p>
331 </td>
332 </tr>
333 <tr bgcolor="#b4cdcd">
334 <td align="center">max_specials</td>
335 <td>Maximum number of special things, e.g. fonts,
336         offsets, aligns, etc. (default is 512) 
337         <p></p>
338 </td>
339 </tr>
340 <tr bgcolor="#fffafa">
341 <td align="center">max_text_width</td>
342 <td>When a line in the output contains 'width'
343         chars and the end isn't reached, the next char will start
344         on a new line. If you want to make sure that lines don't
345         get broken, set 'width' to 0
346         <p></p>
347 </td>
348 </tr>
349 <tr bgcolor="#b4cdcd">
350 <td align="center">max_user_text</td>
351 <td>Maximum size of user text buffer, i.e. layout
352         below TEXT line in config file (default is 16384 bytes) 
353         <p></p>
354 </td>
355 </tr>
356 <tr bgcolor="#fffafa">
357 <td align="center">maximum_width</td>
358 <td>Maximum width of window 
359         <p></p>
360 </td>
361 </tr>
362 <tr bgcolor="#b4cdcd">
363 <td align="center">minimum_size</td>
364 <td>Minimum size of window 
365         <p></p>
366 </td>
367 </tr>
368 <tr bgcolor="#fffafa">
369 <td align="center">mpd_host</td>
370 <td>Host of MPD server 
371         <p></p>
372 </td>
373 </tr>
374 <tr bgcolor="#b4cdcd">
375 <td align="center">mpd_password</td>
376 <td>MPD server password 
377         <p></p>
378 </td>
379 </tr>
380 <tr bgcolor="#fffafa">
381 <td align="center">mpd_port</td>
382 <td>Port of MPD server 
383         <p></p>
384 </td>
385 </tr>
386 <tr bgcolor="#b4cdcd">
387 <td align="center">music_player_interval</td>
388 <td>Music player thread update interval (defaults to
389         Conky's update interval) 
390         <p></p>
391 </td>
392 </tr>
393 <tr bgcolor="#fffafa">
394 <td align="center">net_avg_samples</td>
395 <td>The number of samples to average for net data 
396         <p></p>
397 </td>
398 </tr>
399 <tr bgcolor="#b4cdcd">
400 <td align="center">no_buffers</td>
401 <td>Subtract (file system) buffers from used memory?
402         
403         <p></p>
404 </td>
405 </tr>
406 <tr bgcolor="#fffafa">
407 <td align="center">out_to_console</td>
408 <td>Print text to stdout. 
409         <p></p>
410 </td>
411 </tr>
412 <tr bgcolor="#b4cdcd">
413 <td align="center">out_to_ncurses</td>
414 <td>Print text in the console, but use ncurses so
415         that conky can print the text of a new update over the old
416         text. (In the future this will provide more useful things) 
417         <p></p>
418 </td>
419 </tr>
420 <tr bgcolor="#fffafa">
421 <td align="center">out_to_stderr</td>
422 <td>Print text to stderr. 
423         <p></p>
424 </td>
425 </tr>
426 <tr bgcolor="#b4cdcd">
427 <td align="center">out_to_x</td>
428 <td>When set to no, there will be no output in X
429         (useful when you also use things like out_to_console). If
430         you set it to no, make sure that it's placed before all
431         other X-related setting (take the first line of your
432         configfile to be sure). Default value is yes 
433         <p></p>
434 </td>
435 </tr>
436 <tr bgcolor="#fffafa">
437 <td align="center">override_utf8_locale</td>
438 <td>Force UTF8? requires XFT 
439         <p></p>
440 </td>
441 </tr>
442 <tr bgcolor="#b4cdcd">
443 <td align="center">overwrite_file</td>
444 <td>Overwrite the file given as argument. 
445         <p></p>
446 </td>
447 </tr>
448 <tr bgcolor="#fffafa">
449 <td align="center">own_window</td>
450 <td>Boolean, create own window to draw? 
451         <p></p>
452 </td>
453 </tr>
454 <tr bgcolor="#b4cdcd">
455 <td align="center">own_window_class</td>
456 <td>Manually set the WM_CLASS name. Defaults to
457         "Conky". 
458         <p></p>
459 </td>
460 </tr>
461 <tr bgcolor="#fffafa">
462 <td align="center">own_window_colour</td>
463 <td>If own_window_transparent no, set a specified
464         background colour (defaults to black). Takes either a hex
465         value (e.g. ffffff, note the lack of '#') or a valid RGB
466         name (see /usr/lib/X11/rgb.txt)
467         <p></p>
468 </td>
469 </tr>
470 <tr bgcolor="#b4cdcd">
471 <td align="center">own_window_hints</td>
472 <td>If own_window is yes, you may use these window
473         manager hints to affect the way Conky displays. Notes: Use
474         own_window_type desktop as another way to implement many of
475         these hints implicitly. If you use own_window_type
476         override, window manager hints have no meaning and are
477         ignored. 
478         <p></p>
479 </td>
480 </tr>
481 <tr bgcolor="#fffafa">
482 <td align="center">own_window_title</td>
483 <td>Manually set the window name. Defaults to
484         "&lt;hostname&gt; - conky". 
485         <p></p>
486 </td>
487 </tr>
488 <tr bgcolor="#b4cdcd">
489 <td align="center">own_window_argb_visual</td>
490 <td>Boolean, use ARGB visual? ARGB can be used for real
491                         transparency, note that a composite manager is required for real
492                         transparency.  This option will not work as desired (in most cases)
493                         in conjunction with 'own_window_type override'.
494         <p></p>
495 </td>
496 </tr>
497 <tr bgcolor="#fffafa">
498 <td align="center">own_window_argb_value</td>
499 <td>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.
500         <p></p>
501 </td>
502 </tr>
503 <tr bgcolor="#b4cdcd">
504 <td align="center">own_window_transparent</td>
505 <td>Boolean, set transparency? If ARGB visual is enabled, sets
506                         background opacity to 0%.
507         <p></p>
508 </td>
509 </tr>
510 <tr bgcolor="#fffafa">
511 <td align="center">own_window_type</td>
512 <td>if own_window is yes, you may specify type
513         normal, desktop, dock, panel or override (default: normal).
514         Desktop windows are special windows that have no window
515         decorations; are always visible on your desktop; do not
516         appear in your pager or taskbar; and are sticky across all
517         workspaces. Panel windows reserve space along a desktop
518         edge, just like panels and taskbars, preventing maximized
519         windows from overlapping them. The edge is chosen based on
520         the alignment option. Override windows are not under the
521         control of the window manager. Hints are ignored. This type
522         of window can be useful for certain situations. 
523         <p></p>
524 </td>
525 </tr>
526 <tr bgcolor="#b4cdcd">
527 <td align="center">pad_percents</td>
528 <td>Pad percentages to this many decimals (0 = no
529         padding) 
530         <p></p>
531 </td>
532 </tr>
533 <tr bgcolor="#fffafa">
534 <td align="center">pop3</td>
535 <td>Default global POP3 server. Arguments are: "host
536         user pass [-i interval (in seconds)] [-p port] [-e 'command']
537         [-r retries]". Default port is 110, default interval is 5
538         minutes, and default number of retries before giving up is
539         5. If the password is supplied as '*', you will be prompted
540         to enter the password when Conky starts. 
541         <p></p>
542 </td>
543 </tr>
544 <tr bgcolor="#b4cdcd">
545 <td align="center">short_units</td>
546 <td>Shortens units to a single character (kiB-&gt;k,
547         GiB-&gt;G, etc.). Default is off. 
548         <p></p>
549 </td>
550 </tr>
551 <tr bgcolor="#fffafa">
552 <td align="center">show_graph_range</td>
553 <td>Shows the time range covered by a graph. 
554         <p></p>
555 </td>
556 </tr>
557 <tr bgcolor="#b4cdcd">
558 <td align="center">show_graph_scale</td>
559 <td>Shows the maximum value in scaled graphs. 
560         <p></p>
561 </td>
562 </tr>
563 <tr bgcolor="#fffafa">
564 <td align="center">stippled_borders</td>
565 <td>Border stippling (dashing) in pixels 
566         <p></p>
567 </td>
568 </tr>
569 <tr bgcolor="#b4cdcd">
570 <td align="center">temperature_unit</td>
571 <td>Desired output unit of all objects displaying a
572         temperature. Parameters are either "fahrenheit" or
573         "celsius". The default unit is degree Celsius. 
574         <p></p>
575 </td>
576 </tr>
577 <tr bgcolor="#fffafa">
578 <td align="center">templateN</td>
579 <td>Define a template for later use inside TEXT
580         segments. Substitute N by a digit between 0 and 9,
581         inclusively. The value of the variable is being inserted
582         into the stuff below TEXT at the corresponding position,
583         but before some substitutions are applied: 
584         <ul>
585 <li>'\n' -&gt; newline</li>
586 <li>'\\' -&gt; backslash</li>
587 <li>'\ ' -&gt; space</li>
588 <li>'\N' -&gt; template argument N</li>
589 </ul>
590         <p></p>
591 </td>
592 </tr>
593 <tr bgcolor="#b4cdcd">
594 <td align="center">text_buffer_size</td>
595 <td>Size of the standard text buffer (default is 256
596         bytes). This buffer is used for intermediary text, such as
597         individual lines, output from $exec vars, and various other
598         variables. Increasing the size of this buffer can
599         drastically reduce Conky's performance, but will allow for
600         more text display per variable. The size of this buffer
601         cannot be smaller than the default value of 256 bytes. 
602         <p></p>
603 </td>
604 </tr>
605 <tr bgcolor="#fffafa">
606 <td align="center">times_in_seconds</td>
607 <td>If true, variables that output times output a number
608         that represents seconds. This doesn't affect $time, $tztime and
609         $utime
610         <p></p>
611 </td>
612 </tr>
613 <tr bgcolor="#b4cdcd">
614 <td align="center">top_cpu_separate</td>
615 <td>If true, cpu in top will show usage of one
616         processor's power. If false, cpu in top will show the usage
617         of all processors' power combined. 
618         <p></p>
619 </td>
620 </tr>
621 <tr bgcolor="#fffafa">
622 <td align="center">top_name_width</td>
623 <td>Width for $top name value (defaults to 15
624         characters). 
625         <p></p>
626 </td>
627 </tr>
628 <tr bgcolor="#b4cdcd">
629 <td align="center">total_run_times</td>
630 <td>Total number of times for Conky to update before
631         quitting. Zero makes Conky run forever 
632         <p></p>
633 </td>
634 </tr>
635 <tr bgcolor="#fffafa">
636 <td align="center">update_interval</td>
637 <td>Update interval 
638         <p></p>
639 </td>
640 </tr>
641 <tr bgcolor="#b4cdcd">
642 <td align="center">update_interval_on_battery</td>
643 <td>Update interval when running on batterypower 
644         <p></p>
645 </td>
646 </tr>
647 <tr bgcolor="#fffafa">
648 <td align="center">uppercase</td>
649 <td>Boolean value, if true, text is rendered in upper
650         case 
651         <p></p>
652 </td>
653 </tr>
654 <tr bgcolor="#b4cdcd">
655 <td align="center">use_spacer</td>
656 <td>Adds spaces around certain objects to stop them
657         from moving other things around. Arguments are left, right,
658         and none (default). The old true/false values are
659         deprecated and default to right/none respectively. Note
660         that this only helps if you are using a mono font, such as
661         Bitstream Vera Sans Mono. 
662         <p></p>
663 </td>
664 </tr>
665 <tr bgcolor="#fffafa">
666 <td align="center">use_xft</td>
667 <td>Use Xft (anti-aliased font and stuff) 
668         <p></p>
669 </td>
670 </tr>
671 <tr bgcolor="#b4cdcd">
672 <td align="center">xftalpha</td>
673 <td>Alpha of Xft font. Must be a value at or between
674         1 and 0. 
675         <p></p>
676 </td>
677 </tr>
678 <tr bgcolor="#fffafa">
679 <td align="center">xftfont</td>
680 <td>Xft font to use. 
681         <p></p>
682 </td>
683 </tr>
684 </table></body>
685 </html>