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)
).
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_mouse_hook
=
function_name
This function, if defined, will be called by Conky upon receiving mouse events from X. Requires X support. 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 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_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_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
=
seconds
If own_window is yes, you may use these window manager hints to affect the way Conky displays. Notes: Use own_window_type desktop 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
if own_window is yes, you may specify type normal, desktop, dock, panel, utility or override. Desktop windows are special windows that have no window decorations; are always visible on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces. Utility windows are like desktop windows, except they appear above everything else rather than below. Panel windows reserve space along a desktop edge, just like panels and taskbars, preventing maximized windows from overlapping them. The edge is chosen based on the alignment option. Override windows are not under the control of the window manager. Hints are ignored. This type of window can be useful for certain situations.
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