aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--LICENSE2
-rw-r--r--README44
-rw-r--r--docs/sdtui.1.xml7
-rw-r--r--src/sdtui.c4
4 files changed, 51 insertions, 6 deletions
diff --git a/LICENSE b/LICENSE
index 6f18de6..f4c62e7 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,4 +1,4 @@
- Copyright (c) 2013, Přemysl Janouch <p.janouch@gmail.com>
+ Copyright (c) 2013 - 2015, Přemysl Janouch <p.janouch@gmail.com>
All rights reserved.
Permission to use, copy, modify, and/or distribute this software for any
diff --git a/README b/README
index 1c0e5aa..0949359 100644
--- a/README
+++ b/README
@@ -1,4 +1,5 @@
StarDict terminal UI
+====================
This program aims to provide an easy way of viewing translation and other kinds
of dictionaries in your terminal. The author wasn't successful in finding any
@@ -11,7 +12,44 @@ software under a more permissive license than your usual GNU General Public
License. I'll buy you a beer for shouting obscenities at the address of RMS in
public; I couldn't reuse _anything_.
-So far it has only been tested under Ubuntu Linux and some work has to be done
-yet until the software can be considered fit to be included in regular Linux and
-BSD distributions. Help is much appreciated in this regard.
+Some work has to be done yet before the software can be considered fit for
+inclusion in regular Linux and BSD distributions. Help is much appreciated in
+this regard.
+Building and Running
+--------------------
+Build dependencies: CMake, pkg-config, xsltproc, ncursesw, zlib, glib-2.0,
+ pango, termo (included), gtk+ (optional, any version)
+
+ $ git clone https://github.com/pjanouch/sdtui.git
+ $ git submodule init
+ $ git submodule update
+ $ mkdir build
+ $ cd build
+ $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug -DWITH_GTK=ON
+ $ make
+
+To install the application, you can do either the usual:
+ $ make install
+
+Or you can try telling CMake to make a package for you. For Debian it is:
+ $ cpack -G DEB
+ # dpkg -i sdtui-*.deb
+
+Note that for versions of CMake before 2.8.9, you need to prefix cpack with
+`fakeroot' or file ownership will end up wrong.
+
+Having the program installed, simply run it with a StarDict .ifo file as an
+argument. If you want the application to watch the X11 primary selection for
+changes and automatically search for the selected text, use the -w switch.
+This feature requires GTK+.
+
+License
+-------
+`sdtui' is written by Přemysl Janouch <p.janouch@gmail.com>.
+
+You may use the software under the terms of the ISC license, the text of which
+is included within the package, or, at your option, you may relicense the work
+under the MIT or the Modified BSD License, as listed at the following site:
+
+http://www.gnu.org/licenses/license-list.html
diff --git a/docs/sdtui.1.xml b/docs/sdtui.1.xml
index c0ed3ec..279eed0 100644
--- a/docs/sdtui.1.xml
+++ b/docs/sdtui.1.xml
@@ -46,6 +46,13 @@ preset search paths on startup.</para>
<refsect1><title>Options</title>
<variablelist>
<varlistentry>
+ <term><option>-w</option>, <option>--watch-primary-selection=TIMER</option></term>
+ <listitem><para>
+ watch the value of the primary selection for input
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-h</option>, <option>--help</option></term>
<listitem><para>
show help options
diff --git a/src/sdtui.c b/src/sdtui.c
index f6591e9..4961928 100644
--- a/src/sdtui.c
+++ b/src/sdtui.c
@@ -1,7 +1,7 @@
/*
* StarDict terminal UI
*
- * Copyright (c) 2013 - 2014, Přemysl Janouch <p.janouch@gmail.com>
+ * Copyright (c) 2013 - 2015, Přemysl Janouch <p.janouch@gmail.com>
* All rights reserved.
*
* Permission to use, copy, modify, and/or distribute this software for any
@@ -491,7 +491,7 @@ app_show_help (Application *self)
{
PROJECT_NAME " " PROJECT_VERSION,
_("Terminal UI for StarDict dictionaries"),
- "Copyright (c) 2013 - 2014, Přemysl Janouch",
+ "Copyright (c) 2013 - 2015, Přemysl Janouch",
"",
_("Type to search")
};