[kupfer] kupfer.1.rst: reStructuredText man page
- From: Ulrik Sverdrup <usverdrup src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [kupfer] kupfer.1.rst: reStructuredText man page
- Date: Thu, 17 Sep 2009 19:23:40 +0000 (UTC)
commit f6464870e4ba858d3abf9973d205df074abaaae8
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date: Thu Sep 17 19:51:24 2009 +0200
kupfer.1.rst: reStructuredText man page
Rewrite the man page in reStructuredText, which can be generated to
man pages using ``rst2man``; producing a result almost
indistinguishable from the predecessor.
data/kupfer.1.rst | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 69 insertions(+), 0 deletions(-)
---
diff --git a/data/kupfer.1.rst b/data/kupfer.1.rst
new file mode 100644
index 0000000..a975c94
--- /dev/null
+++ b/data/kupfer.1.rst
@@ -0,0 +1,69 @@
+======
+kupfer
+======
+
+-----------------
+A simple launcher
+-----------------
+
+:Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
+:Date: 17 September 2009
+:Manual section: 1
+
+SYNOPSIS
+========
+
+``kupfer`` [ `OPTIONS` | `QUERY` ]
+
+DESCRIPTION
+===========
+
+Kupfer is a launcher. You do not primarily use it to search your files,
+you use it to summon the object you are thinking about.
+
+Kupfer is written using Python and has a flexible architecture. It can
+work with applications and files, recent documents and web browser
+bookmarks, and many more types of user data.
+
+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.
+
+SPAWNING
+========
+
+Running kupfer on the command line (without options) will try to summon
+it if already running.
+
+If the keybinder module is installed, kupfer will listen to a
+keybinding. By default the keybinding is ``<Control>space`` to focus
+kupfer.
+
+Kupfer can be invoked with a text query, with
+
+ ``kupfer`` `QUERY`
+
+OPTIONS
+=======
+
+--no-splash Launch without presenting main interface
+
+The following are generic options
+
+--help Display usage information and help on how to configure
+ kupfer, as well as a list of available plugins, then exit.
+
+--version Display version information and exit.
+
+--debug Enable more verbose output that can help understanding
+ program operation.
+
+CONFIGURATION
+=============
+
+Custom plugins are added to kupfer by installing them to the directory
+`~/.local/share/kupfer/plugins`, or any kupfer/plugins directory in any
+of ``$XDG_DATA_DIRS``.
+
+.. vim: ft=rst tw=72
+
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]