.. role:: raw-ikiwiki(raw)
   :format: html

[[!meta title="kupfer, simple launcher"]]

**kupfer**, *a convenient command and access tool*

.. image:: ../kupfer/kupfer-2.png
   :alt: screenshot

Kupfer is a command tool heavily inspired by Quıcĸsılⅴεʀ_;
you do not use it to search your files, you use it to **summon**
the object you are thinking about right now.

Kupfer is written using Python and has a flexible
architecture.  Objects that it can access are implemented in **plugins**, and
new plugins can be written quickly.

The philosophy of Kupfer is **simplicity**. The implementation is simple, makes
the easy things work first, and does not overimplement unnecessary parts of
the program.

When you run ``kupfer``, it launches, then anytime you type Kupfer's
keybinding -- **immediately** its window is presented.

.. _Quıcĸsılⅴεʀ: http://www.blacktree.com/
.. _Gnome Do:    http://do.davebsd.com/


:raw-ikiwiki:`[[!toggle id=screenshots text="Show screenshots"]]`

.. raw:: html

    [[!toggleable id="screenshots" text="""

.. image:: ../kupfer/kupfer-1.png
   :alt: [screenshot] browsing available sources

.. image:: ../kupfer/kupfer-albums.png
   :alt: [screenshot] rhythmbox albums

.. raw:: html

    """]]
    [[!inline pages=kupfer/releases/* show=1 rss=no]]

|releases|_

.. |releases| replace:: Version history...

**Installation**

The installation from source [1]_ is simple and uses waf_; install Kupfer to
location ``$PREFIX`` by::

    ./waf configure --prefix=$PREFIX
    ./waf
    ./waf install

**Requirements**

Kupfer requires Python 2.5 or later, and Python modules ``gtk, gio, dbus``,
``xdg`` and ``wnck``. Intltool is required to build the package from source.
The module python-keybinder_ is strongly recommended.

(You *can* use Kupfer without the keybinder module
-- just assign a global shortcut to
``kupfer`` using existing means, `such as in metacity`__.)

__ http://www.codejacked.com/create-custom-keyboard-shortcuts-in-linux/

Plugins *may* need other modules to function.

**Kupfer tips**

1. By default, with the keybinder module installed, ``<Ctrl>space`` will
   summon the Kupfer window.

2. Included toplevel directories (by default home an desktop) are monitored
   so new files will be found immediately. Most plugins in Kupfer try to use
   the change notifications that are available from the system, to keep up
   to date with the instant.

3. Objects with content, like folders, are marked with an arrow. Right-arrow
   will enter these objects. Using ``alt``-rightarrow will show hidden files
   in directories.

4. In command mode, some keybindings are:

   * ``space`` to go to the next match
   * ``.`` to activate free-text mode
   * ``/`` to descend into an object with content
   * ``backspace`` to go back up

5. You can install custom plugins into ``~/.local/share/kupfer/plugins``;
   adding to Kupfer's object knowledge can be surprisingly easy, just look
   at the default plugins if you want to create new.

6. `Kupfer Wiki pages`_ contain more information.

* **file bug reports** in `Kupfer project at launchpad.net`__
* **source repository** is at `http://git.gnome.org/cgit/kupfer/`__
* **kupfer mailing list** is `kupfer-list`__

__ http://launchpad.net/kupfer
__ http://git.gnome.org/cgit/kupfer/
__ http://mail.gnome.org/mailman/listinfo/kupfer-list

.. _`Kupfer Wiki pages`: http://live.gnome.org/Kupfer
.. _waf: http://code.google.com/p/waf/

.. [1] Kupfer is also available in the distribution repositories for Debian,
       Ubuntu Karmic and Archlinux (AUR).