summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2016-03-10 20:25:06 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2016-03-10 20:25:06 +0100
commitd70f156a201249053b19b339a95c4c5b55387ad2 (patch)
tree135d6e493f6ff7798341c331e8ca8b8d2cddff62 /README.adoc
parent42d88f87f554c7133193972e0b6b92e9a9537c88 (diff)
downloadxK-d70f156a201249053b19b339a95c4c5b55387ad2.tar.gz
xK-d70f156a201249053b19b339a95c4c5b55387ad2.tar.xz
xK-d70f156a201249053b19b339a95c4c5b55387ad2.zip
Update README
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc31
1 files changed, 29 insertions, 2 deletions
diff --git a/README.adoc b/README.adoc
index 25b7a16..4a303db 100644
--- a/README.adoc
+++ b/README.adoc
@@ -63,6 +63,15 @@ the rest of the package.
It survives crashes, server disconnects and timeouts, and also has native SOCKS
support (even though socksify can add that easily to any program).
+Packages
+--------
+Regular releases are sporadic. git master should be stable enough. You can get
+a package with the latest development version from Archlinux's AUR, or from
+openSUSE Build Service for the rest of mainstream distributions. Consult the
+list of repositories and their respective links at:
+
+https://build.opensuse.org/project/repositories/home:pjanouch:git
+
Building
--------
Build dependencies: CMake, pkg-config, help2man, awk, sh, liberty (included) +
@@ -89,8 +98,8 @@ Or you can try telling CMake to make a package for you. For Debian it is:
Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
`fakeroot` or file ownership will end up wrong.
-Running
--------
+Usage
+-----
'degesch' has in-program configuration. Just run it and read the instructions.
For the rest you might want to generate a configuration file:
@@ -118,6 +127,24 @@ To get the fingerprint from a certificate file in the required form, use:
$ openssl x509 -in public.pem -outform DER | sha1sum
+Custom Key Bindings in degesch
+------------------------------
+The default and preferred frontend used in 'degesch' is GNU Readline. This
+means that you can change your bindings by editing '~/.inputrc'. For example:
+
+ # Preload with system-wide settings
+ $include /etc/inputrc
+
+ # Make M-left and M-right reorder buffers
+ $if degesch
+ "\e\e[C": move-buffer-right
+ "\e\e[D": move-buffer-left
+ $endif
+
+Consult the source code and the GNU Readline manual for a list of available
+functions. Also refer to the latter for the exact syntax of this file.
+Just beware that you can easily break the program if you're not careful.
+
Contributing and Support
------------------------
Use this project's GitHub to report any bugs, request features, or submit pull