csum-length documentation

[jw schultz]

Committed.
There were no comments or objections.

On Sun, Mar 02, 2003 at 07:10:20PM -0800, jw schultz wrote:
> I was startled to find that the --csum-length option is not
> implemented even though it is documented in the manpage.
> Not a good thing.
> 
> Here's a patch that removes the manpage entry.  I'd much
> rather not see this option and actually have the csum_length
> be per-file dynamic.  Either way this patch should be
> applied at least until the code changes.
> 
> The patch also brings rsync.1 and rsyncd.conf.5 up to date
> with their yodl source.
> 
> 
> -- 
> ________________________________________________________________
> 	J.W. Schultz            Pegasystems Technologies
> 	email address:		jw at pegasys.ws
> 
> 		Remember Cernan and Schmitt

> Index: rsync.1
> ===================================================================
> RCS file: /cvsroot/rsync/rsync.1,v
> retrieving revision 1.129
> diff -u -b -r1.129 rsync.1
> --- rsync.1	28 Jan 2003 03:11:57 -0000	1.129
> +++ rsync.1	3 Mar 2003 03:04:28 -0000
> @@ -25,7 +25,7 @@
>  exists\&.
>  .PP 
>  The rsync remote-update protocol allows rsync to transfer just the
> -differences between two sets of files across the network link, using
> +differences between two sets of files across the network connection, using
>  an efficient checksum-search algorithm described in the technical
>  report that accompanies this package\&.
>  .PP 
> @@ -279,7 +279,7 @@
>  rsync -Cavz \&. arvidsjaur:backup
>  .RE 
>  .PP 
> -each night over a PPP link to a duplicate directory on my machine
> +each night over a PPP connection to a duplicate directory on my machine
>  "arvidsjaur"\&.
>  .PP 
>  To synchronize my samba source trees I use the following Makefile
> @@ -298,7 +298,7 @@
>  .RE 
>  .PP 
>  this allows me to sync with a CVS directory at the other end of the
> -link\&. I then do cvs operations on the remote machine, which saves a
> +connection\&. I then do cvs operations on the remote machine, which saves a
>  lot of time as the remote cvs protocol isn\'t very efficient\&.
>  .PP 
>  I mirror a directory between my "old" and "new" ftp sites with the
> @@ -752,26 +752,6 @@
>  \&.cvsignore file and matches one of the patterns listed therein\&.  See
>  the \fBcvs(1)\fP manual for more information\&.
>  .IP 
> -.IP "\fB--csum-length=LENGTH\fP" 
> -By default the primary checksum used in
> -rsync is a very strong 16 byte MD4 checksum\&. In most cases you will
> -find that a truncated version of this checksum is quite efficient, and
> -this will decrease the size of the checksum data sent over the link,
> -making things faster\&. 
> -.IP 
> -You can choose the number of bytes in the truncated checksum using the
> ---csum-length option\&. Any value less than or equal to 16 is valid\&.
> -.IP 
> -Note that if you use this option then you run the risk of ending up
> -with an incorrect target file\&. The risk with a value of 16 is
> -microscopic and can be safely ignored (the universe will probably end
> -before it fails) but with smaller values the risk is higher\&.
> -.IP 
> -Current versions of rsync actually use an adaptive algorithm for the
> -checksum length by default, using a 16 byte file checksum to determine
> -if a 2nd pass is required with a longer block checksum\&. Only use this
> -option if you have read the source code and know what you are doing\&.
> -.IP 
>  .IP "\fB-T, --temp-dir=DIR\fP" 
>  This option instructs rsync to use DIR as a
>  scratch directory when creating temporary copies of the files
> @@ -801,7 +781,7 @@
>  .IP "\fB-z, --compress\fP" 
>  With this option, rsync compresses any data from
>  the files that it sends to the destination machine\&.  This
> -option is useful on slow links\&.  The compression method used is the
> +option is useful on slow connections\&.  The compression method used is the
>  same method that gzip uses\&.
>  .IP 
>  Note this this option typically achieves better compression ratios
> Index: rsync.yo
> ===================================================================
> RCS file: /cvsroot/rsync/rsync.yo,v
> retrieving revision 1.115
> diff -u -b -r1.115 rsync.yo
> --- rsync.yo	10 Feb 2003 14:51:09 -0000	1.115
> +++ rsync.yo	3 Mar 2003 03:04:29 -0000
> @@ -654,25 +654,6 @@
>  .cvsignore file and matches one of the patterns listed therein.  See
>  the bf(cvs(1)) manual for more information.
>  
> -dit(bf(--csum-length=LENGTH)) By default the primary checksum used in
> -rsync is a very strong 16 byte MD4 checksum. In most cases you will
> -find that a truncated version of this checksum is quite efficient, and
> -this will decrease the size of the checksum data sent over the connection,
> -making things faster. 
> -
> -You can choose the number of bytes in the truncated checksum using the
> ---csum-length option. Any value less than or equal to 16 is valid.
> -
> -Note that if you use this option then you run the risk of ending up
> -with an incorrect target file. The risk with a value of 16 is
> -microscopic and can be safely ignored (the universe will probably end
> -before it fails) but with smaller values the risk is higher.
> -
> -Current versions of rsync actually use an adaptive algorithm for the
> -checksum length by default, using a 16 byte file checksum to determine
> -if a 2nd pass is required with a longer block checksum. Only use this
> -option if you have read the source code and know what you are doing.
> -
>  dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
>  scratch directory when creating temporary copies of the files
>  transferred on the receiving side.  The default behavior is to create
> Index: rsyncd.conf.5
> ===================================================================
> RCS file: /cvsroot/rsync/rsyncd.conf.5,v
> retrieving revision 1.48
> diff -u -b -r1.48 rsyncd.conf.5
> --- rsyncd.conf.5	27 Jan 2003 03:07:18 -0000	1.48
> +++ rsyncd.conf.5	3 Mar 2003 03:04:30 -0000
> @@ -443,7 +443,7 @@
>  quality security then I recommend that you run rsync over ssh\&.
>  .PP 
>  Also note that the rsync server protocol does not currently provide any
> -encryption of the data that is transferred over the link\&. Only
> +encryption of the data that is transferred over the connection\&. Only
>  authentication is provided\&. Use ssh as the transport if you want
>  encryption\&.
>  .PP 

> -- 
> To unsubscribe or change options: http://lists.samba.org/mailman/listinfo/rsync
> Before posting, read: http://www.tuxedo.org/~esr/faqs/smart-questions.html


-- 
________________________________________________________________
	J.W. Schultz            Pegasystems Technologies
	email address:		jw at pegasys.ws

		Remember Cernan and Schmitt