luakit is a fast, light and simple to use micro-browser framework extensible by Lua using the WebKit web content engine and the GTK+ toolkit.
You don't have to be a developer to use luakit on a daily basis. If you are familiar with vimperator, pentadactyl, jumanji, uzbl & etc you will find luakit behaves similarly out of the box.
To compile the stock luakit run:
make
To link against LuaJIT (if you have LuaJIT installed) run:
make USE_LUAJIT=1
To build with a custom compiler run:
make CC=clang
Note to packagers: you may wish to build luakit with:
make DEVELOPMENT_PATHS=0
To prevent luakit searching in relative paths (./config
& ./lib
) for
user configs.
The USE_LUAJIT=1
, PREFIX=/path
, DEVELOPMENT_PATHS=0
, CC=clang
build options do not conflict. You can use whichever you desire.
To install luakit run:
sudo make install
The luakit binary will be installed at:
/usr/local/bin/luakit
And configs to:
/etc/xdg/luakit/
And the luakit libraries to:
/usr/local/share/luakit/lib/
To change the install prefix you will need to re-compile luakit (after a
make clean
) with the following option:
make PREFIX=/usr
sudo make PREFIX=/usr install
Just run:
luakit [URI..]
Or to see the full list of luakit launch options run:
luakit -h
The configuration options are endless, the entire browser is constructed by
the config files present in /etc/xdg/luakit
There are several files of interest:
:quit
, :restart
, :open
, :lua <code>
, etc).w:new_tab(uri)
,
w:close_tab()
, w:close_win()
, etc).w:reload()
,
w:eval_js("code here..")
, w:back()
, w:forward()
).Just copy the files you wish to change (and the rc.lua) into
$XDG_CONFIG_HOME/luakit
(defaults to ~/.config/luakit/
) and luakit will
use those files when you next launch it.
To delete luakit from your system run:
sudo make uninstall
If you installed with a custom prefix remember to add the identical prefix here also, example:
sudo make PREFIX=/usr uninstall
Please use the bug tracker at:
https://github.com/luakit/luakit/issues
Join us in #luakit
on the irc.oftc.net
network.