about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-08-31 17:12:35 +0530
committerAndinus <andinus@nand.sh>2020-08-31 17:12:35 +0530
commitfa370dd17abfeb7d5322cd704d5c8b8416d608cb (patch)
tree14bb5d31d4eff6839cae9daa6c70db31c28c1206
parent4648948ddb3cc0a3f046df50cccfe74a2da2e6d1 (diff)
downloadleo-fa370dd17abfeb7d5322cd704d5c8b8416d608cb.tar.gz
Document new configuration in README
-rw-r--r--README22
1 files changed, 22 insertions, 0 deletions
diff --git a/README b/README
index a0ee021..594352a 100644
--- a/README
+++ b/README
@@ -14,6 +14,7 @@ Table of Contents
 ..... 1.2.1 encrypt/sign
 ..... 1.2.2 delete
 ..... 1.2.3 help
+.. 1.3 Configuration
 2 Example
 3 History
 
@@ -91,6 +92,27 @@ pre-defined list. It can encrypt/sign files with gpg2(1).
   Running just `leo' will print help.
 
 
+1.3 Configuration
+─────────────────
+
+  There is an example config file under `share/config.pl', move it to
+  config directory & rename to `leo.pl'.
+
+  ┌────
+  │ cp share/config.pl $HOME/.config/leo.pl # Copy the config.
+  │ chmod -w $HOME/.config/leo.pl # Make it read-only.
+  └────
+
+  *Warning*: Leo will evaluate the configuration file, which means an
+  attacker can use it to run malicious code.
+
+  *Note*: They could always add malicious code to `.profile' & do harm.
+  Just thought I should put the warning.
+
+  To edit the config run `chmod +w' on it but please make it read-only
+  again after editing.
+
+
 2 Example
 ═════════