patch from Alberto Accomazzi <aaccomazzi@cfa.harvard.edu> to add

[rsync/rsync.git] / rsync.yo

diff --git a/rsync.yo b/rsync.yo
index cedf578..15f6285 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -13,6 +13,8 @@ rsync [options] [user@]host::module[/path] path
 
 rsync [options] path [user@]host::module[/path]
 
 
 rsync [options] path [user@]host::module[/path]
 

+rsync [options] rsync://host/module/path path
+

 manpagedescription()
 
 rsync is a program that behaves in much the same way that rcp does,
 manpagedescription()
 
 rsync is a program that behaves in much the same way that rcp does,


@@ -40,7 +42,7 @@ itemize(
 
 manpagesection(GENERAL)
 
 
 manpagesection(GENERAL)
 

-There are five different ways of using rsync. They are:
+There are six different ways of using rsync. They are:

 
 itemize(
        it() for copying local files. This is invoked when neither
 
 itemize(
        it() for copying local files. This is invoked when neither


@@ -57,11 +59,16 @@ itemize(
 
        it() for copying from a remote rsync server to the local
        machine. This is invoked when the source path contains a ::
 
        it() for copying from a remote rsync server to the local
        machine. This is invoked when the source path contains a ::

-       separator. 
+       separator. You can also use a rsync:// URL if no username
+       is required.

 
        it() for copying from the local machine to a remote rsync
        server. This is invoked when the destination path contains a ::
        separator. 
 
        it() for copying from the local machine to a remote rsync
        server. This is invoked when the destination path contains a ::
        separator. 

+
+       it() for listing files on a remote machine. This is done the
+       same way as rsync transfers except that you leave off the
+       local destination.  

 )
 
 Note that in all cases at least one of the source and destination
 )
 
 Note that in all cases at least one of the source and destination


@@ -140,6 +147,9 @@ itemize(
 
        it() if you specify no path name on the remote server then the
        list of accessible paths on the server will be shown.
 
        it() if you specify no path name on the remote server then the
        list of accessible paths on the server will be shown.

+       
+       it() if you specify no local destination then a listing of the
+       specified files on the remote server is provided

 )
 
 Some paths on the remote server may require authentication. If so then
 )
 
 Some paths on the remote server may require authentication. If so then


@@ -244,6 +254,7 @@ Options
      --port=PORT             specify alternate rsyncd port number
      --stats                 give some file transfer stats
      --progress              show progress during transfer
      --port=PORT             specify alternate rsyncd port number
      --stats                 give some file transfer stats
      --progress              show progress during transfer

+     --log-format=FORMAT     log file transfers using specified format

  -h, --help                  show this help screen
 )
 
  -h, --help                  show this help screen
 )
 


@@ -345,10 +356,14 @@ permissions to be the same as the local permissions.
 
 dit(bf(-o, --owner)) This option causes rsync to update the  remote  owner
 of the  file to be the same as the local owner. This is only available
 
 dit(bf(-o, --owner)) This option causes rsync to update the  remote  owner
 of the  file to be the same as the local owner. This is only available

-to the super-user.
+to the super-user.  Note that if the source system is a daemon using chroot,
+the --numeric-ids option is implied because the source system cannot get
+access to the user names.

 
 dit(bf(-g, --group)) This option causes rsync to update the  remote  group
 
 dit(bf(-g, --group)) This option causes rsync to update the  remote  group

-of the file to be the same as the local group.
+of the file to be the same as the local group.  Note that if the source
+system is a daemon using chroot, the --numeric-ids option is implied because
+the source system cannot get access to the group names.

 
 dit(bf(-D, --devices)) This option causes rsync to transfer character and
 block device information to the remote system to recreate these
 
 dit(bf(-D, --devices)) This option causes rsync to transfer character and
 block device information to the remote system to recreate these


@@ -388,9 +403,11 @@ Still, it is probably easy to get burnt with this option.  The moral
 of the story is to use the -n option until you get used to the
 behavior of --delete.
 
 of the story is to use the -n option until you get used to the
 behavior of --delete.
 

-NOTE: It also may delete files on the destination if the sending side
-can't open them or stat them. This is a bug that hopefully will be
-fixed in a future release.
+If the sending side detects any IO errors then the deletion of any
+files at the destination will be automatically disabled. This is to
+prevent temporary filesystem failures (such as NFS errors) on the
+sending side causing a massive deletion of files on the
+destination. 

 
 dit(bf(--force)) This options tells rsync to delete directories even if
 they are not empty.  This applies to both the --delete option and to
 
 dit(bf(--force)) This options tells rsync to delete directories even if
 they are not empty.  This applies to both the --delete option and to


@@ -512,8 +529,9 @@ what ownership to give files. The special uid 0 and the special group
 0 and never mapped via user/group names even if the --numeric-ids
 option is not specified.
 
 0 and never mapped via user/group names even if the --numeric-ids
 option is not specified.
 

-If a user or group name does not exist on the destination system then
-the numeric id from the source system is used instead.
+If the source system is a daemon using chroot, or if a user or group name
+does not exist on the destination system, then the numeric id from the
+source system is used instead.

 
 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO
 timeout in seconds. If no data is transferred for the specified time
 
 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO
 timeout in seconds. If no data is transferred for the specified time


@@ -534,6 +552,11 @@ specified.
 dit(bf(--port PORT)) This specifies an alternate TCP port number to use
 rather than the default port 873. 
 
 dit(bf(--port PORT)) This specifies an alternate TCP port number to use
 rather than the default port 873. 
 

+dit(bf(--log-format=FORMAT)) Normally rsync just logs filenames as
+they are transferred. This allows you to specify exactly what gets
+logged on a per file basis. The log format is specified using the same
+format conventions as the log format option in rsyncd.conf.
+

 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
 on the file transfer, allowing you to tell how effective the rsync
 algorithm is for your data. This option only works in conjunction with
 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
 on the file transfer, allowing you to tell how effective the rsync
 algorithm is for your data. This option only works in conjunction with