3 <term><command><option>alias</option></command></term>
5 Use this to create aliases of variables. The first argument is the new name, the second the old name, and the other arguments are passed on to the variable. Example: If you want to use $alpha instead of ${beta gamma delta} then you have to write the following: alias alpha beta gamma delta . PS: Instead of creating an alias in the config you can also use environment variables. Example: Start conky like this: alpha="beta gamma delta" conky
6 <para></para></listitem>
10 <term><command><option>alignment</option></command></term>
12 Aligned position on screen, may be top_left, top_right, top_middle, bottom_left, bottom_right, bottom_middle, middle_left, middle_right, or none (also can be abreviated as tl, tr, tm, bl, br, bm, ml, mr). See also gap_x and gap_y.
13 <para></para></listitem>
17 <term><command><option>background</option></command></term>
19 Boolean value, if true, Conky will be forked to background when started.
20 <para></para></listitem>
24 <term><command><option>border_margin</option></command></term>
26 Border margin in pixels.
27 <para></para></listitem>
31 <term><command><option>border_width</option></command></term>
33 Border width in pixels.
34 <para></para></listitem>
38 <term><command><option>colorN</option></command></term>
40 Predefine a color for use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively. When specifying the color value in hex, omit the leading hash (#).
41 <para></para></listitem>
45 <term><command><option>cpu_avg_samples</option></command></term>
47 The number of samples to average for CPU monitoring.
48 <para></para></listitem>
52 <term><command><option>diskio_avg_samples</option></command></term>
54 The number of samples to average for disk I/O monitoring.
55 <para></para></listitem>
59 <term><command><option>top_name_width</option></command></term>
61 Width for $top name value (defaults to 15 characters).
62 <para></para></listitem>
66 <term><command><option>top_cpu_separate</option></command></term>
68 If true, cpu in top will show usage of one processor's power. If false, cpu in top will show the usage of all processors' power combined.
69 <para></para></listitem>
73 <term><command><option>default_bar_size</option></command></term>
75 Specify a default width and height for bars. Example: 'default_bar_size 0 6'. This is particularly useful for execbar and execibar as they do not take size arguments.
76 <para></para></listitem>
80 <term><command><option>default_graph_size</option></command></term>
82 Specify a default width and height for graphs. Example: 'default_graph_size 0 25'. This is particularly useful for execgraph and execigraph as they do not take size arguments
83 <para></para></listitem>
87 <term><command><option>default_gauge_size</option></command></term>
89 Specify a default width and height for gauges. Example: 'default_gauge_size 25 25'. This is particularly useful for execgauge and execigauge as they do not take size arguments
90 <para></para></listitem>
94 <term><command><option>default_color</option></command></term>
96 Default color and border color
97 <para></para></listitem>
101 <term><command><option>default_outline_color</option></command></term>
103 Default outline color
104 <para></para></listitem>
108 <term><command><option>default_shade_color</option></command></term>
110 Default shading color and border's shading color
111 <para></para></listitem>
115 <term><command><option>double_buffer</option></command></term>
117 Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
118 <para></para></listitem>
122 <term><command><option>draw_borders</option></command></term>
124 Draw borders around text?
125 <para></para></listitem>
129 <term><command><option>draw_graph_borders</option></command></term>
131 Draw borders around graphs?
132 <para></para></listitem>
136 <term><command><option>draw_outline</option></command></term>
139 <para></para></listitem>
143 <term><command><option>draw_shades</option></command></term>
146 <para></para></listitem>
150 <term><command><option>display</option></command></term>
152 Specify an X display to connect to.
153 <para></para></listitem>
157 <term><command><option>font</option></command></term>
159 Font name in X, xfontsel can be used to get a nice font
160 <para></para></listitem>
164 <term><command><option>gap_x</option></command></term>
166 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
167 e.g. gap_x 10. For other position related stuff, see 'alignment'.
168 <para></para></listitem>
172 <term><command><option>gap_y</option></command></term>
174 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
175 e.g. gap_y 10. For other position related stuff, see 'alignment'.
176 <para></para></listitem>
180 <term><command><option>if_up_strictness</option></command></term>
182 How strict should if_up be when testing an interface for being up? The value is one of up, link or address, to check for the interface being solely up, being up and having link or being up, having link and an assigned IP address.
183 <para></para></listitem>
187 <term><command><option>imap</option></command></term>
189 Default global IMAP server. Arguments are: "host user pass [-i interval (in seconds)] [-f folder] [-p port] [-e command] [-r retries]". Default port is 143, default folder is 'INBOX', default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
190 <para></para></listitem>
194 <term><command><option>mail_spool</option></command></term>
196 Mail spool for mail checking
197 <para></para></listitem>
201 <term><command><option>max_port_monitor_connections</option></command></term>
203 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
204 <para></para></listitem>
208 <term><command><option>max_specials</option></command></term>
210 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
211 <para></para></listitem>
215 <term><command><option>max_user_text</option></command>
216 <option>bytes</option>
219 Maximum size of user text buffer, i.e. layout below TEXT line in config file
220 (default is 16384 bytes)
221 <para></para></listitem>
225 <term><command><option>text_buffer_size</option></command>
226 <option>bytes</option>
229 Size of the standard text buffer (default is 256 bytes). This buffer is used for intermediary text, such as individual lines, output from $exec vars, and various other variables. Increasing the size of this buffer can drastically reduce Conky's performance, but will allow for more text display per variable. The size of this buffer cannot be smaller than the default value of 256 bytes.
230 <para></para></listitem>
234 <term><command><option>maximum_width</option></command>
235 <option>pixels</option>
238 Maximum width of window
239 <para></para></listitem>
243 <term><command><option>minimum_size</option></command>
244 <option>width (height)</option>
247 Minimum size of window
248 <para></para></listitem>
252 <term><command><option>mpd_host</option></command></term>
255 <para></para></listitem>
259 <term><command><option>mpd_port</option></command></term>
262 <para></para></listitem>
266 <term><command><option>mpd_password</option></command></term>
269 <para></para></listitem>
273 <term><command><option>music_player_interval</option></command></term>
275 Music player thread update interval (defaults to Conky's update interval)
276 <para></para></listitem>
280 <term><command><option>net_avg_samples</option></command></term>
282 The number of samples to average for net data
283 <para></para></listitem>
287 <term><command><option>no_buffers</option></command></term>
289 Substract (file system) buffers from used memory?
290 <para></para></listitem>
294 <term><command><option>override_utf8_locale</option></command></term>
296 Force UTF8? requires XFT
297 <para></para></listitem>
301 <term><command><option>own_window</option></command></term>
303 Boolean, create own window to draw?
304 <para></para></listitem>
308 <term><command><option>own_window_class</option></command></term>
310 Manually set the WM_CLASS name. Defaults to "Conky".
311 <para></para></listitem>
315 <term><command><option>own_window_colour</option></command>
316 <option>colour</option>
319 If own_window_transparent no, set a specified background colour (defaults to black). Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
320 <para></para></listitem>
324 <term><command><option>own_window_hints</option></command>
325 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
328 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
329 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
330 If you use own_window_type override, window manager hints have no meaning and are ignored.
331 <para></para></listitem>
335 <term><command><option>own_window_title</option></command></term>
337 Manually set the window name. Defaults to "<hostname> - conky".
338 <para></para></listitem>
342 <term><command><option>own_window_transparent</option></command></term>
344 Boolean, set pseudo-transparency?
345 <para></para></listitem>
349 <term><command><option>own_window_type</option></command></term>
351 if own_window is yes, you may specify type normal, desktop, dock or override (default: normal).
352 Desktop windows are special windows that have no window decorations; are always visible
353 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
354 Override windows are not under the control of the window manager. Hints are ignored. This type
355 of window can be useful for certain situations.
356 <para></para></listitem>
360 <term><command><option>out_to_console</option></command>
363 Print text to stdout.
364 <para></para></listitem>
368 <term><command><option>out_to_stderr</option></command>
371 Print text to stderr.
372 <para></para></listitem>
376 <term><command><option>out_to_x</option></command>
379 When set to no, there will be no output in X (useful when you also use things like out_to_console).
380 If you set it to no, make sure that it's placed before all other X-related setting (take the first
381 line of your configfile to be sure). Default value is yes
382 <para></para></listitem>
386 <term><command><option>overwrite_file</option></command>
389 Overwrite the file given as argument.
390 <para></para></listitem>
394 <term><command><option>append_file</option></command>
397 Append the file given as argument.
398 <para></para></listitem>
402 <term><command><option>pad_percents</option></command></term>
404 Pad percentages to this many decimals (0 = no padding)
405 <para></para></listitem>
409 <term><command><option>pop3</option></command></term>
411 Default global POP3 server. Arguments are: "host user pass [-i interval (in seconds)] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
412 <para></para></listitem>
416 <term><command><option>short_units</option></command></term>
418 Shortens units to a single character (kiB->k, GiB->G, etc.). Default is off.
419 <para></para></listitem>
423 <term><command><option>show_graph_scale</option></command></term>
425 Shows the maximum value in scaled graphs.
426 <para></para></listitem>
430 <term><command><option>show_graph_range</option></command></term>
432 Shows the time range covered by a graph.
433 <para></para></listitem>
437 <term><command><option>stippled_borders</option></command></term>
439 Border stippling (dashing) in pixels
440 <para></para></listitem>
444 <term><command><option>temperature_unit</option></command></term>
446 Desired output unit of all objects displaying a temperature.
447 Parameters are either "fahrenheit" or "celsius". The default
448 unit is degree Celsius.
449 <para></para></listitem>
453 <term><command><option>templateN</option></command></term>
455 Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
456 The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
457 but before some substitutions are applied:
459 <member>'\n' -> newline</member>
460 <member>'\\' -> backslash</member>
461 <member>'\ ' -> space</member>
462 <member>'\N' -> template argument N</member>
464 <para></para></listitem>
468 <term><command><option>total_run_times</option></command></term>
470 Total number of times for Conky to update before quitting. Zero makes Conky run forever
471 <para></para></listitem>
475 <term><command><option>update_interval</option></command></term>
477 Update interval in seconds
478 <para></para></listitem>
482 <term><command><option>uppercase</option></command></term>
484 Boolean value, if true, text is rendered in upper case
485 <para></para></listitem>
489 <term><command><option>use_spacer</option></command></term>
491 Adds spaces around certain objects to stop them from moving other things around. Arguments are left, right, and none (default). The old true/false values are deprecated and default to right/none respectively. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
492 <para></para></listitem>
496 <term><command><option>use_xft</option></command></term>
498 Use Xft (anti-aliased font and stuff)
499 <para></para></listitem>
503 <term><command><option>xftalpha</option></command></term>
505 Alpha of Xft font. Must be a value at or between 1 and 0.
506 <para></para></listitem>
510 <term><command><option>xftfont</option></command></term>
513 <para></para></listitem>
517 <term><command><option>TEXT</option></command></term>
519 After this begins text to be formatted on screen. Backslash (\) escapes newlines in the text section. This can be useful for cleaning up config files where conky is used to pipe input to dzen2.
520 <para></para></listitem>