Configuration¶

luakits configuration is spread across several files loaded from several different directories.

By default, luakit will search the following folders (in that order) for any Lua files:

• ./config/ (if you have compiled luakit with -DDEVELOPMENT_PATHS)
• $XDG_CONFIG_HOME/luakit/ or ~/.config/luakit
• $XDG_CONFIG_DIRS/luakit/ (this is actually an array of directories, each will be searched)
• your luakit install path's lib directory, e.g. /usr/share/luakit/lib

Config Files¶

luakits main configuration file is called rc.lua. It is invoked first and will require all other configuration files.
You can easily adjust most behaviour of luakit by copying the system-wide rc.lua to your user config folder and changing options in between the different require invocations. This saves you the trouble of keeping copies of all config files in your user config folder.

config folder¶

The files in this folder are core luakit files that set up the basic looks and behaviour of luakit.

• binds.lua contains keyboard and mouse binds
• globals.lua contains global settings
• modes.lua contains definitions of the different modes (e.g. insert mode, command mode, normal mode, ...)
• theme.lua contains color theme definitions
• webview.lua sets up any new webview (that's webkits browsing windows)
• window.lua sets up any now luakit window

lib folder¶

The contents of this folder vary from time to time as new optional libraries are added and old ones removed. Here is a list of some important ones:

• bookmarks.lua adds bookmarks to luakit
• chrome.lua helper library for chrome:// pages (e.g. bookmarks, downloads)
• cmdhist.lua adds history to the command mode
• completion.lua adds command completion to command mode
• cookies.lua adds support for cookies
• downloads_chrome.lua adds the chrome://downloads page
• downloads.lua adds support for downloads
• follow.lua adds the follow mode
• follow_selected.lua catches Return key presses to follow the selected page element
• formfiller.lua auto-fills forms for you (e.g. usernames etc.)
• go_input.lua adds the gi bind that focuses an input element
• go_next_prev.lua and go_up.lua add easy navigation along the URI
• history_chrome.lua adds the chrome://history page
• history.lua adds a browser history
• the lousy directory contains a lot of very basic helper functions
• proxy.lua adds dynamic proxy settings
• quickmarks.lua adds quickmarks like in vimperator
• search.lua lets you search the current page
• session.lua lets you save your current tabs across browser sessions
• tabhistory.lua adds a menu containing the history of the current tab
• taborder.lua orders your tabs more nicely
• undoclose.lua lets you reopen closed tabs
• userscripts.lua adds support for Userscripts