Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 79 lines (53 sloc) 2.126 kb
5748f8a engla README: Update with more detailed instructions
engla authored
1 kupfer is a simple, flexible, launcher for Gnome
37620a6 engla README: Write as more stringent RestructuredText
engla authored
2 ++++++++++++++++++++++++++++++++++++++++++++++++
07e4cfd engla Add some documentation files: TODO and README
engla authored
3
37620a6 engla README: Write as more stringent RestructuredText
engla authored
4 :Homepage: http://kaizer.se/wiki/kupfer/
5 :Credits: Copyright 2007--2009 Ulrik Sverdrup <ulrik.sverdrup@gmail.com>
6 :Licence: GNU General Public License v3 (or any later version)
593f84a engla README: Add instructions for waf
engla authored
7
37620a6 engla README: Write as more stringent RestructuredText
engla authored
8 Installing
593f84a engla README: Add instructions for waf
engla authored
9 ==========
10ad57a engla README: Adjust formatting
engla authored
10
11 This project is configured for waf; waf is shipped in the distributable
12 tarball but not in the repository. If you need to get waf, run::
593f84a engla README: Add instructions for waf
engla authored
13
14952ef engla README: Point URL to waf-1.5.8
engla authored
14 wget -O waf http://waf.googlecode.com/files/waf-1.5.8
593f84a engla README: Add instructions for waf
engla authored
15 chmod +x waf
16
37620a6 engla README: Write as more stringent RestructuredText
engla authored
17 Installation follows the steps::
6da4f9d engla README: Clarify install instructions by minor bit
engla authored
18
ecfa15f engla README: update install instructions
engla authored
19 ./waf configure
6da4f9d engla README: Clarify install instructions by minor bit
engla authored
20 ./waf
21
37620a6 engla README: Write as more stringent RestructuredText
engla authored
22 then::
23
593f84a engla README: Add instructions for waf
engla authored
24 ./waf install
5748f8a engla README: Update with more detailed instructions
engla authored
25
37620a6 engla README: Write as more stringent RestructuredText
engla authored
26 or ::
27
6da4f9d engla README: Clarify install instructions by minor bit
engla authored
28 sudo ./waf install
29
ecfa15f engla README: update install instructions
engla authored
30 You can use ``--prefix=$PREFIX`` when configuring to assign an
31 installation spot. By default, Kupfer is installed for all users.
32 Installing only for your user, the prefix ``~/.local`` is often used;
33 you just have to check that: ``~/.local/bin`` is in your ``$PATH``.
5748f8a engla README: Update with more detailed instructions
engla authored
34
dd41d28 engla Add list of dependencies/requirements to README
engla authored
35 Requirements
36 ------------
37
38 Kupfer requires Python 2.5 or later, and the following important libraries:
39
40 * gtk python bindings, version 2.14
41 * glib python bindings (pygobject) 2.18
42 * dbus python bindings
43
44 Optional, but very recommended dependencies:
45
46 * python-keybinder (see below)
47 * wnck python bindings
48 * gvfs
49 * xdg-terminal (to find which terminal application you use, if it's not
50 Gnome Terminal)
51 * cjson (only req for Python 2.5, not 2.6), for web browser bookmarks
52 * rst2man
53
54 Some plugins might require additional python modules!
55
37620a6 engla README: Write as more stringent RestructuredText
engla authored
56 Spawning
5748f8a engla README: Update with more detailed instructions
engla authored
57 ========
ecfa15f engla README: update install instructions
engla authored
58
37620a6 engla README: Write as more stringent RestructuredText
engla authored
59 Kupfer is installed as ``kupfer`` into ``$PREFIX/bin``.
5748f8a engla README: Update with more detailed instructions
engla authored
60
37620a6 engla README: Write as more stringent RestructuredText
engla authored
61 Keybinder Module
5421737 engla README: python-keybinder information
engla authored
62 ----------------
5748f8a engla README: Update with more detailed instructions
engla authored
63
10ad57a engla README: Adjust formatting
engla authored
64 Kupfer uses tomboy's keybinder code, just like many other applications
65 do for global keybindings. I had to break out the python wrapping of
66 the code into a standalone python module `keybinder`_ that you need to
67 install first.
5421737 engla README: python-keybinder information
engla authored
68
37620a6 engla README: Write as more stringent RestructuredText
engla authored
69 .. _`keybinder`: http://kaizer.se/wiki/python-keybinder
5421737 engla README: python-keybinder information
engla authored
70
10ad57a engla README: Adjust formatting
engla authored
71 Now you can set kupfer's keybinding by editing kupfer's config. See
72 ``kupfer --help`` for how to do that.
73
74 You can use kupfer without the keybinder module, for example by
75 assigning a global keybinding to the ``kupfer`` binary, but it not the
76 recommended way.
5421737 engla README: python-keybinder information
engla authored
77
10ad57a engla README: Adjust formatting
engla authored
78 .. vim: ft=rst tw=72
Something went wrong with that request. Please try again.