Bug 4001 - man page should document --server flag and SSH forced command scenario
man page should document --server flag and SSH forced command scenario
Product: rsync
Classification: Unclassified
Component: core
All All
: P3 normal
: ---
Assigned To: Wayne Davison
Rsync QA Contact
Depends on:
  Show dependency treegraph
Reported: 2006-08-05 07:07 UTC by Ilya Konstantinov
Modified: 2006-10-15 13:26 UTC (History)
0 users

See Also:


Note You need to log in before you can comment on or make changes to this bug.
Description Ilya Konstantinov 2006-08-05 07:07:06 UTC
The rsync(1) manpage should document the command line flags --server and --sender, as well as give a "recipe" for unattended mirror scenarios (with SSH public key auth + forced command).
Comment 1 Matt McCutchen 2006-08-05 20:46:41 UTC
Rsync end users should never need the --server and --sender options; they are used only by the implementation of rsync itself.  Thus, I don't think it is necessary to document them in the man page.  On the other hand, I don't think it could hurt to mention them in the man page, provided they are marked as "internal" or something so they don't confuse end users.

The SSH forced command thing would do better in a how-to guide than in the man page.
Comment 2 Ilya Konstantinov 2006-08-06 02:06:22 UTC
Allright. I would only mention '--server' and '--sender' briefly as internal commands, and will find a section in which I'll describe the mechanism used by rsync to do zero-setup SSH-based synching and how to retrieve the forced command. However, I would not tutor the user on setting up SSH keys etc. in the man page.
Comment 3 Wayne Davison 2006-09-17 19:21:35 UTC
The latest manpage mentions the --server and --sender commands near the end in an INTERNAL COMMANDS section (so that normal users will hopefully not confuse --server and --daemon).  This new section also mentions the support/rrsync script, which provides an example script for use with a restricted ssh login.