Attached is a patch that improves the discussion of --progress in the
rsync man page.  It makes one badly needed update: the man page needs
to use "(xfer#5, to-check=169/396)" instead of "(5, 57.1% of 396)".
In addition, I tried to make the rest of the discussion more precise.

Matt
### Eclipse Workspace Patch 1.0
#P rsync
Index: rsync.yo
===================================================================
RCS file: /cvsroot/rsync/rsync.yo,v
retrieving revision 1.377
diff -u -r1.377 rsync.yo
--- rsync.yo	18 Sep 2006 00:19:04 -0000	1.377
+++ rsync.yo	22 Sep 2006 22:23:49 -0000
@@ -1659,24 +1659,32 @@
 something to watch.
 Implies bf(--verbose) if it wasn't already specified.
 
-When the file is transferring, the data looks like this:
+While rsync is transferring a regular file, it maintains a progress line that
+looks like this:
 
 verb(      782448  63%  110.64kB/s    0:00:04)
 
-This tells you the current file size, the percentage of the transfer that
-is complete, the current calculated file-completion rate (including both
-data over the wire and data being matched locally), and the estimated time
-remaining in this transfer.
-
-After a file is complete, the data looks like this:
-
-verb(     1238099 100%  146.38kB/s    0:00:08  (5, 57.1% of 396))
-
-This tells you the final file size, that it's 100% complete, the final
-transfer rate for the file, the amount of elapsed time it took to transfer
-the file, and the addition of a total-transfer summary in parentheses.
-These additional numbers tell you how many files have been updated, and
-what percent of the total number of files has been scanned.
+In this example, the receiver has reconstructed 782448 bytes or 63% of the
+sender's file, the receiver is reconstructing the sender's file at a rate of
+110.64 kB/s, and the transfer would finish in 4 seconds if that rate were
+maintained.
+
+These statistics can be misleading if the incremental transfer algorithm is in
+use.  For example, if the sender's file consists of the basis file followed by
+additional data, the reported rate will probably drop dramatically when the
+receiver gets to the literal data, and the transfer will probably take much
+longer to finish than the receiver estimated as it was finishing the matched
+part of the file.
+
+When the file transfer finishes, rsync replaces the progress line with a summary
+line that looks like this:
+
+verb(     1238099 100%  146.38kB/s    0:00:08  (xfer#5, to-check=169/396))
+
+In this example, the file was 1238099 bytes long in total, the file transfer
+took 8 seconds and proceeded at an average rate of 146.38 kB/s, it was the fifth
+transfer of a regular file in the overall transfer, and 169 of the 396 files in
+the overall transfer have not yet been considered by the receiver.
 
 dit(bf(-P)) The bf(-P) option is equivalent to bf(--partial) bf(--progress).  Its
 purpose is to make it much easier to specify these two options for a long
-- 
To unsubscribe or change options: https://lists.samba.org/mailman/listinfo/rsync
Before posting, read: http://www.catb.org/~esr/faqs/smart-questions.html

Reply via email to