Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
laktak committed Jan 18, 2024
1 parent 4fdf5d5 commit 49727eb
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ A status/progress bar for [rsync](https://github.com/WayneD/rsync).


- [Status Bar](#status-bar)
- [Limitations](#limitations)
- [Installation](#installation)
- [Usage](#usage)
- [Known Issues when using ssh behind rsync](#known-issues-when-using-ssh-behind-rsync)
Expand Down Expand Up @@ -35,13 +34,6 @@ Files to scan/check<br>- percentage completed<br>- (number of files)<br>- spinne
The spinner indicates that rsync is still checking if files need to be updated. Until this process completes the progress bar may decrease as new files are found.


## Limitations

Interactive ssh questions (host key, password) are happening outside of the piped content. That means that rsyncy does not know that ssh is waiting for input and will draw the status bar over it. If you have an idea on how to handle this case please let me know.

Workaround: connect once to your server via ssh to add it to the known_hosts file.


## Installation

- Linux packages for [Arch, Debian, Fedora, Suse and Ubuntu via the Open Build Service](https://software.opensuse.org//download.html?project=home%3Alaktak&package=rsyncy)
Expand Down Expand Up @@ -71,9 +63,11 @@ $ rsync -a --info=progress2 -hv FROM/ TO | rsyncy
At the moment `rsyncy` itself has only one option, you can turn off colors via the `NO_COLOR=1` environment variable.


## Known Issues when using ssh behind rsync
## Known Issue when using ssh behind rsync

ssh uses direct TTY access to make sure that the input is indeed issued by an interactive keyboard user (for host keys and passwords). That means that rsyncy does not know that ssh is waiting for input and will draw the status bar over it. You can still enter your password and press enter to continue.

ssh uses direct TTY access to make sure that the password is indeed issued by an interactive keyboard user. rsyncy is unable to detect the password prompt and will overwrite it with the status line. You can still enter your password and press enter to continue.
Workaround: connect once to your server via ssh to add it to the known_hosts file.


## lf support
Expand Down

0 comments on commit 49727eb

Please sign in to comment.