From: Wayne Davison <wayned@samba.org>
Date: Thu, 26 Jan 2006 10:38:54 +0000 (+0000)
Subject: Document the new --specials option and how -D and --devices now work.
X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/commitdiff_plain/4e7d07c8d4c75f0fc4207f0d6058db99b61c2f17

Document the new --specials option and how -D and --devices now work.
---

diff --git a/rsync.yo b/rsync.yo
index 50f06b9f..0cd056fc 100644
--- a/rsync.yo
+++ b/rsync.yo
@@ -318,7 +318,9 @@ to the detailed description below for a complete description.  verb(
  -p, --perms                 preserve permissions
  -o, --owner                 preserve owner (root only)
  -g, --group                 preserve group
- -D, --devices               preserve devices (root only)
+     --devices               preserve device files (root only)
+     --specials              preserve special files
+ -D                          same as --devices --specials
  -t, --times                 preserve times
  -O, --omit-dir-times        omit directories when preserving times
      --chmod=CHMOD           change destination permissions
@@ -694,10 +696,15 @@ 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.
 
-dit(bf(-D, --devices)) This option causes rsync to transfer character and
+dit(bf(--devices)) This option causes rsync to transfer character and
 block device information to the remote system to recreate these
 devices. This option is only available to the super-user.
 
+dit(bf(--specials)) This option causes rsync to transfer special files
+such as named sockets and fifos.
+
+dit(bf(-D)) The bf(-D) option is equivalent to bf(--devices) bf(--specials).
+
 dit(bf(-t, --times)) This tells rsync to transfer modification times along
 with the files and update them on the remote system.  Note that if this
 option is not used, the optimization that excludes files that have not been
@@ -1201,7 +1208,8 @@ quote(itemize(
 ))
 
 The file-types that replace the bf(X) are: bf(f) for a file, a bf(d) for a
-directory, an bf(L) for a symlink, and a bf(D) for a device.
+directory, an bf(L) for a symlink, a bf(D) for a device, and a bf(S) for a
+special file (e.g. named sockets and fifos).
 
 The other letters in the string above are the actual letters that
 will be output if the associated attribute for the item is being updated or