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>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>hddtemp_host</option>
285 <listitem>Hostname to connect to for hddtemp objects. Defaults
292 <option>hddtemp_port</option>
295 <listitem>Port to use for hddtemp connections. Defaults to
302 <option>if_up_strictness</option>
305 <listitem>How strict should if_up be when testing an
306 interface for being up? The value is one of up, link or
307 address, to check for the interface being solely up, being
308 up and having link or being up, having link and an assigned
315 <option>imap</option>
318 <listitem>Default global IMAP server. Arguments are: "host
319 user pass [-i interval (in seconds)] [-f 'folder'] [-p port]
320 [-e 'command'] [-r retries]". Default port is 143, default
321 folder is 'INBOX', default interval is 5 minutes, and
322 default number of retries before giving up is 5. If the
323 password is supplied as '*', you will be prompted to enter
324 the password when Conky starts.
330 <option>imlib_cache_flush_interval</option>
333 <listitem>Interval (in seconds) to flush Imlib2 cache.
339 <option>imlib_cache_size</option>
343 Imlib2 image cache size, in bytes. Defaults to
344 4MiB. Increase this value if you use $image lots. Set
345 to 0 to disable the image cache.<para/>
351 <option>lua_draw_hook_post</option>
353 <option>function_name [function arguments]</option>
356 This function, if defined, will be called by
357 Conky through each iteration after drawing to the
358 window. Requires X support. Takes any number of
359 optional arguments. Use this hook for drawing things on
360 top of what Conky draws. Conky puts 'conky_' in front
361 of function_name to prevent accidental calls to the
362 wrong function unless you place 'conky_' in front of it
369 <option>lua_draw_hook_pre</option>
371 <option>function_name [function arguments]</option>
374 This function, if defined, will be called by
375 Conky through each iteration before drawing to the
376 window. Requires X support. Takes any number of
377 optional arguments. Use this hook for drawing things on
378 top of what Conky draws. Conky puts 'conky_' in front
379 of function_name to prevent accidental calls to the
380 wrong function unless you place 'conky_' in front of it
387 <option>lua_load</option>
390 <listitem>Loads the Lua scripts separated by spaces.
396 <option>lua_shutdown_hook</option>
398 <option>function_name [function arguments]</option>
401 This function, if defined, will be called by
402 Conky at shutdown or when the configuration is
403 reloaded. Use this hook to clean up after yourself,
404 such as freeing memory which has been allocated by
405 external libraries via Lua. Conky puts 'conky_' in
406 front of function_name to prevent accidental calls to
407 the wrong function unless you place 'conky_' in
408 front of it yourself.<para/>
414 <option>lua_startup_hook</option>
416 <option>function_name [function arguments]</option>
419 This function, if defined, will be called by
420 Conky at startup or when the configuration is reloaded.
421 Use this hook to initialize values, or for any run-once
422 applications. Conky puts 'conky_' in front of
423 function_name to prevent accidental calls to the wrong
424 function unless you place 'conky_' in front of
431 <option>mail_spool</option>
434 <listitem>Mail spool for mail checking
440 <option>max_port_monitor_connections</option>
443 <listitem>Allow each port monitor to track at most this
444 many connections (if 0 or not set, default is 256)
450 <option>max_specials</option>
453 <listitem>Maximum number of special things, e.g. fonts,
454 offsets, aligns, etc. (default is 512)
460 <option>max_text_width</option>
462 <option>width</option>
464 <listitem>When a line in the output contains 'width'
465 chars and the end isn't reached, the next char will start
466 on a new line. If you want to make sure that lines don't
467 get broken, set 'width' to 0
473 <option>max_user_text</option>
475 <option>bytes</option>
477 <listitem>Maximum size of user text buffer, i.e. layout
478 below TEXT line in config file (default is 16384 bytes)
484 <option>maximum_width</option>
486 <option>pixels</option>
488 <listitem>Maximum width of window
494 <option>minimum_size</option>
496 <option>width (height)</option>
498 <listitem>Minimum size of window
504 <option>mpd_host</option>
507 <listitem>Host of MPD server
513 <option>mpd_password</option>
516 <listitem>MPD server password
522 <option>mpd_port</option>
525 <listitem>Port of MPD server
531 <option>music_player_interval</option>
534 <listitem>Music player thread update interval (defaults to
535 Conky's update interval)
541 <option>net_avg_samples</option>
544 <listitem>The number of samples to average for net data
550 <option>no_buffers</option>
553 <listitem>Substract (file system) buffers from used memory?
560 <option>out_to_console</option>
563 <listitem>Print text to stdout.
569 <option>out_to_ncurses</option>
572 <listitem>Print text in the console, but use ncurses so
573 that conky can print the text of a new update over the old
574 text. (In the future this will provide more useful things)
580 <option>out_to_stderr</option>
583 <listitem>Print text to stderr.
589 <option>out_to_x</option>
592 <listitem>When set to no, there will be no output in X
593 (useful when you also use things like out_to_console). If
594 you set it to no, make sure that it's placed before all
595 other X-related setting (take the first line of your
596 configfile to be sure). Default value is yes
602 <option>override_utf8_locale</option>
605 <listitem>Force UTF8? requires XFT
611 <option>overwrite_file</option>
614 <listitem>Overwrite the file given as argument.
620 <option>own_window</option>
623 <listitem>Boolean, create own window to draw?
629 <option>own_window_class</option>
632 <listitem>Manually set the WM_CLASS name. Defaults to
639 <option>own_window_colour</option>
641 <option>colour</option>
643 <listitem>If own_window_transparent no, set a specified
644 background colour (defaults to black). Takes either a hex
645 value (e.g. ffffff, note the lack of '#') or a valid RGB
646 name (see /usr/lib/X11/rgb.txt)
652 <option>own_window_hints</option>
655 undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
657 <listitem>If own_window is yes, you may use these window
658 manager hints to affect the way Conky displays. Notes: Use
659 own_window_type desktop as another way to implement many of
660 these hints implicitly. If you use own_window_type
661 override, window manager hints have no meaning and are
668 <option>own_window_title</option>
671 <listitem>Manually set the window name. Defaults to
672 "<hostname> - conky".
678 <option>own_window_argb_visual</option>
681 <listitem>Boolean, use ARGB visual? ARGB can be used for real
682 transparency, note that a composite manager is required for real
683 transparency. This option will not work as desired (in most cases)
684 in conjunction with 'own_window_type override'.
690 <option>own_window_argb_value</option>
693 <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.
699 <option>own_window_transparent</option>
702 <listitem>Boolean, set transparency? If ARGB visual is enabled, sets
703 background opacity to 0%.
709 <option>own_window_type</option>
712 <listitem>if own_window is yes, you may specify type
713 normal, desktop, dock, panel or override (default: normal).
714 Desktop windows are special windows that have no window
715 decorations; are always visible on your desktop; do not
716 appear in your pager or taskbar; and are sticky across all
717 workspaces. Panel windows reserve space along a desktop
718 edge, just like panels and taskbars, preventing maximized
719 windows from overlapping them. The edge is chosen based on
720 the alignment option. Override windows are not under the
721 control of the window manager. Hints are ignored. This type
722 of window can be useful for certain situations.
728 <option>pad_percents</option>
731 <listitem>Pad percentages to this many decimals (0 = no
738 <option>pop3</option>
741 <listitem>Default global POP3 server. Arguments are: "host
742 user pass [-i interval (in seconds)] [-p port] [-e 'command']
743 [-r retries]". Default port is 110, default interval is 5
744 minutes, and default number of retries before giving up is
745 5. If the password is supplied as '*', you will be prompted
746 to enter the password when Conky starts.
752 <option>short_units</option>
755 <listitem>Shortens units to a single character (kiB->k,
756 GiB->G, etc.). Default is off.
762 <option>show_graph_range</option>
765 <listitem>Shows the time range covered by a graph.
771 <option>show_graph_scale</option>
774 <listitem>Shows the maximum value in scaled graphs.
780 <option>stippled_borders</option>
783 <listitem>Border stippling (dashing) in pixels
789 <option>temperature_unit</option>
792 <listitem>Desired output unit of all objects displaying a
793 temperature. Parameters are either "fahrenheit" or
794 "celsius". The default unit is degree Celsius.
800 <option>templateN</option>
803 <listitem>Define a template for later use inside TEXT
804 segments. Substitute N by a digit between 0 and 9,
805 inclusively. The value of the variable is being inserted
806 into the stuff below TEXT at the corresponding position,
807 but before some substitutions are applied:
809 <member>'\n' -> newline</member>
810 <member>'\\' -> backslash</member>
811 <member>'\ ' -> space</member>
812 <member>'\N' -> template argument N</member>
819 <option>text_buffer_size</option>
821 <option>bytes</option>
823 <listitem>Size of the standard text buffer (default is 256
824 bytes). This buffer is used for intermediary text, such as
825 individual lines, output from $exec vars, and various other
826 variables. Increasing the size of this buffer can
827 drastically reduce Conky's performance, but will allow for
828 more text display per variable. The size of this buffer
829 cannot be smaller than the default value of 256 bytes.
835 <option>times_in_seconds</option>
838 <listitem>If true, variables that output times output a number
839 that represents seconds. This doesn't affect $time, $tztime and
846 <option>top_cpu_separate</option>
849 <listitem>If true, cpu in top will show usage of one
850 processor's power. If false, cpu in top will show the usage
851 of all processors' power combined.
857 <option>top_name_width</option>
860 <listitem>Width for $top name value (defaults to 15
867 <option>total_run_times</option>
870 <listitem>Total number of times for Conky to update before
871 quitting. Zero makes Conky run forever
877 <option>update_interval</option>
879 <option>seconds</option>
881 <listitem>Update interval
887 <option>update_interval_on_battery</option>
889 <option>seconds</option>
891 <listitem>Update interval when running on batterypower
897 <option>uppercase</option>
900 <listitem>Boolean value, if true, text is rendered in upper
907 <option>use_spacer</option>
910 <listitem>Adds spaces around certain objects to stop them
911 from moving other things around. Arguments are left, right,
912 and none (default). The old true/false values are
913 deprecated and default to right/none respectively. Note
914 that this only helps if you are using a mono font, such as
915 Bitstream Vera Sans Mono.
921 <option>use_xft</option>
924 <listitem>Use Xft (anti-aliased font and stuff)
930 <option>xftalpha</option>
933 <listitem>Alpha of Xft font. Must be a value at or between
940 <option>xftfont</option>
943 <listitem>Xft font to use.