added the --log-format option to allow users to request arbitrary

[rsync/rsync.git] / rsync.yo

diff --git a/rsync.yo b/rsync.yo
index 236aca5..04178ff 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
 )
 


@@ -539,6 +550,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