From fa370dd17abfeb7d5322cd704d5c8b8416d608cb Mon Sep 17 00:00:00 2001 From: Andinus Date: Mon, 31 Aug 2020 17:12:35 +0530 Subject: Document new configuration in README --- README | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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 ═════════ -- cgit 1.4.1-2-gfad0