summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRyo Nakamura <upa@haeena.net>2022-11-18 14:42:23 +0900
committerRyo Nakamura <upa@haeena.net>2022-11-18 20:20:19 +0900
commit5e7aa774cafef00e2ec911ec978f07acedeadcae (patch)
tree71b082e74a365aba23552e73c140a7d912b9b581 /README.md
parentb8d58b1fba1d29d36b98dd19e544ff3002b286e4 (diff)
fix when copy multiple sources and various tiny fixes
* when copying multiple sources, target must be directory * add multi-src copy test and parametrize src/dst prefixes * cleanup REAMDE (s/sessions/connections/g) * make error output in copy functions simple
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 11 insertions, 4 deletions
diff --git a/README.md b/README.md
index c958825..6de72ce 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,10 @@
`mscp`, a variant of `scp`, copies files over multiple ssh (SFTP)
-sessions. Multiple threads in mscp transfer (1) multiple files
-simultaneously and (2) a large file in parallel. It may shorten the
-waiting time for transferring a lot of/large files over networks.
+connections. Multiple threads and connections in mscp transfer (1)
+multiple files simultaneously and (2) a large file in parallel. It
+would shorten the waiting time for transferring a lot of/large files
+over networks.
You can use `mscp` like `scp`, for example, `mscp
user@example.com:srcfile /tmp/dstfile`. Remote hosts only need to run
@@ -14,7 +15,7 @@ standard `sshd` supporting the SFTP subsystem, and you need to be able
to ssh to the hosts (as usual). `mscp` does not require anything else.
-Differences from `scp` are:
+Differences from `scp`:
- remote glob on remote shell expansion is not supported.
- remote to remote copy is not supported.
@@ -173,6 +174,12 @@ responsible for any accidents due to mscp.
## Build with Async Write
+Asynchronous SFTP write improves local-to-remote copy throughput. The
+following procedure is how to build mscp with libssh with a
+`sftp_async_write` patch based on
+https://github.com/limes-datentechnik-gmbh/libssh (see [Re: SFTP Write
+async](https://archive.libssh.org/libssh/2020-06/0000004.html))
+
```console
# install required package
sudo apt install libkrb5-dev