/usr/share/doc/kupfer/README.rst is in kupfer 0+v208-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | kupfer is a simple, flexible, launcher for Gnome
++++++++++++++++++++++++++++++++++++++++++++++++
:Homepage: http://kaizer.se/wiki/kupfer/
:Credits: Copyright 2007–2011 Ulrik Sverdrup <ulrik.sverdrup@gmail.com>
:Licence: GNU General Public License v3 (or any later version)
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.
Installing
==========
This project is configured for the Waf build system;
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``.
About Waf
---------
Waf is included in both the distributable tarball and the repository (so
that full source code is incuded. See the file `waf` for author and
licensing information).
Waf was acquired through http://waf.googlecode.com/files/waf-1.6.11.tar.bz2
on Saturday, 25 February 2012. The following files extracted::
./waf-light -> ./waf
./waflib -> ./waflib
./ChangeLog -> ./Waf.ChangeLog
./waflib/Tools/* some files excluded
./waflib/extras/* some files excluded
No file contents touched.
Build Requirements
------------------
* Python 2.6 or Python 3
* intltool
* optionally: rst2man (python-docutils) to install the manpage
* optionally: xml2po (gnome-doc-utils) to install mallard help pages
Runtime Requirements
--------------------
Kupfer requires Python 2.6 or later, and the following important libraries:
* gtk python bindings, GTK+ version 2.20 [#]_
* glib python bindings (pygobject) 2.18
* dbus python bindings
* python-xdg
.. [#] GTK+ 2.20 required for using full support. Kupfer is known to run with
version 2.18 as well.
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!
Spawning
========
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 Module
----------------
Keybinder_ is a module for global keyboard shortcuts that originates
from tomboy.
.. _`Keybinder`: http://kaizer.se/wiki/keybinder
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.
Documentation
=============
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.
.. vim: ft=rst tw=72
|