Kupfer is an interface for quick and convenient access to applications and their documents.

The most typical use is to find a specific application and launch it. We have tried to make Kupfer easy to extend with plugins so that this quick-access paradigm can be extended to many more objects than just applications.

This project is configured for the waf build system; waf is shipped in the distributable tarball but not in the repository. If you need to get waf, run:

wget -O waf http://waf.googlecode.com/files/waf-1.6.3
chmod +x waf

Installation follows the steps:

./waf configure
./waf

then:

./waf install

or

sudo ./waf install

You can use --prefix=$PREFIX when configuring to assign an installation spot. By default, Kupfer is installed for all users. Installing only for your user, the prefix ~/.local is often used; you just have to make sure that ~/.local/bin is in your $PATH.

• Python 2.6 or Python 3
• waf (see above)
• intltool
• optionally: rst2man (python-docutils) to install the manpage
• optionally: xml2po (gnome-doc-utils) to install mallard help pages

Kupfer requires Python 2.6 or later, and the following important libraries:

• gtk python bindings, GTK+ version 2.20 [1]
• glib python bindings (pygobject) 2.18
• dbus python bindings
• python-xdg

Optional, but very recommended runtime dependencies:

• python-keybinder (see below)
• wnck python bindings
• gvfs
• keyring python module

Opportunistic dependencies

• The deprecated 'gnome' module is used for session connection as fallback
• If available, 'setproctitle' is used to set the process name
• python-appindicator for ubuntu-style notification icon
• nautilus-python for nautilus selected file
• python-gdata for Google plugins

Some plugins will require additional python modules!

The program is installed as kupfer into $PREFIX/bin. Only one instance can be active for one user at a given time. Normal use of kupfer requires an active dbus session bus.

Keybinder is a module for global keyboard shortcuts that originates from tomboy.

You can use kupfer without the keybinder module, for example by assigning a global keybinding to the kupfer binary, but it not the recommended way.

Please read Documentation/ and Documentation/Manpage.rst for technical documentation. User documentation is installed as GNOME (Mallard) help pages, available under the "Kupfer Help" object in the program itself.