aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2020-10-31 14:26:22 +0100
committerPřemysl Eric Janouch <p@janouch.name>2020-10-31 16:06:13 +0100
commitcd7133e1735906d941f5f2ccc2faa083360841d6 (patch)
tree261737cbe9198f2d80a0e0354b6bbea6d666d2d2
parentb4ed52015ae12a9b421530b6a6c02730ba97c94b (diff)
downloadxK-cd7133e1735906d941f5f2ccc2faa083360841d6.tar.gz
xK-cd7133e1735906d941f5f2ccc2faa083360841d6.tar.xz
xK-cd7133e1735906d941f5f2ccc2faa083360841d6.zip
README.adoc: minor documentation update
-rw-r--r--README.adoc9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.adoc b/README.adoc
index a171e7f..6480231 100644
--- a/README.adoc
+++ b/README.adoc
@@ -103,6 +103,7 @@ Or you can try telling CMake to make a package for you. For Debian it is:
Usage
-----
'degesch' has in-program configuration. Just run it and read the instructions.
+Consult its link:degesch.adoc[man page] for details about the interface.
For the rest you might want to generate a configuration file:
@@ -124,7 +125,7 @@ as a `forking` type systemd user service.
Client Certificates
-------------------
-'kike' uses SHA1 fingerprints of TLS client certificates to authenticate users.
+'kike' uses SHA-1 fingerprints of TLS client certificates to authenticate users.
To get the fingerprint from a certificate file in the required form, use:
$ openssl x509 -in public.pem -outform DER | sha1sum
@@ -152,9 +153,9 @@ Beware that you can easily break the program if you're not careful.
How do I make degesch look like the screenshot?
-----------------------------------------------
First of all, you must build it with Lua support. With the defaults, degesch
-doesn't look very fancy because some things are rather hackish, and I also don't
-want to depend on UTF-8 or 256color terminals in the code. In addition to that,
-I appear to be one of the few people who use black on white terminals.
+doesn't look too fancy because I don't want to depend on Lua or 256-colour
+terminals. In addition to that, I appear to be one of the few people who use
+black on white terminals.
/set behaviour.date_change_line = "%a %e %b %Y"
/set behaviour.plugin_autoload += "fancy-prompt.lua"