Document the new --sockopts option.
authorWayne Davison <wayned@samba.org>
Thu, 26 Jan 2006 12:30:20 +0000 (12:30 +0000)
committerWayne Davison <wayned@samba.org>
Thu, 26 Jan 2006 12:30:20 +0000 (12:30 +0000)
rsync.yo

index 753837b..f8d3f1e 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -373,6 +373,7 @@ to the detailed description below for a complete description.  verb(
  -0, --from0                 all *from/filter files are delimited by 0s
      --address=ADDRESS       bind address for outgoing socket to daemon
      --port=PORT             specify double-colon alternate port number
+     --sockopts=OPTIONS      specify custom TCP options
      --blocking-io           use blocking I/O for the remote shell
      --stats                 give some file-transfer stats
  -h, --human-readable        output numbers in a human-readable format
@@ -402,6 +403,7 @@ accepted: verb(
      --config=FILE           specify alternate rsyncd.conf file
      --no-detach             do not detach from the parent
      --port=PORT             listen on alternate port number
+     --sockopts=OPTIONS      specify custom TCP options
  -v, --verbose               increase verbosity
  -4, --ipv4                  prefer IPv4
  -6, --ipv6                  prefer IPv6
@@ -1187,6 +1189,15 @@ double-colon (::) syntax to connect with an rsync daemon (since the URL
 syntax has a way to specify the port as a part of the URL).  See also this
 option in the bf(--daemon) mode section.
 
+dit(bf(--sockopts)) This option can provide endless fun for people
+who like to tune their systems to the utmost degree. You can set all
+sorts of socket options which may make transfers faster (or
+slower!). Read the man page for the setsockopt() system call for
+details on some of the options you may be able to set. By default no
+special socket options are set. This only affects direct socket
+connections to a remote rsync daemon.  This option also exists in the
+bf(--daemon) mode section.
+
 dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching
 a remote shell transport.  If the remote shell is either rsh or remsh,
 rsync defaults to using
@@ -1523,6 +1534,9 @@ dit(bf(--port=PORT)) This specifies an alternate TCP port number for the
 daemon to listen on rather than the default of 873.  See also the "port"
 global option in the rsyncd.conf manpage.
 
+dit(bf(--sockopts)) This overrides the bf(socket options) setting in the
+rsyncd.conf file and has the same syntax.
+
 dit(bf(-v, --verbose)) This option increases the amount of information the
 daemon logs during its startup phase.  After the client connects, the
 daemon's verbosity level will be controlled by the options that the client