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_middle, middle_right, or
23 none (also can be abreviated as tl, tr, tm, bl, br, bm, ml,
24 mm, mr). See also gap_x and gap_y.
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>disable_auto_reload</option>
166 <listitem>Enable to disable the inotify-based auto config reload feature.
172 <option>diskio_avg_samples</option>
175 <listitem>The number of samples to average for disk I/O
182 <option>display</option>
185 <listitem>Specify an X display to connect to.
191 <option>double_buffer</option>
194 <listitem>Use the Xdbe extension? (eliminates flicker) It
195 is highly recommended to use own window with this one so
196 double buffer won't be so big.
202 <option>draw_borders</option>
205 <listitem>Draw borders around text?
211 <option>draw_graph_borders</option>
214 <listitem>Draw borders around graphs?
220 <option>draw_outline</option>
223 <listitem>Draw outlines?
229 <option>draw_shades</option>
232 <listitem>Draw shades?
238 <option>extra_newline</option>
241 <listitem>Put an extra newline at the end when writing to
242 stdout, useful for writing to awesome's wiboxes.
248 <option>font</option>
251 <listitem>Font name in X, xfontsel can be used to get a
258 <option>format_human_readable</option>
261 <listitem>If enabled, values which are in bytes will be
262 printed in human readable format (i.e., KiB, MiB, etc). If
263 disabled, the number of bytes is printed instead.
269 <option>gap_x</option>
272 <listitem>Gap, in pixels, between right or left border of
273 screen, same as passing -x at command line, e.g. gap_x 10.
274 For other position related stuff, see 'alignment'.
280 <option>gap_y</option>
283 <listitem>Gap, in pixels, between top or bottom border of
284 screen, same as passing -y at command line, e.g. gap_y 10.
285 For other position related stuff, see 'alignment'.
291 <option>hddtemp_host</option>
294 <listitem>Hostname to connect to for hddtemp objects. Defaults
301 <option>hddtemp_port</option>
304 <listitem>Port to use for hddtemp connections. Defaults to
311 <option>if_up_strictness</option>
314 <listitem>How strict should if_up be when testing an
315 interface for being up? The value is one of up, link or
316 address, to check for the interface being solely up, being
317 up and having link or being up, having link and an assigned
324 <option>imap</option>
327 <listitem>Default global IMAP server. Arguments are: "host
328 user pass [-i interval (in seconds)] [-f 'folder'] [-p port]
329 [-e 'command'] [-r retries]". Default port is 143, default
330 folder is 'INBOX', default interval is 5 minutes, and
331 default number of retries before giving up is 5. If the
332 password is supplied as '*', you will be prompted to enter
333 the password when Conky starts.
339 <option>imlib_cache_flush_interval</option>
342 <listitem>Interval (in seconds) to flush Imlib2 cache.
348 <option>imlib_cache_size</option>
352 Imlib2 image cache size, in bytes. Defaults to
353 4MiB. Increase this value if you use $image lots. Set
354 to 0 to disable the image cache.<para/>
360 <option>lua_draw_hook_post</option>
362 <option>function_name [function arguments]</option>
365 This function, if defined, will be called by
366 Conky through each iteration after drawing to the
367 window. Requires X support. Takes any number of
368 optional arguments. Use this hook for drawing things on
369 top of what Conky draws. Conky puts 'conky_' in front
370 of function_name to prevent accidental calls to the
371 wrong function unless you place 'conky_' in front of it
378 <option>lua_draw_hook_pre</option>
380 <option>function_name [function arguments]</option>
383 This function, if defined, will be called by
384 Conky through each iteration before drawing to the
385 window. Requires X support. Takes any number of
386 optional arguments. Use this hook for drawing things on
387 top of what Conky draws. Conky puts 'conky_' in front
388 of function_name to prevent accidental calls to the
389 wrong function unless you place 'conky_' in front of it
396 <option>lua_load</option>
399 <listitem>Loads the Lua scripts separated by spaces.
405 <option>lua_shutdown_hook</option>
407 <option>function_name [function arguments]</option>
410 This function, if defined, will be called by
411 Conky at shutdown or when the configuration is
412 reloaded. Use this hook to clean up after yourself,
413 such as freeing memory which has been allocated by
414 external libraries via Lua. Conky puts 'conky_' in
415 front of function_name to prevent accidental calls to
416 the wrong function unless you place 'conky_' in
417 front of it yourself.<para/>
423 <option>lua_startup_hook</option>
425 <option>function_name [function arguments]</option>
428 This function, if defined, will be called by
429 Conky at startup or when the configuration is reloaded.
430 Use this hook to initialize values, or for any run-once
431 applications. Conky puts 'conky_' in front of
432 function_name to prevent accidental calls to the wrong
433 function unless you place 'conky_' in front of
440 <option>mail_spool</option>
443 <listitem>Mail spool for mail checking
449 <option>max_port_monitor_connections</option>
452 <listitem>Allow each port monitor to track at most this
453 many connections (if 0 or not set, default is 256)
459 <option>max_specials</option>
462 <listitem>Maximum number of special things, e.g. fonts,
463 offsets, aligns, etc. (default is 512)
469 <option>max_text_width</option>
471 <option>width</option>
473 <listitem>When a line in the output contains 'width'
474 chars and the end isn't reached, the next char will start
475 on a new line. If you want to make sure that lines don't
476 get broken, set 'width' to 0
482 <option>max_user_text</option>
484 <option>bytes</option>
486 <listitem>Maximum size of user text buffer, i.e. layout
487 below TEXT line in config file (default is 16384 bytes)
493 <option>maximum_width</option>
495 <option>pixels</option>
497 <listitem>Maximum width of window
503 <option>minimum_size</option>
505 <option>width (height)</option>
507 <listitem>Minimum size of window
513 <option>mpd_host</option>
516 <listitem>Host of MPD server
522 <option>mpd_password</option>
525 <listitem>MPD server password
531 <option>mpd_port</option>
534 <listitem>Port of MPD server
540 <option>music_player_interval</option>
543 <listitem>Music player thread update interval (defaults to
544 Conky's update interval)
550 <option>net_avg_samples</option>
553 <listitem>The number of samples to average for net data
559 <option>no_buffers</option>
562 <listitem>Substract (file system) buffers from used memory?
569 <option>out_to_console</option>
572 <listitem>Print text to stdout.
578 <option>out_to_ncurses</option>
581 <listitem>Print text in the console, but use ncurses so
582 that conky can print the text of a new update over the old
583 text. (In the future this will provide more useful things)
589 <option>out_to_stderr</option>
592 <listitem>Print text to stderr.
598 <option>out_to_x</option>
601 <listitem>When set to no, there will be no output in X
602 (useful when you also use things like out_to_console). If
603 you set it to no, make sure that it's placed before all
604 other X-related setting (take the first line of your
605 configfile to be sure). Default value is yes
611 <option>override_utf8_locale</option>
614 <listitem>Force UTF8? requires XFT
620 <option>overwrite_file</option>
623 <listitem>Overwrite the file given as argument.
629 <option>own_window</option>
632 <listitem>Boolean, create own window to draw?
638 <option>own_window_class</option>
641 <listitem>Manually set the WM_CLASS name. Defaults to
648 <option>own_window_colour</option>
650 <option>colour</option>
652 <listitem>If own_window_transparent no, set a specified
653 background colour (defaults to black). Takes either a hex
654 value (e.g. ffffff, note the lack of '#') or a valid RGB
655 name (see /usr/lib/X11/rgb.txt)
661 <option>own_window_hints</option>
664 undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
666 <listitem>If own_window is yes, you may use these window
667 manager hints to affect the way Conky displays. Notes: Use
668 own_window_type desktop as another way to implement many of
669 these hints implicitly. If you use own_window_type
670 override, window manager hints have no meaning and are
677 <option>own_window_title</option>
680 <listitem>Manually set the window name. Defaults to
681 "<hostname> - conky".
687 <option>own_window_argb_visual</option>
690 <listitem>Boolean, use ARGB visual? ARGB can be used for real
691 transparency, note that a composite manager is required for real
692 transparency. This option will not work as desired (in most cases)
693 in conjunction with 'own_window_type override'.
699 <option>own_window_argb_value</option>
702 <listitem>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.
708 <option>own_window_transparent</option>
711 <listitem>Boolean, set transparency? If ARGB visual is enabled, sets
712 background opacity to 0%.
718 <option>own_window_type</option>
721 <listitem>if own_window is yes, you may specify type
722 normal, desktop, dock, panel or override (default: normal).
723 Desktop windows are special windows that have no window
724 decorations; are always visible on your desktop; do not
725 appear in your pager or taskbar; and are sticky across all
726 workspaces. Panel windows reserve space along a desktop
727 edge, just like panels and taskbars, preventing maximized
728 windows from overlapping them. The edge is chosen based on
729 the alignment option. Override windows are not under the
730 control of the window manager. Hints are ignored. This type
731 of window can be useful for certain situations.
737 <option>pad_percents</option>
740 <listitem>Pad percentages to this many decimals (0 = no
747 <option>pop3</option>
750 <listitem>Default global POP3 server. Arguments are: "host
751 user pass [-i interval (in seconds)] [-p port] [-e 'command']
752 [-r retries]". Default port is 110, default interval is 5
753 minutes, and default number of retries before giving up is
754 5. If the password is supplied as '*', you will be prompted
755 to enter the password when Conky starts.
761 <option>short_units</option>
764 <listitem>Shortens units to a single character (kiB->k,
765 GiB->G, etc.). Default is off.
771 <option>show_graph_range</option>
774 <listitem>Shows the time range covered by a graph.
780 <option>show_graph_scale</option>
783 <listitem>Shows the maximum value in scaled graphs.
789 <option>stippled_borders</option>
792 <listitem>Border stippling (dashing) in pixels
798 <option>temperature_unit</option>
801 <listitem>Desired output unit of all objects displaying a
802 temperature. Parameters are either "fahrenheit" or
803 "celsius". The default unit is degree Celsius.
809 <option>templateN</option>
812 <listitem>Define a template for later use inside TEXT
813 segments. Substitute N by a digit between 0 and 9,
814 inclusively. The value of the variable is being inserted
815 into the stuff below TEXT at the corresponding position,
816 but before some substitutions are applied:
818 <member>'\n' -> newline</member>
819 <member>'\\' -> backslash</member>
820 <member>'\ ' -> space</member>
821 <member>'\N' -> template argument N</member>
828 <option>text_buffer_size</option>
830 <option>bytes</option>
832 <listitem>Size of the standard text buffer (default is 256
833 bytes). This buffer is used for intermediary text, such as
834 individual lines, output from $exec vars, and various other
835 variables. Increasing the size of this buffer can
836 drastically reduce Conky's performance, but will allow for
837 more text display per variable. The size of this buffer
838 cannot be smaller than the default value of 256 bytes.
844 <option>times_in_seconds</option>
847 <listitem>If true, variables that output times output a number
848 that represents seconds. This doesn't affect $time, $tztime and
855 <option>top_cpu_separate</option>
858 <listitem>If true, cpu in top will show usage of one
859 processor's power. If false, cpu in top will show the usage
860 of all processors' power combined.
866 <option>top_name_width</option>
869 <listitem>Width for $top name value (defaults to 15
876 <option>total_run_times</option>
879 <listitem>Total number of times for Conky to update before
880 quitting. Zero makes Conky run forever
886 <option>update_interval</option>
888 <option>seconds</option>
890 <listitem>Update interval
896 <option>update_interval_on_battery</option>
898 <option>seconds</option>
900 <listitem>Update interval when running on batterypower
906 <option>uppercase</option>
909 <listitem>Boolean value, if true, text is rendered in upper
916 <option>use_spacer</option>
919 <listitem>Adds spaces around certain objects to stop them
920 from moving other things around. Arguments are left, right,
921 and none (default). The old true/false values are
922 deprecated and default to right/none respectively. Note
923 that this only helps if you are using a mono font, such as
924 Bitstream Vera Sans Mono.
930 <option>use_xft</option>
933 <listitem>Use Xft (anti-aliased font and stuff)
939 <option>xftalpha</option>
942 <listitem>Alpha of Xft font. Must be a value at or between
949 <option>xftfont</option>
952 <listitem>Xft font to use.