[Bug 143] Add reference to "rsync" in FAQ and documentation.

[bugzilla-daemon at mindrot.org]

http://bugzilla.mindrot.org/show_bug.cgi?id=143





------- Additional Comments From dwheeler at dwheeler.com  2002-04-18 00:01 -------
The FAQ currently emphasizes troubleshooting, but that's not necessary.
A FAQ is for "frequently asked questions", and since "how do I synchronize"
can be viewed as a frequent question, I think it's reasonable to add this
information to the FAQ.  In fact, PLEASE add the text I proposed
to the FAQ, since it would help many people immediately.

As far as the man page goes, changing the scp man page
so that the "SEE ALSO" section mentioned rsync would be an improvement.
But using rsync's "--rsh" flag really involves a combination
of both ssh and rsync, and some mention in the scp man page
on how to use them together would make the combination easier to use.
Besides modifying scp's "SEE ALSO" man page section, could you
at leat add a sentence mentioning this important use?
Many people only look at the man pages,
so it's important to give them a hint there.  Here's my proposal;
just add this text to the end of the scp man page "DESCRIPTION":


If you want to only copy changed files using ssh's security features,
use rsync(1) with the option --rsh="ssh", e.g.,
rsync -a --rsh="ssh" /home/joe/stuff joeuser at joe.com:/home/joeuser/stuff


It's short, it's simple, and it shows people how to do it.
If you don't like the example, drop everything after the "e.g.", but at least
tell people about rsync, what it does, and its --rsh option.
Just a "see also" to rsync won't tell people WHY they should also see that
program.

Thanks.  I'm just trying to make sure that users can use this great tool
(OpenSSH) using only the documentation they get... :-).





------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.