branch: externals/ssh-deploy
commit 407402d0bdfc65923739eed1e8f71d3eb81b4dd9
Author: Christian Johansson <[email protected]>
Commit: Christian Johansson <[email protected]>
Improved documentation about interaction-free password-based authentication
---
README.md | 7 +++++--
ssh-deploy.el | 13 ++++++++-----
2 files changed, 13 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 4f9b84c..5921fa1 100644
--- a/README.md
+++ b/README.md
@@ -95,13 +95,15 @@ Host remote-host
IdentityFile identity-file
```
-## Interaction-free FTP setup on *NIX systems
+## Interaction-free password-based setup on *NIX systems
For automatic **FTP** connections you need to setup `~/.netrc` with your login
credentials. An example:
`~/.netrc` contents:
``` shell
machine myserver.com login myuser port ftp password mypassword
+machine myserver2.com login myuser2 port ssh password mypassword2
+machine myserver3.com login myuser3 port sftp password mypassword3
```
Set your user and group as owner and file permissions to `600`. Emacs should
now be able to automatically connect to this server via FTP without any user
interaction.
@@ -113,6 +115,7 @@ Set your user and group as owner and file permissions to
`600`. Emacs should now
``` elisp
;; ssh-deploy - prefix = C-c C-z, f = forced upload, u = upload, d = download,
x = diff, t = terminal, b = browse
(add-to-list 'load-path "~/.emacs.d/ssh-deploy/")
+(require 'ssh-deploy')
(add-hook 'after-save-hook (lambda() (if (and (boundp
'ssh-deploy-on-explicit-save) ssh-deploy-on-explicit-save)
(ssh-deploy-upload-handler)) ))
(add-hook 'find-file-hook (lambda() (if (and (boundp
'ssh-deploy-automatically-detect-remote-changes)
ssh-deploy-automatically-detect-remote-changes)
(ssh-deploy-remote-changes-handler)) ))
(global-set-key (kbd "C-c C-z f") (lambda()
(interactive)(ssh-deploy-upload-handler-forced) ))
@@ -160,7 +163,7 @@ Set your user and group as owner and file permissions to
`600`. Emacs should now
("B" ssh-deploy-browse-remote-handler)))
```
-You can remove the `add-to-list` line if you installed via `MELPA` repository.
+You can remove the `(add-to-list)` and `(require)` lines if you installed via
`MELPA` repository.
* Restart Emacs
diff --git a/ssh-deploy.el b/ssh-deploy.el
index 319a479..e04e892 100644
--- a/ssh-deploy.el
+++ b/ssh-deploy.el
@@ -3,7 +3,7 @@
;; Author: Christian Johansson <github.com/cjohansson>
;; Maintainer: Christian Johansson <github.com/cjohansson>
;; Created: 5 Jul 2016
-;; Modified: 26 Jan 2018
+;; Modified: 28 Jan 2018
;; Version: 1.73
;; Keywords: tools, convenience
;; URL: https://github.com/cjohansson/emacs-ssh-deploy
@@ -29,10 +29,11 @@
;;; Commentary:
-;; ssh-deploy enables automatic deploys on explicit-save, manual uploads,
renaming,
-;; deleting, downloads, file differences, remote terminals, detection of
remote changes and remote directory browsing via TRAMP.
+;; ssh-deploy enables automatic deploys on explicit-save actions, manual
uploads, renaming,
+;; deleting, downloads, file and directory differences, launching remote
terminals,
+;; detection of remote changes and remote directory browsing via TRAMP.
;;
-;; For asynchrous operations it uses async.el,
+;; For asynchrous operations it uses package async.el.
;;
;; By setting the variables (globally, per directory or per file):
;; ssh-deploy-root-local,ssh-deploy-root-remote, ssh-deploy-on-explicit-save
@@ -40,8 +41,10 @@
;;
;; For asynchronous transfers you need to setup ~/.netrc or key-based
authorization or equivalent for automatic authentication.
;;
-;; Example contents of ~/.netrc for FTP:
+;; Example contents of ~/.netrc for password-based interaction-free
authentication:
;; machine myserver.com login myuser port ftp password mypassword
+;; machine myserver2.com login myuser2 port ssh password mypassword2
+;; machine myserver3.com login myuser3 port sftp password mypassword3
;;
;; Set permissions to this file to 700 with you as the owner.
;;
