Screen alignment. May be none or one of:

For panel and dock windows, it may be more useful to use one of the following aliases:

See also gap_x and gap_y settings.

Append the file given as an argument.

Boolean value. If true, Conky will fork into the background when started.

Inner border margin in pixels (the margin between the border and text).

Outer border margin in pixels (the margin between the border and the edge of the window).

Border width in pixels.

Predefine a color for use inside conky.text segments. Replace N with a digit between 0 and 9, inclusive. When specifying the color value in hex, omit the leading #.

A character to fill the console bars.

A character to unfill the console bars.

A comma-separated list of strings to use as the bars in a graph rendered to the console or shell. The first list item is used for the minimum bar height and the last item is used for the maximum, for example ",_,=,#".

The number of samples to average for CPU monitoring.

Specify a default height for bars.

Specify a default width for bars. If not specified, the default value is 0, which causes the bar to expand to fit the width of your Conky window. With a text-only backend (e.g. output_backend = 'console') the default value will be 10 for the text version of the bar.

Default text color and border color.

Specify a default height for gauges.

Specify a default width for gauges.

Specify a default height for graphs.

Specify a default width for graphs. If not specified, the default value is 0, which causes the graph to expand to fit the width of your Conky window. With a text-only backend (e.g. output_backend = 'console') the text version of the graph will actually have no width and you will need to set a sensible default or set the height and width of each graph individually.

Default outline color.

Default shading color and border's shading color.

One or more batteries to check in order to use update_interval_on_battery (comma separated).

Enable to disable the inotify-based auto config reload feature.

The number of samples to average for disk I/O monitoring.

Specify an X display to connect to.

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.

Boolean, blend when rendering drawn image? Some images blend incorrectly breaking alpha with ARBG visuals. This provides a possible work around by disabling blending.

Draw borders around text.

Draw borders around graphs.

Draw outlines.

Draw shades.

Put an extra newline at the end when writing to stdout (output_backend = 'console'), useful for writing to awesome's wiboxes.

Font name in X, xfontsel can be used to get a nice font.

Predefine a font to be used in conky.text segments. Substitute N by a number between 0 and 9 inclusive. Use the same format as a font variable.

Boolean value, if true, Conky will redraw everything when you switch the workspace. This may cause delays/flickering on some WMs.

If enabled, values which are in bytes will be printed in human readable format (i.e., KiB, MiB, etc). If disabled, the number of bytes is printed instead.

Gap, in pixels, between right or left border of screen, same as passing -x at command line, e.g. gap_x 10. For other position related stuff, see alignment.

Gap, in pixels, between top or bottom border of screen, same as passing -y at command line, e.g. gap_y 10. For other position related stuff, see alignment.

Specify API token for GitHub notifications.

Create an API token at https://github.com/settings/tokens/new?scopes=notifications&description=conky.

Changes the color space used for interpolation. Arguments are hcl, hsv, and rgb (default).

Hostname to connect to for hddtemp objects.

Port to use for hddtemp connections.

Port to listen to for HTTP connections. Default value is 10080, but is blocked by Firefox and Chrome, so you really want to change it.

When this is set the page generated with the http backend (output_backend) will automatically refresh each interval.

How strict should if_up be when testing an interface for being up? The value is one of up (default), 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.

Default global IMAP server. 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.

Interval (in seconds) to flush Imlib2 cache.

Imlib2 image cache size, in bytes. Increase this value if you use $image lots. Set to 0 to disable the image cache.

Boolean value, if true, text is rendered in lower case.

This function, if defined, will be called by Conky through each iteration after drawing to the window. Requires a graphical output (X11 or Wayland). Takes any number of optional arguments. Use this hook for drawing things on top of what Conky draws. Conky puts 'conky_' in front of function_name to prevent accidental calls to the wrong function unless you place 'conky_' in front of it yourself. Use conky_surface() inside the hook to obtain the current drawing surface.

This function, if defined, will be called by Conky through each iteration before drawing to the window. Requires a graphical output (X11 or Wayland). Takes any number of optional arguments. Use this hook for drawing things on top of what Conky draws. Conky puts 'conky_' in front of function_name to prevent accidental calls to the wrong function unless you place 'conky_' in front of it yourself. Use conky_surface() inside the hook to obtain the current drawing surface.

