- Moved the sanitizing of the partial_dir value here from options.c.
[rsync/rsync.git] / rsync.yo
index 5ec4c62..17f3c9f 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -1,5 +1,5 @@
 mailto(rsync-bugs@samba.org)
-manpage(rsync)(1)(19 Feb 2006)()()
+manpage(rsync)(1)(22 Apr 2006)()()
 manpagename(rsync)(faster, flexible replacement for rcp)
 manpagesynopsis()
 
@@ -254,7 +254,7 @@ In order to connect to an rsync daemon, the remote system needs to have a
 daemon already running (or it needs to have configured something like inetd
 to spawn an rsync daemon for incoming connections on a particular port).
 For full information on how to start a daemon that will handling incoming
-socket connections, see the rsyncd.conf(5) man page -- that is the config
+socket connections, see the bf(rsyncd.conf)(5) man page -- that is the config
 file for the daemon, and it contains the full details for how to run the
 daemon (including stand-alone and inetd configurations).
 
@@ -337,15 +337,15 @@ to the detailed description below for a complete description.  verb(
  -B, --block-size=SIZE       force a fixed checksum block-size
  -e, --rsh=COMMAND           specify the remote shell to use
      --rsync-path=PROGRAM    specify the rsync to run on remote machine
-     --existing              ignore non-existing files on receiving side
-     --ignore-existing       ignore files that already exist on receiver
-     --remove-sent-files     sent files/symlinks are removed from sender
+     --existing              skip creating new files on receiver
+     --ignore-existing       skip updating files that exist on receiver
+     --remove-sent-files     sender removes successfully sent files
      --del                   an alias for --delete-during
-     --delete                delete files that don't exist on sender
+     --delete                delete extraneous files from dest dirs
      --delete-before         receiver deletes before transfer (default)
      --delete-during         receiver deletes during xfer, not before
      --delete-after          receiver deletes after transfer, not before
-     --delete-excluded       also delete excluded files on receiver
+     --delete-excluded       also delete excluded files from dest dirs
      --ignore-errors         delete even if there are I/O errors
      --force                 force deletion of dirs even if not empty
      --max-delete=NUM        don't delete more than NUM files
@@ -813,20 +813,27 @@ See the bf(--perms) and bf(--executability) options for how the resulting
 permission value can be applied to the files in the transfer.
 
 dit(bf(-o, --owner)) This option causes rsync to set the owner of the
-destination file to be the same as the source file.  By default, the
-preservation is done by name, but may fall back to using the ID number
-in some circumstances (see the bf(--numeric-ids) option for a full
-discussion).
-This option has no effect if the receiving rsync is not run as the
-super-user and bf(--super) is not specified.
+destination file to be the same as the source file, but only if the
+receiving rsync is being run as the super-user (see also the bf(--super)
+option to force rsync to attempt super-user activities).
+Without this option, the owner is set to the invoking user on the
+receiving side.
+
+The preservation of ownership will associate matching names by default, but
+may fall back to using the ID number in some circumstances (see also the
+bf(--numeric-ids) option for a full discussion).
 
 dit(bf(-g, --group)) This option causes rsync to set the group of the
 destination file to be the same as the source file.  If the receiving
-program is not running as the super-user (or with the bf(--no-super)
-option), only groups that the
-receiver is a member of will be preserved.  By default, the preservation
-is done by name, but may fall back to using the ID number in some
-circumstances.  See the bf(--numeric-ids) option for a full discussion.
+program is not running as the super-user (or if bf(--no-super) was
+specified), only groups that the invoking user on the receiving side
+is a member of will be preserved.
+Without this option, the group is set to the default group of the invoking
+user on the receiving side.
+
+The preservation of group information will associate matching names by
+default, but may fall back to using the ID number in some circumstances
+(see also the bf(--numeric-ids) option for a full discussion).
 
 dit(bf(--devices)) This option causes rsync to transfer character and
 block device files to the remote system to recreate these devices.
@@ -898,12 +905,14 @@ treated like a mount-point.  Symlinks to non-directories are unaffected
 by this option.
 
 dit(bf(--existing, --ignore-non-existing)) This tells rsync to skip
-updating files that do not exist yet on the destination.  If this option is
+creating files (i.e. non-directory items) that do not exist yet on the
+destination.  If this option is
 combined with the bf(--ignore-existing) option, no files will be updated
 (which can be useful if all you want to do is to delete missing files).
 
-dit(bf(--ignore-existing)) This tells rsync to skip updating files that
-already exist on the destination.  See also bf(--ignore-non-existing).
+dit(bf(--ignore-existing)) This tells rsync to skip updating files (i.e.
+non-directory items) that
+already exist on the destination.  See also bf(--existing).
 
 dit(bf(--remove-sent-files)) This tells rsync to remove from the sending
 side the files and/or symlinks that are newly created or whose content is
@@ -1078,7 +1087,7 @@ are delimited by whitespace).
 Finally, any file is ignored if it is in the same directory as a
 .cvsignore file and matches one of the patterns listed therein.  Unlike
 rsync's filter/exclude files, these patterns are split on whitespace.
