aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2016-09-28 05:50:03 +0200
committerPřemysl Janouch <p.janouch@gmail.com>2016-09-28 06:01:13 +0200
commit38b463c8833231e155c2a0b9ae741dac7a306e94 (patch)
tree7b6f1d75a697057112da656f7610776e963d2ea5 /README.adoc
parentb3458d84a06f6ca891f4ae3ae15d035817c83418 (diff)
downloadtdv-38b463c8833231e155c2a0b9ae741dac7a306e94.tar.gz
tdv-38b463c8833231e155c2a0b9ae741dac7a306e94.tar.xz
tdv-38b463c8833231e155c2a0b9ae741dac7a306e94.zip
Move the -w switch to the configuration file
Update README accordingly. Woo, I get to remove code.
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.adoc b/README.adoc
index 78f9103..77c6cfb 100644
--- a/README.adoc
+++ b/README.adoc
@@ -56,9 +56,7 @@ 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+.
+argument. It is however highly recommended to configure it, see below.
Extensions
----------
@@ -78,14 +76,28 @@ with the following. Note that it is intended for black-on-white terminals.
center-search = true
underline-last = false
hl-common-prefix = true
+watch-selection = true
[Colors]
header = reverse
+header-active = underline
search = ul
even = 16 231
odd = 16 255
....
+The `watch-selection` option makes the application watch the X11 primary
+selection for changes and automatically search for selected text.
+This feature requires GTK+ and it will never work on Wayland by its design.
+
+You can also set up some dictionaries to be loaded at startup automatically:
+
+....
+[Dictionaries]
+name1 = ~/path/to/dict.ifo
+name2 = ~/another/dict.ifo
+....
+
Dictionaries
------------
Unfortunately this application only really works with specific dictionaries.