List of Lua script paths to load at startup in order to provide Lua functions for other hooks. Listed files are loaded (executed) before 'lua_startup_hook' and can (but shouldn't) run code in global scope.

Paths are ';' (semicolon) separated, and can be relative to the config file path, or absolute.

The paths were previously ' ' (space) separated, this functionality is still supported if ';' isn't found, but is deprecated and will be removed in future versions. Empty paths are skipped so './example file.lua;' is valid.

This function, if defined, will be called by Conky upon receiving mouse events from X or Wayland. A table containing event information will be passed to this function as the first argument. Use this hook for detecting mouse input and acting on it. Conky requires that the function declaration has a 'conky_' prefix to prevent accidental calls to the wrong function.

This function, if defined, will be called by Conky at shutdown or when the configuration is reloaded. Use this hook to clean up after yourself, such as freeing memory which has been allocated by external libraries via Lua. Conky puts 'conky_' in front of function_name to prevent accidental calls to the wrong function unless you place 'conky_' in front of it yourself.

This function, if defined, will be called by Conky at startup or when the configuration is reloaded. Use this hook to initialize values, or for any run-once applications. Conky puts 'conky_' in front of function_name to prevent accidental calls to the wrong function unless you place 'conky_' in front of it yourself.

Mail spool for mail checking.

Allow each port monitor to track at most this many connections.

When a line in the output contains 'width' chars and the end isn't reached, the next char will start on a new line. If you want to make sure that lines don't get broken, set 'width' to 0.

Maximum size of user text buffer in bytes, i.e. text inside conky.text section in config file.

Maximum width of window.

Minimum height of the window.

Minimum width of window.

Host of MPD server.

MPD server password.

Port of MPD server.

Music player thread update interval.

MySQL database to use.

Host of MySQL server

Password of the MySQL user. Place it between "-chars. When this is not set there is no password used.

Port of MySQL server.

MySQL user name to use when connecting to the server. Defaults to your username.

The number of samples to average for net data.

Subtract (file system) buffers from used memory.

The display that the nvidia variable will used.

Replaced by output_backend; set output_backend = 'console' to print text to stdout.

Replaced by output_backend; set output_backend = 'http' to serve text over HTTP.

Replaced by output_backend; set output_backend = 'ncurses' to render in the terminal with ncurses.

Print text to stderr.

Replaced by output_backend; set output_backend = 'wayland' to open a Wayland window.

Replaced by output_backend; add or remove 'x11' from output_backend to control the X11 window.

Selects which display backend(s) Conky uses to present its output. Accepts either a single backend name or a list of names:

output_backend = 'wayland'
output_backend = { 'x11', 'http' }

Valid backends are x11, wayland, ncurses, http, console, and file; availability of each depends on compile-time options.

Only one primary backend (x11, wayland, or ncurses) is active at a time. When several are requested, Conky keeps the one best suited to the current session: wayland under a Wayland compositor, x11 under X11 or XWayland. The non-primary backends http, console (stdout), and file may be combined freely with a primary backend.

When unset, Conky infers a sensible backend from the session environment.

This replaces the deprecated out_to_x, out_to_wayland, out_to_ncurses, out_to_http, and out_to_console settings, which remain accepted for backwards compatibility.

Force UTF8. Requires XFT.

Overwrite the file given as argument.

Boolean, draw conky in own window instead of drawing on root window.

Replaced by own_window_color; encode the background opacity in its alpha channel instead (e.g. '#8000' for ~50% opacity).

Manually set the WM_CLASS name.

Set the background colour of the window. Takes a hex value with optional alpha (e.g. '#fff', '#8000', '#8fff'), or a valid RGB name (see /usr/lib/X11/rgb.txt).

The alpha channel controls background opacity. For example, '#0000' is fully transparent and '#f000' is fully opaque black. An 8-digit value uses the #AARRGGBB form (alpha first), e.g. '#E6000000' for ~90% opaque black. Note this differs from the CSS #RRGGBBAA order; writing '#000000E6' would set alpha to 0. Semi-transparent backgrounds require a compositor on X11.

If own_window is set, you may specify comma separated window manager hints to affect the way Conky displays.

Following hints are some of the standard WM specification ones:

• above indicates that conky should be on top of most windows.
• below indicates that conky should be below most windows.
• skip_pager indicates that conky should not be included on a Pager. Implied if own_window_type is 'dock' or 'panel'.
• skip_taskbar indicates that conky should not be included on a taskbar. Implied if own_window_type is 'dock' or 'panel'.
• sticky indicates that the Window Manager SHOULD keep conky's position fixed on the screen, even when the virtual desktop scrolls.
• undecorated indicates that conky shouldn't have any window decorations (e.g. title bar). Implied if own_window_type is 'dock' or 'panel'.

Notes:

• Use own_window_type='desktop' setting as another way to implement many of these hints implicitly.
• If you use own_window_type='override', window manager hints have no meaning and are ignored.
• Under Wayland these hints are translated to a wlr-layer-shell placement (the compositor must support that protocol). A normal or utility window that would otherwise be a regular toplevel is instead mounted as a layer surface when any of below, above or sticky is set: below/above pick the bottom/top layer, while sticky (shown across all workspaces), skip_taskbar and skip_pager are intrinsic to layer surfaces. undecorated is implicit since layer surfaces are never decorated.

Set the wlr-layer-shell namespace of the Wayland window. Compositors such as KWin classify the surface from this (lowercased); KWin recognizes 'desktop', 'dock', 'notification', 'tooltip', 'on-screen-display', 'dialog', 'splash' and 'utility'. Other values are treated as a normal window. When unset, 'conky' is used. To keep conky visible during Show Desktop while staying above the wallpaper, set this to 'desktop' and keep own_window_type at 'normal'. On KDE Plasma, 'dock' is elevated by the slide effect (shouldElevate() in slide.cpp) while switching virtual desktops, so 'desktop' keeps conky in the background throughout.

Allows overriding conky window name.

Replaced by own_window_color; use a fully transparent value (alpha 0, e.g. '#0000') for the same effect.

Specifies the type of window conky is displayed as. Under X11 this requires own_window to be set; under Wayland it selects the wlr-layer-shell layer the surface is mounted on (and, for dock/panel, whether it reserves screen space via an exclusive zone). Available types:

• normal mode makes conky show as normal window. This mode can be configured with use of own_window_hints setting.
• desktop windows are special windows that have no window decorations, are always visible on the desktop, do not appear in pager or taskbar, and are sticky across all workspaces. Many DEs include desktop windows for background, icons and desktop menu, in those cases it might be better to use normal or one of the below options, as those will cover conky when they're clicked on.
• dock windows are placed on screen edges. They're the same as desktop in most respects, but render on top of desktop windows and below normal ones. Conky doesn't define struts for this window type, but some WMs might still implicitly avoid placing windows on top of it.
• panel windows are similar to dock windows, but they also reserve space along a workarea edge (like taskbars), preventing maximized windows from overlapping them. The edge is chosen based on final conky position and size, and workarea dimensions, to ensure normal windows have most free space available. For WMs that "cut out" entirely covered screens from reserved area, the edge will be chosen based on alignment setting. Under Wayland the reserved edge is always derived from alignment; a fully centered (mm) alignment has no edge to reserve against, so use an edge-aligned value (e.g. tm, bm, ml, mr).
• utility windows are persistent utility windows (e.g. a palette or toolbox). They appear on top of other windows (in the same group), but otherwise behave much like normal windows.
• override windows are drawn directly on root window (desktop background) and are not under the control of the window manager. These will not work with DEs which draw desktop icons via custom panels/windows as those will cover conky. own_window_hints are ignored for override windows. Semi-transparent backgrounds do not work with override windows because compositors typically do not composite override-redirect windows. Full transparency (alpha 0) may work via pseudo-transparency.

To make conky mount on root window, set own_window to false.

Minimum field width for percentage values when use_spacer is left or right. Values are still printed as whole numbers (%u); there are no fractional decimals. When spacer alignment is enabled, width is at least 3 so that 1/10/100 align. 0 means no extra width beyond that minimum (or no padding at all when use_spacer is none).

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.

Shortens units to a single character (kiB->k, GiB->G, etc.).

Shows the time range covered by a graph.

Shows the maximum value in scaled graphs.

Border stippling (dashing) in pixels.

Desired output unit of all objects displaying a temperature. Parameters are either fahrenheit or celsius.

Define a template for later use inside conky.text segments. Substitute N by a digit between 0 and 9, inclusively. The value of the variable is being inserted into the stuff inside conky.text at the corresponding position, but before some substitutions are applied:

• \\n -> newline
• \\ -> backslash
• \\ -> space
• \\N -> template argument N (starting from 1)

Alpha (opacity) of rendered text on graphical outputs (X11 with Xft, and Wayland). Must be a value at or between 0 and 1.

Only controls opacity of the first font (font0).

Replaces the backend-specific xftalpha (X11) and textalpha (Wayland) settings, which are still accepted as deprecated aliases.

Size of the standard text buffer in 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.

Replaced by text_alpha; it unifies the old Wayland textalpha and X11 xftalpha settings.

If true, variables that output times output a number that represents seconds. This doesn't affect $time, $tztime and $utime.

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.

If true, top name shows the full command line of each process, including arguments (whenever possible). Otherwise, only the basename is displayed.

Width for $top name value in characters.

Total number of times for Conky to update before quitting. Zero makes Conky run forever.

String to place between values and units.

Update interval.

Update interval when running on battery power.

Boolean value, if true, text is rendered in upper case.

Adds spaces around certain objects to stop them from moving other things around. May be none (default) or left or right. 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.

Use Xft (anti-aliased font and stuff).

Replaced by text_alpha; it unifies the old X11 xftalpha and Wayland textalpha settings.

Specify a Xinerama head.

ARGB is now always enabled when available. Control background opacity with own_window_color (e.g. '#8000').

Graph data is now always stored directly in the node; this setting has no effect.