Skip to content

Commit 34df7f6

Browse files
committed
More docs on file transfer
1 parent e8331b2 commit 34df7f6

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

docs/kittens/transfer.rst

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Transfer files
22
================
33

4+
.. _rsync: https://en.wikipedia.org/wiki/Rsync
5+
46
.. warning::
57
This kitten is currently experimental, use with care.
68

@@ -12,9 +14,8 @@ etc. Anywhere you have a terminal device, you can transfer files.
1214
:alt: The transfer kitten at work
1315

1416
This kitten supports transferring entire directory trees, preserving soft and
15-
hard links, file permissions, times, etc. It even supports the `rsync
16-
<https://en.wikipedia.org/wiki/Rsync>`_ protocol to transfer only changes to
17-
large files and to automatically resume interrupted transfers.
17+
hard links, file permissions, times, etc. It even supports the rsync_
18+
protocol to transfer only changes to large files.
1819

1920
.. seealso:: See the :doc:`remote_file` kitten
2021

@@ -24,6 +25,8 @@ large files and to automatically resume interrupted transfers.
2425
kitten instead. Or write your own script to use the underlying file transfer
2526
protocol.
2627

28+
.. versionadded:: 0.24.0
29+
2730

2831
Basic usage
2932
---------------
@@ -54,6 +57,10 @@ strictly necessary (kitty will infer the need for a destination directory from
5457
the fact that you are copying multiple things) it is good practice to always
5558
use a trailing slash when the destination is supposed to be a directory.
5659

60+
Also, when transferring multiple files/directories it is a good idea to
61+
use the :option:`kitty +kitten transfer --confirm-paths` option which will give
62+
you an opportunity to review and confirm the files that will be touched.
63+
5764

5865
Avoiding the confirmation prompt
5966
------------------------------------
@@ -77,6 +84,14 @@ by:
7784
stream between your computer and the remote machine can also learn this
7885
password. So use it only with secure connections to trusted computers.
7986

80-
.. versionadded:: 0.24.0
87+
88+
Delta transfers
89+
-----------------------------------
90+
91+
This kitten has the ability to use the rsync_ protocol to only transfer the
92+
differences between files. To turn it on use the :option:`kitty +kitten
93+
transfer --transmit-deltas` option. Note that this will actually be slower when
94+
transferring small files because of round trip overhead, so use with care.
95+
8196

8297
.. include:: ../generated/cli-kitten-transfer.rst

0 commit comments

Comments
 (0)