Configuration settings
This is a listing of global configuration options for Conky. These are placed
in the conky.config
section of your configuration file, before conky.text
.
The default configuration file location is ~/.config/conky/conky.conf
or
${sysconfdir}/conky/conky.conf
. On most systems, $sysconfdir
is /etc
,
and you can find the sample config file there in
/etc/conky/conky.conf
.
You might want to copy the default config to ~/.config/conky/conky.conf
and
then start modifying it. User configs can be found at
https://github.com/brndnmtthws/conky/wiki/Configs.
Optional arguments are generally denoted with paretheses (i.e., (optional)
).
alignment
Aligned position on screen, may be none
or one of:
top_left (or tl ) |
top_middle (or tm ) |
top_right (or tr ) |
middle_left (or ml ) |
middle_middle (or mm ) |
middle_right (or mr ) |
bottom_left (or bl ) |
bottom_middle (or bm ) |
bottom_right (or br ) |
In case of panel
and dock
windows, it might make more sense to use one
of the following aliases:
Alias | Value |
---|---|
top |
top_middle |
left |
middle_left |
right |
middle_right |
bottom |
bottom_middle |
center |
middle_middle |
See also gap_x
and gap_y
settings.
default_graph_width
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. If you set out_to_console = true, 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.
0
github_token
Specify API token for GitHub notifications.
Create an API token at https://github.com/settings/tokens/new?scopes=notifications&description=conky.
imap
=
host
user
pass
-i interval (in seconds)
-f 'folder'
-p port
-e 'command'
-r retries
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.
lua_draw_hook_post
=
function_name
function arguments
This function, if defined, will be called by Conky through each iteration after drawing to the window. Requires X support. 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.
lua_draw_hook_pre
=
function_name
function arguments
This function, if defined, will be called by Conky through each iteration before drawing to the window. Requires X support. 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.
lua_mouse_hook
=
function_name
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.
lua_shutdown_hook
=
function_name
function arguments
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.
lua_startup_hook
=
function_name
function arguments
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.
own_window_hints
=
hint(,hint)*
If own_window
is set, on X11 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 ifown_window_type
is 'dock' or 'panel'.skip_taskbar
indicates that conky should not be included on a taskbar. Implied ifown_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 ifown_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.
own_window_type
=
(normal|desktop|dock|panel|utility|override)
If own_window
is set, under X11 you can specify type of window conky
displayed as:
normal
mode makes conky show as normal window. This mode can be configured with use ofown_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 includedesktop
windows for background, icons and desktop menu, in those cases it might be better to usenormal
or one of the below options, as those will cover conky when they're clicked on.dock
windows reserve space on the desktop, i.e. WMs will try their best to not place windows on top of them. They're the same asdesktop
in other respects, but render on top ofdesktop
windows.panel
windows are similar todock
windows, but they also reserve space along a desktop edge (like taskbars), preventing maximized windows from overlapping them. The edge is chosen based on thealignment
setting.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 likenormal
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 foroverride
windows.
To make conky mount on root window, set own_window
to false
.
normal
pop3
=
host
user
pass
-i interval (in seconds)
-p port
-e 'command'
-r retries
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.
templateN
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)
text_buffer_size
=
seconds
Size of the standard text buffer (default is 256 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.
use_spacer
Adds spaces around certain objects to stop them from moving other things around. Arguments are left, right, and none (default). 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.
none