-See the bf(cvs(1)) manual for more information.
+See the bf(cvs)(1) manual for more information.
 
 If you're combining bf(-C) with your own bf(--filter) rules, you should
 note that these CVS excludes are appended at the end of your own rules,
@@ -1345,7 +1354,7 @@ 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
+slower!). Read the man page for the code(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
@@ -1453,7 +1462,7 @@ 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.
 
-The current statistics are as follows: itemize(
+The current statistics are as follows: quote(itemize(
   it() bf(Number of files) is the count of all "files" (in the generic
   sense), which includes directories, symlinks, etc.
   it() bf(Number of files transferred) is the count of normal files that
@@ -1483,7 +1492,7 @@ The current statistics are as follows: itemize(
   rsync received by the client side from the server side.  "Non-message"
   bytes means that we don't count the bytes for a verbose message that the
   server sent to us, which makes the stats more consistent.
-)
+))
 
 dit(bf(-8, --8-bit-output)) This tells rsync to leave all high-bit characters
 unescaped in the output instead of trying to test them to see if they're
@@ -1720,11 +1729,11 @@ rsync daemon.  See also these options in the bf(--daemon) mode section.
 dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer
 NUM.  This 4 byte checksum seed is included in each block and file
 MD4 checksum calculation.  By default the checksum seed is generated
-by the server and defaults to the current time().  This option
+by the server and defaults to the current code(time()).  This option
 is used to set a specific checksum seed, which is useful for
 applications that want repeatable block and file checksums, or
 in the case where the user wants a more random checksum seed.
-Note that setting NUM to 0 causes rsync to use the default of time()
+Note that setting NUM to 0 causes rsync to use the default of code(time())
 for checksum seed.
 enddit()
 
@@ -1741,7 +1750,7 @@ If standard input is a socket then rsync will assume that it is being
 run via inetd, otherwise it will detach from the current terminal and
 become a background daemon.  The daemon will read the config file
 (rsyncd.conf) on each connect made by a client and respond to
-requests accordingly.  See the rsyncd.conf(5) man page for more
+requests accordingly.  See the bf(rsyncd.conf)(5) man page for more
 details.
 
 dit(bf(--address)) By default rsync will bind to the wildcard address when
@@ -1880,7 +1889,6 @@ itemize(
   of the transfer.
   it() if the pattern ends with a / then it will only match a
   directory, not a file, link, or device.
-
   it() rsync chooses between doing a simple string match and wildcard
   matching by checking if the pattern contains one of these three wildcard
   characters: '*', '?', and '[' .
@@ -2258,7 +2266,8 @@ For convenience, one additional file is creating when the write-batch
 option is used.  This file's name is created by appending
 ".sh" to the batch filename.  The .sh file contains
 a command-line suitable for updating a destination tree using that
-batch file. It can be executed using a Bourne(-like) shell, optionally
+batch file. It can be executed using a Bourne (or Bourne-like) shell,
+optionally
 passing in an alternate destination tree pathname which is then used
 instead of the original path. This is useful when the destination tree
 path differs from the original destination tree path.
@@ -2435,7 +2444,7 @@ dit(bf(12)) Error in rsync protocol data stream
 dit(bf(13)) Errors with program diagnostics
 dit(bf(14)) Error in IPC code
 dit(bf(20)) Received SIGUSR1 or SIGINT
-dit(bf(21)) Some error returned by waitpid()
+dit(bf(21)) Some error returned by code(waitpid())
 dit(bf(22)) Error allocating core memory buffers
 dit(bf(23)) Partial transfer due to error
 dit(bf(24)) Partial transfer due to vanished source files
@@ -2472,7 +2481,7 @@ manpagefiles()
 
 manpageseealso()
 
-rsyncd.conf(5)
+bf(rsyncd.conf)(5)
 
 manpagebugs()
 
@@ -2492,7 +2501,7 @@ url(http://rsync.samba.org/)(http://rsync.samba.org/)
 
 manpagesection(VERSION)
 
-This man page is current for version 2.6.7pre2 of rsync.
+This man page is current for version 2.6.8 of rsync.
 
 manpagesection(CREDITS)