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>alignment</option>
20 <listitem>Aligned position on screen, may be top_left,
21 top_right, top_middle, bottom_left, bottom_right,
22 bottom_middle, middle_left, middle_right, or none (also can
23 be abreviated as tl, tr, tm, bl, br, bm, ml, mr). See also
30 <option>append_file</option>
33 <listitem>Append the file given as argument.
39 <option>background</option>
42 <listitem>Boolean value, if true, Conky will be forked to
43 background when started.
49 <option>border_inner_margin</option>
52 <listitem>Inner border margin in pixels (the margin between
59 <option>border_outer_margin</option>
62 <listitem>Outer border margin in pixels (the margin between
63 the border and the edge of the window).
69 <option>border_width</option>
72 <listitem>Border width in pixels.
78 <option>colorN</option>
81 <listitem>Predefine a color for use inside TEXT segments.
82 Substitute N by a digit between 0 and 9, inclusively. When
83 specifying the color value in hex, omit the leading hash
90 <option>cpu_avg_samples</option>
93 <listitem>The number of samples to average for CPU
100 <option>default_bar_size</option>
103 <listitem>Specify a default width and height for bars.
104 Example: 'default_bar_size 0 6'. This is particularly
105 useful for execbar and execibar as they do not take size
112 <option>default_color</option>
115 <listitem>Default color and border color
121 <option>default_gauge_size</option>
124 <listitem>Specify a default width and height for gauges.
125 Example: 'default_gauge_size 25 25'. This is particularly
126 useful for execgauge and execigauge as they do not take
133 <option>default_graph_size</option>
136 <listitem>Specify a default width and height for graphs.
137 Example: 'default_graph_size 0 25'. This is particularly
138 useful for execgraph and execigraph as they do not take
145 <option>default_outline_color</option>
148 <listitem>Default outline color
154 <option>default_shade_color</option>
157 <listitem>Default shading color and border's shading color
163 <option>diskio_avg_samples</option>
166 <listitem>The number of samples to average for disk I/O
173 <option>display</option>
176 <listitem>Specify an X display to connect to.
182 <option>double_buffer</option>
185 <listitem>Use the Xdbe extension? (eliminates flicker) It
186 is highly recommended to use own window with this one so
187 double buffer won't be so big.
193 <option>draw_borders</option>
196 <listitem>Draw borders around text?
202 <option>draw_graph_borders</option>
205 <listitem>Draw borders around graphs?
211 <option>draw_outline</option>
214 <listitem>Draw outlines?
220 <option>draw_shades</option>
223 <listitem>Draw shades?
229 <option>extra_newline</option>
232 <listitem>Put an extra newline at the end when writing to
233 stdout, useful for writing to awesome's wiboxes.
239 <option>font</option>
242 <listitem>Font name in X, xfontsel can be used to get a
249 <option>format_human_readable</option>
252 <listitem>If enabled, values which are in bytes will be
253 printed in human readable format (i.e., KiB, MiB, etc). If
254 disabled, the number of bytes is printed instead.
260 <option>gap_x</option>
263 <listitem>Gap, in pixels, between right or left border of
264 screen, same as passing -x at command line, e.g. gap_x 10.
265 For other position related stuff, see 'alignment'.
271 <option>gap_y</option>
274 <listitem>Gap, in pixels, between top or bottom border of
275 screen, same as passing -y at command line, e.g. gap_y 10.
276 For other position related stuff, see 'alignment'.
282 <option>if_up_strictness</option>
285 <listitem>How strict should if_up be when testing an
286 interface for being up? The value is one of up, link or
287 address, to check for the interface being solely up, being
288 up and having link or being up, having link and an assigned
295 <option>imap</option>
298 <listitem>Default global IMAP server. Arguments are: "host
299 user pass [-i interval (in seconds)] [-f folder] [-p port]
300 [-e command] [-r retries]". Default port is 143, default
301 folder is 'INBOX', default interval is 5 minutes, and
302 default number of retries before giving up is 5. If the
303 password is supplied as '*', you will be prompted to enter
304 the password when Conky starts.
310 <option>imlib_cache_flush_interval</option>
313 <listitem>Interval (in seconds) to flush Imlib2 cache.
319 <option>imlib_cache_size</option>
323 <para>Imlib2 image cache size, in bytes. Defaults to
324 4MiB. Increase this value if you use $image lots. Set
325 to 0 to disable the image cache.</para>
331 <option>lua_draw_hook_post</option>
333 <option>function_name [function arguments]</option>
336 <para>This function, if defined, will be called by
337 Conky through each iteration after drawing to the
338 window. Requires X support. Takes any number of
339 optional arguments. Use this hook for drawing things on
340 top of what Conky draws. Conky puts 'conky_' in front
341 of function_name to prevent accidental calls to the
342 wrong function unless you place 'conky_' in front of it
349 <option>lua_draw_hook_pre</option>
351 <option>function_name [function arguments]</option>
354 <para>This function, if defined, will be called by
355 Conky through each iteration before drawing to the
356 window. Requires X support. Takes any number of
357 optional arguments. Use this hook for drawing things on
358 top of what Conky draws. Conky puts 'conky_' in front
359 of function_name to prevent accidental calls to the
360 wrong function unless you place 'conky_' in front of it
367 <option>lua_load</option>
370 <listitem>Loads the Lua scripts separated by spaces.
376 <option>lua_shutdown_hook</option>
378 <option>function_name [function arguments]</option>
381 <para>This function, if defined, will be called by
382 Conky at shutdown or when the configuration is
383 reloaded. Use this hook to clean up after yourself,
384 such as freeing memory which has been allocated by
385 external libraries via Lua. Conky puts 'conky_' in
386 front of function_name to prevent accidental calls to
387 the wrong function unless you place 'conky_' in
388 front of it yourself.</para>
394 <option>lua_startup_hook</option>
396 <option>function_name [function arguments]</option>
399 <para>This function, if defined, will be called by
400 Conky at startup or when the configuration is reloaded.
401 Use this hook to initialize values, or for any run-once
402 applications. Conky puts 'conky_' in front of
403 function_name to prevent accidental calls to the wrong
404 function unless you place 'conky_' in front of
411 <option>mail_spool</option>
414 <listitem>Mail spool for mail checking
420 <option>max_port_monitor_connections</option>
423 <listitem>Allow each port monitor to track at most this
424 many connections (if 0 or not set, default is 256)
430 <option>max_specials</option>
433 <listitem>Maximum number of special things, e.g. fonts,
434 offsets, aligns, etc. (default is 512)
440 <option>max_user_text</option>
442 <option>bytes</option>
444 <listitem>Maximum size of user text buffer, i.e. layout
445 below TEXT line in config file (default is 16384 bytes)
451 <option>maximum_width</option>
453 <option>pixels</option>
455 <listitem>Maximum width of window
461 <option>minimum_size</option>
463 <option>width (height)</option>
465 <listitem>Minimum size of window
471 <option>mpd_host</option>
474 <listitem>Host of MPD server
480 <option>mpd_password</option>
483 <listitem>MPD server password
489 <option>mpd_port</option>
492 <listitem>Port of MPD server
498 <option>music_player_interval</option>
501 <listitem>Music player thread update interval (defaults to
502 Conky's update interval)
508 <option>net_avg_samples</option>
511 <listitem>The number of samples to average for net data
517 <option>no_buffers</option>
520 <listitem>Substract (file system) buffers from used memory?
527 <option>out_to_console</option>
530 <listitem>Print text to stdout.
536 <option>out_to_ncurses</option>
539 <listitem>Print text in the console, but use ncurses so
540 that conky can print the text of a new update over the old
541 text. (In the future this will provide more useful things)
547 <option>out_to_stderr</option>
550 <listitem>Print text to stderr.
556 <option>out_to_x</option>
559 <listitem>When set to no, there will be no output in X
560 (useful when you also use things like out_to_console). If
561 you set it to no, make sure that it's placed before all
562 other X-related setting (take the first line of your
563 configfile to be sure). Default value is yes
569 <option>override_utf8_locale</option>
572 <listitem>Force UTF8? requires XFT
578 <option>overwrite_file</option>
581 <listitem>Overwrite the file given as argument.
587 <option>own_window</option>
590 <listitem>Boolean, create own window to draw?
596 <option>own_window_class</option>
599 <listitem>Manually set the WM_CLASS name. Defaults to
606 <option>own_window_colour</option>
608 <option>colour</option>
610 <listitem>If own_window_transparent no, set a specified
611 background colour (defaults to black). Takes either a hex
612 value (#ffffff) or a valid RGB name (see
613 /usr/lib/X11/rgb.txt)
619 <option>own_window_hints</option>
622 undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
624 <listitem>If own_window is yes, you may use these window
625 manager hints to affect the way Conky displays. Notes: Use
626 own_window_type desktop as another way to implement many of
627 these hints implicitly. If you use own_window_type
628 override, window manager hints have no meaning and are
635 <option>own_window_title</option>
638 <listitem>Manually set the window name. Defaults to
639 "<hostname> - conky".
645 <option>own_window_transparent</option>
648 <listitem>Boolean, set pseudo-transparency?
654 <option>own_window_type</option>
657 <listitem>if own_window is yes, you may specify type
658 normal, desktop, dock, panel or override (default: normal).
659 Desktop windows are special windows that have no window
660 decorations; are always visible on your desktop; do not
661 appear in your pager or taskbar; and are sticky across all
662 workspaces. Panel windows reserve space along a desktop
663 edge, just like panels and taskbars, preventing maximized
664 windows from overlapping them. The edge is chosen based on
665 the alignment option. Override windows are not under the
666 control of the window manager. Hints are ignored. This type
667 of window can be useful for certain situations.
673 <option>pad_percents</option>
676 <listitem>Pad percentages to this many decimals (0 = no
683 <option>pop3</option>
686 <listitem>Default global POP3 server. Arguments are: "host
687 user pass [-i interval (in seconds)] [-p port] [-e command]
688 [-r retries]". Default port is 110, default interval is 5
689 minutes, and default number of retries before giving up is
690 5. If the password is supplied as '*', you will be prompted
691 to enter the password when Conky starts.
697 <option>short_units</option>
700 <listitem>Shortens units to a single character (kiB->k,
701 GiB->G, etc.). Default is off.
707 <option>show_graph_range</option>
710 <listitem>Shows the time range covered by a graph.
716 <option>show_graph_scale</option>
719 <listitem>Shows the maximum value in scaled graphs.
725 <option>stippled_borders</option>
728 <listitem>Border stippling (dashing) in pixels
734 <option>temperature_unit</option>
737 <listitem>Desired output unit of all objects displaying a
738 temperature. Parameters are either "fahrenheit" or
739 "celsius". The default unit is degree Celsius.
745 <option>templateN</option>
748 <listitem>Define a template for later use inside TEXT
749 segments. Substitute N by a digit between 0 and 9,
750 inclusively. The value of the variable is being inserted
751 into the stuff below TEXT at the corresponding position,
752 but before some substitutions are applied:
754 <member>'\n' -> newline</member>
755 <member>'\\' -> backslash</member>
756 <member>'\ ' -> space</member>
757 <member>'\N' -> template argument N</member>
764 <option>text_buffer_size</option>
766 <option>bytes</option>
768 <listitem>Size of the standard text buffer (default is 256
769 bytes). This buffer is used for intermediary text, such as
770 individual lines, output from $exec vars, and various other
771 variables. Increasing the size of this buffer can
772 drastically reduce Conky's performance, but will allow for
773 more text display per variable. The size of this buffer
774 cannot be smaller than the default value of 256 bytes.
780 <option>top_cpu_separate</option>
783 <listitem>If true, cpu in top will show usage of one
784 processor's power. If false, cpu in top will show the usage
785 of all processors' power combined.
791 <option>top_name_width</option>
794 <listitem>Width for $top name value (defaults to 15
801 <option>total_run_times</option>
804 <listitem>Total number of times for Conky to update before
805 quitting. Zero makes Conky run forever
811 <option>update_interval</option>
813 <option>seconds</option>
815 <listitem>Update interval
821 <option>update_interval_on_battery</option>
823 <option>seconds</option>
825 <listitem>Update interval when running on batterypower
831 <option>uppercase</option>
834 <listitem>Boolean value, if true, text is rendered in upper
841 <option>use_spacer</option>
844 <listitem>Adds spaces around certain objects to stop them
845 from moving other things around. Arguments are left, right,
846 and none (default). The old true/false values are
847 deprecated and default to right/none respectively. Note
848 that this only helps if you are using a mono font, such as
849 Bitstream Vera Sans Mono.
855 <option>use_xft</option>
858 <listitem>Use Xft (anti-aliased font and stuff)
864 <option>xftalpha</option>
867 <listitem>Alpha of Xft font. Must be a value at or between
874 <option>xftfont</option>
877 <listitem>Xft font to use.