8 <listitem>After this begins text to be formatted on screen.
9 Backslash (\) escapes newlines in the text section. This
10 can be useful for cleaning up config files where conky is
11 used to pipe input to dzen2.
17 <option>alias</option>
20 <listitem>Use this to create aliases of variables. The
21 first argument is the new name, the second the old name,
22 and the other arguments are passed on to the variable.
23 Example: If you want to use $alpha instead of ${beta gamma
24 delta} then you have to write the following: alias alpha
25 beta gamma delta . PS: Instead of creating an alias in the
26 config you can also use environment variables. Example:
27 Start conky like this: alpha="beta gamma delta" conky
33 <option>alignment</option>
36 <listitem>Aligned position on screen, may be top_left,
37 top_right, top_middle, bottom_left, bottom_right,
38 bottom_middle, middle_left, middle_right, or none (also can
39 be abreviated as tl, tr, tm, bl, br, bm, ml, mr). See also
46 <option>append_file</option>
49 <listitem>Append the file given as argument.
55 <option>background</option>
58 <listitem>Boolean value, if true, Conky will be forked to
59 background when started.
65 <option>border_inner_margin</option>
68 <listitem>Inner border margin in pixels (the margin between
75 <option>border_outer_margin</option>
78 <listitem>Outer border margin in pixels (the margin between
79 the border and the edge of the window).
85 <option>border_width</option>
88 <listitem>Border width in pixels.
94 <option>colorN</option>
97 <listitem>Predefine a color for use inside TEXT segments.
98 Substitute N by a digit between 0 and 9, inclusively. When
99 specifying the color value in hex, omit the leading hash
106 <option>cpu_avg_samples</option>
109 <listitem>The number of samples to average for CPU
116 <option>default_bar_size</option>
119 <listitem>Specify a default width and height for bars.
120 Example: 'default_bar_size 0 6'. This is particularly
121 useful for execbar and execibar as they do not take size
128 <option>default_color</option>
131 <listitem>Default color and border color
137 <option>default_gauge_size</option>
140 <listitem>Specify a default width and height for gauges.
141 Example: 'default_gauge_size 25 25'. This is particularly
142 useful for execgauge and execigauge as they do not take
149 <option>default_graph_size</option>
152 <listitem>Specify a default width and height for graphs.
153 Example: 'default_graph_size 0 25'. This is particularly
154 useful for execgraph and execigraph as they do not take
161 <option>default_outline_color</option>
164 <listitem>Default outline color
170 <option>default_shade_color</option>
173 <listitem>Default shading color and border's shading color
179 <option>diskio_avg_samples</option>
182 <listitem>The number of samples to average for disk I/O
189 <option>display</option>
192 <listitem>Specify an X display to connect to.
198 <option>double_buffer</option>
201 <listitem>Use the Xdbe extension? (eliminates flicker) It
202 is highly recommended to use own window with this one so
203 double buffer won't be so big.
209 <option>draw_borders</option>
212 <listitem>Draw borders around text?
218 <option>draw_graph_borders</option>
221 <listitem>Draw borders around graphs?
227 <option>draw_outline</option>
230 <listitem>Draw outlines?
236 <option>draw_shades</option>
239 <listitem>Draw shades?
245 <option>extra_newline</option>
248 <listitem>Put an extra newline at the end when writing to
249 stdout, useful for writing to awesome's wiboxes.
255 <option>font</option>
258 <listitem>Font name in X, xfontsel can be used to get a
265 <option>format_human_readable</option>
268 <listitem>If enabled, values which are in bytes will be
269 printed in human readable format (i.e., KiB, MiB, etc). If
270 disabled, the number of bytes is printed instead.
276 <option>gap_x</option>
279 <listitem>Gap, in pixels, between right or left border of
280 screen, same as passing -x at command line, e.g. gap_x 10.
281 For other position related stuff, see 'alignment'.
287 <option>gap_y</option>
290 <listitem>Gap, in pixels, between top or bottom border of
291 screen, same as passing -y at command line, e.g. gap_y 10.
292 For other position related stuff, see 'alignment'.
298 <option>if_up_strictness</option>
301 <listitem>How strict should if_up be when testing an
302 interface for being up? The value is one of up, link or
303 address, to check for the interface being solely up, being
304 up and having link or being up, having link and an assigned
311 <option>imap</option>
314 <listitem>Default global IMAP server. Arguments are: "host
315 user pass [-i interval (in seconds)] [-f folder] [-p port]
316 [-e command] [-r retries]". Default port is 143, default
317 folder is 'INBOX', default interval is 5 minutes, and
318 default number of retries before giving up is 5. If the
319 password is supplied as '*', you will be prompted to enter
320 the password when Conky starts.
326 <option>imlib_cache_flush_interval</option>
329 <listitem>Interval (in seconds) to flush Imlib2 cache.
335 <option>imlib_cache_size</option>
338 <listitem>Imlib2 image cache size, in bytes. Defaults to
339 4MiB. Increase this value if you use $image lots. Set to 0
340 to disable the image cache.
346 <option>lua_draw_hook_post</option>
348 <option>function_name [function arguments]</option>
351 <para>This function, if defined, will be called by
352 Conky through each iteration after drawing to the
353 window. Requires X support. Takes any number of
354 optional arguments. Use this hook for drawing things on
355 top of what Conky draws.</para>
361 <option>lua_draw_hook_pre</option>
363 <option>function_name [function arguments]</option>
366 <para>This function, if defined, will be called by
367 Conky through each iteration before drawing to the
368 window. Requires X support. Takes any number of
369 optional arguments. Use this hook for drawing things on
370 top of what Conky draws.</para>
376 <option>lua_load</option>
379 <listitem>Loads the Lua scripts separated by spaces.
385 <option>mail_spool</option>
388 <listitem>Mail spool for mail checking
394 <option>max_port_monitor_connections</option>
397 <listitem>Allow each port monitor to track at most this
398 many connections (if 0 or not set, default is 256)
404 <option>max_specials</option>
407 <listitem>Maximum number of special things, e.g. fonts,
408 offsets, aligns, etc. (default is 512)
414 <option>max_user_text</option>
416 <option>bytes</option>
418 <listitem>Maximum size of user text buffer, i.e. layout
419 below TEXT line in config file (default is 16384 bytes)
425 <option>maximum_width</option>
427 <option>pixels</option>
429 <listitem>Maximum width of window
435 <option>minimum_size</option>
437 <option>width (height)</option>
439 <listitem>Minimum size of window
445 <option>mpd_host</option>
448 <listitem>Host of MPD server
454 <option>mpd_password</option>
457 <listitem>MPD server password
463 <option>mpd_port</option>
466 <listitem>Port of MPD server
472 <option>music_player_interval</option>
475 <listitem>Music player thread update interval (defaults to
476 Conky's update interval)
482 <option>net_avg_samples</option>
485 <listitem>The number of samples to average for net data
491 <option>no_buffers</option>
494 <listitem>Substract (file system) buffers from used memory?
501 <option>out_to_console</option>
504 <listitem>Print text to stdout.
510 <option>out_to_stderr</option>
513 <listitem>Print text to stderr.
519 <option>out_to_x</option>
522 <listitem>When set to no, there will be no output in X
523 (useful when you also use things like out_to_console). If
524 you set it to no, make sure that it's placed before all
525 other X-related setting (take the first line of your
526 configfile to be sure). Default value is yes
532 <option>override_utf8_locale</option>
535 <listitem>Force UTF8? requires XFT
541 <option>overwrite_file</option>
544 <listitem>Overwrite the file given as argument.
550 <option>own_window</option>
553 <listitem>Boolean, create own window to draw?
559 <option>own_window_class</option>
562 <listitem>Manually set the WM_CLASS name. Defaults to
569 <option>own_window_colour</option>
571 <option>colour</option>
573 <listitem>If own_window_transparent no, set a specified
574 background colour (defaults to black). Takes either a hex
575 value (#ffffff) or a valid RGB name (see
576 /usr/lib/X11/rgb.txt)
582 <option>own_window_hints</option>
585 undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
587 <listitem>If own_window is yes, you may use these window
588 manager hints to affect the way Conky displays. Notes: Use
589 own_window_type desktop as another way to implement many of
590 these hints implicitly. If you use own_window_type
591 override, window manager hints have no meaning and are
598 <option>own_window_title</option>
601 <listitem>Manually set the window name. Defaults to
602 "<hostname> - conky".
608 <option>own_window_transparent</option>
611 <listitem>Boolean, set pseudo-transparency?
617 <option>own_window_type</option>
620 <listitem>if own_window is yes, you may specify type
621 normal, desktop, dock, panel or override (default: normal).
622 Desktop windows are special windows that have no window
623 decorations; are always visible on your desktop; do not
624 appear in your pager or taskbar; and are sticky across all
625 workspaces. Panel windows reserve space along a desktop
626 edge, just like panels and taskbars, preventing maximized
627 windows from overlapping them. The edge is chosen based on
628 the alignment option. Override windows are not under the
629 control of the window manager. Hints are ignored. This type
630 of window can be useful for certain situations.
636 <option>pad_percents</option>
639 <listitem>Pad percentages to this many decimals (0 = no
646 <option>pop3</option>
649 <listitem>Default global POP3 server. Arguments are: "host
650 user pass [-i interval (in seconds)] [-p port] [-e command]
651 [-r retries]". Default port is 110, default interval is 5
652 minutes, and default number of retries before giving up is
653 5. If the password is supplied as '*', you will be prompted
654 to enter the password when Conky starts.
660 <option>short_units</option>
663 <listitem>Shortens units to a single character (kiB->k,
664 GiB->G, etc.). Default is off.
670 <option>show_graph_range</option>
673 <listitem>Shows the time range covered by a graph.
679 <option>show_graph_scale</option>
682 <listitem>Shows the maximum value in scaled graphs.
688 <option>stippled_borders</option>
691 <listitem>Border stippling (dashing) in pixels
697 <option>temperature_unit</option>
700 <listitem>Desired output unit of all objects displaying a
701 temperature. Parameters are either "fahrenheit" or
702 "celsius". The default unit is degree Celsius.
708 <option>templateN</option>
711 <listitem>Define a template for later use inside TEXT
712 segments. Substitute N by a digit between 0 and 9,
713 inclusively. The value of the variable is being inserted
714 into the stuff below TEXT at the corresponding position,
715 but before some substitutions are applied:
717 <member>'\n' -> newline</member>
718 <member>'\\' -> backslash</member>
719 <member>'\ ' -> space</member>
720 <member>'\N' -> template argument N</member>
727 <option>text_buffer_size</option>
729 <option>bytes</option>
731 <listitem>Size of the standard text buffer (default is 256
732 bytes). This buffer is used for intermediary text, such as
733 individual lines, output from $exec vars, and various other
734 variables. Increasing the size of this buffer can
735 drastically reduce Conky's performance, but will allow for
736 more text display per variable. The size of this buffer
737 cannot be smaller than the default value of 256 bytes.
743 <option>top_cpu_separate</option>
746 <listitem>If true, cpu in top will show usage of one
747 processor's power. If false, cpu in top will show the usage
748 of all processors' power combined.
754 <option>top_name_width</option>
757 <listitem>Width for $top name value (defaults to 15
764 <option>total_run_times</option>
767 <listitem>Total number of times for Conky to update before
768 quitting. Zero makes Conky run forever
774 <option>update_interval</option>
776 <option>seconds</option>
778 <listitem>Update interval
784 <option>update_interval_on_battery</option>
786 <option>seconds</option>
788 <listitem>Update interval when running on batterypower
794 <option>uppercase</option>
797 <listitem>Boolean value, if true, text is rendered in upper
804 <option>use_spacer</option>
807 <listitem>Adds spaces around certain objects to stop them
808 from moving other things around. Arguments are left, right,
809 and none (default). The old true/false values are
810 deprecated and default to right/none respectively. Note
811 that this only helps if you are using a mono font, such as
812 Bitstream Vera Sans Mono.
818 <option>use_xft</option>
821 <listitem>Use Xft (anti-aliased font and stuff)
827 <option>xftalpha</option>
830 <listitem>Alpha of Xft font. Must be a value at or between
837 <option>xftfont</option>
840 <listitem>Xft font to use.