branch: externals/async
commit 0a56caea0478a9668f9bedec0555c4e8fda16fa8
Author: Thierry Volpiatto <[email protected]>
Commit: Thierry Volpiatto <[email protected]>
Update README
---
README.md | 27 +++++++++++++++++++++++++++
1 file changed, 27 insertions(+)
diff --git a/README.md b/README.md
index a94b6c5..602015a 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,33 @@ If you don't want to make dired/helm asynchronous disable it
with `dired-async-m
Users of Debian 9 or later or Ubuntu 16.04 or later may simply `apt-get
install elpa-async`.
+## Authentification and user interaction
+
+All authentifications require user interaction like answering to a
+prompt, entering a password etc... Your async implementation should
+avoid any user interaction to avoid beeing stuck with a prompt you
+will not be able to answer to in child emacs. For all what is remote
+(mails, tramp etc...) you have to let emacs manage your identification
+with
[auth-source](https://www.gnu.org/software/emacs/manual/html_mono/auth.html) so
that you do not have to enter a password.
+
+Basically all you need is something like this in your init file:
+
+ (use-package auth-source
+ :no-require t
+ :config (setq auth-sources '("~/.authinfo.gpg" "~/.netrc")))
+
+And a "~/.authinfo.gpg" file containing entries such as
+
+ default port sudo login root password xxxxxxxx
+
+or
+
+ machine xxxxx port xxx login xxx password xxxxxxx
+
+for more specific hosts (smtp, mails etc...)
+
+See [auth-source
manual](https://www.gnu.org/software/emacs/manual/html_mono/auth.html) for more
infos.
+
## Enable asynchronous compilation of your (M)elpa packages
By default emacs package.el compile packages in its running emacs session.
