branch: externals/ssh-deploy
commit 8253251a75543d20507530f6b0d6d749e589a2fd
Author: Christian Johansson <[email protected]>
Commit: Christian Johansson <[email protected]>
Improved README a bit
---
README.md | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 6a2535c..fef0f0c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# `emacs-ssh-deploy`
-The `ssh-deploy` plug-in makes it possible to effortlessly deploy local files
and directories to remote hosts via SSH and FTP. It also makes it possible to
define remote paths per directory and whether or not you want to deploy on
explicit save actions or not. Also it enables manual upload and download of
files and directories. You can also check differences between local files and
directories and remote files and directories if you have `tramp`,`ediff` and
`ztree` installed. You can als [...]
+The `ssh-deploy` plug-in makes it possible to effortlessly deploy local files
and directories to remote hosts via SSH and FTP. It also makes it possible to
define remote paths per directory and whether or not you want to deploy on
explicit save actions or not and whether you want tranfers to be asynchrous or
not. For asynchrous transfers you need a setup which doesn't require a
interactive authorization. The plugin also enables manual upload and download
of files and directories. You can [...]
`ssh-deploy` works with `DirectoryVariables` so you can have different deploy
setups in different ways for different folders.
@@ -36,10 +36,13 @@ Or for FTP use this:
```
-For automatic FTP connections you need to setup ~/.netrc with your login
credentials. An example:
+For automatic FTP connections you need to setup `~/.netrc` with your login
credentials. An example:
~/.netrc contents:
-`machine myserver.com login myuser port ftp password mypassword`
+
+``` shell
+machine myserver.com login myuser port ftp password mypassword`
+```
Set your user and group as owner and file permissions to 700. Emacs should now
be able to automatically connect to server without any user interaction.
@@ -74,10 +77,9 @@ The above configuration uses the plugin `use-package` which
I highly recommend.
## More complex SSH connections
-If you have a SSH connection that is using a different identity-file than the
default, or if it is using a different port than the default you just need to
edit your local SSH-config (~/ssh/config) to make it work using this plugin,
like this:
+If you have a SSH connection that is using a different identity-file than the
default, or if it is using a different port than the default you just need to
edit your local SSH-config (`~/ssh/config`) to make it work using this plugin,
like this:
``` bash
-
## My special connection (replace remote-host, port and identity-file with
your values)
Host remote-host
Port port
