components/rsync/patches/rsyncd.conf.5.patch
author Lukas Rovensky <Lukas.Rovensky@oracle.com>
Thu, 16 Apr 2015 04:52:37 -0700
branchs11-update
changeset 4255 3c054cb83142
parent 3071 b3248af1296a
child 5995 a107a73db207
child 6487 6e536698eac2
permissions -rw-r--r--
20524211 update rsync to 3.1.1 19495794 too aggressive keep-alive messages causing a problem for older rsync
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
     1
Remove groffisms from the man page.  This changes "\(dq" to a double-quote
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
     2
character ("), "\(cq" to a single-quote character ('), and eliminates the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
     3
use of "\&" except where it's needed at the beginning of the line.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
     4
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
     5
--- rsync-3.1.1/rsyncd.conf.5.orig	2014-06-22 10:07:36.000000000 -0700
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
     6
+++ rsync-3.1.1/rsyncd.conf.5	2014-08-27 11:32:28.266744772 -0700
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
     7
@@ -20,7 +20,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
     8
 .PP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
     9
 The file consists of modules and parameters. A module begins with the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    10
 name of the module in square brackets and continues until the next
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    11
-module begins. Modules contain parameters of the form \(dq\&name = value\(dq\&.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    12
+module begins. Modules contain parameters of the form "name = value".
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    13
 .PP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    14
 The file is line\-based \-\- that is, each newline\-terminated line represents
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    15
 either a comment, a module name or a parameter.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    16
@@ -33,9 +33,9 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    17
 .PP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    18
 Any line \fBbeginning\fP with a hash (#) is ignored, as are lines containing
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    19
 only whitespace. (If a hash occurs after anything other than leading
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    20
-whitespace, it is considered a part of the line\(cq\&s content.)
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    21
+whitespace, it is considered a part of the line's content.)
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    22
 .PP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    23
-Any line ending in a \e is \(dq\&continued\(dq\& on the next line in the
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    24
+Any line ending in a \e is "continued" on the next line in the
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    25
 customary UNIX fashion.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    26
 .PP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    27
 The values following the equals sign in parameters are all either a string
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    28
@@ -56,7 +56,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    29
 .PP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    30
 You can launch it either via inetd, as a stand\-alone daemon, or from
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    31
 an rsync client via a remote shell.  If run as a stand\-alone daemon then
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    32
-just run the command \(dq\&\fBrsync \-\-daemon\fP\(dq\& from a suitable startup script.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    33
+just run the command "\fBrsync \-\-daemon\fP" from a suitable startup script.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    34
 .PP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    35
 When run via inetd you should add a line like this to /etc/services:
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    36
 .PP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    37
@@ -72,7 +72,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    38
 .fi 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    39
 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    40
 .PP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    41
-Replace \(dq\&/usr/bin/rsync\(dq\& with the path to where you have rsync installed on
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    42
+Replace "/usr/bin/rsync" with the path to where you have rsync installed on
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    43
 your system.  You will then need to send inetd a HUP signal to tell it to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    44
 reread its config file.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    45
 .PP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    46
@@ -104,7 +104,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    47
 .PP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    48
 .IP "\fBmotd file\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    49
 This parameter allows you to specify a
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    50
-\(dq\&message of the day\(dq\& to display to clients on each connect. This
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    51
+"message of the day" to display to clients on each connect. This
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    52
 usually contains site information and any legal notices. The default
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    53
 is no motd file.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    54
 This can be overridden by the \fB\-\-dparam=motdfile=FILE\fP
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    55
@@ -163,14 +163,14 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    56
 of available modules. The default is no comment.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    57
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    58
 .IP "\fBpath\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    59
-This parameter specifies the directory in the daemon\(cq\&s
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    60
+This parameter specifies the directory in the daemon's
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    61
 filesystem to make available in this module.  You must specify this parameter
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    62
 for each module in \f(CWrsyncd.conf\fP.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    63
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    64
-You may base the path\(cq\&s value off of an environment variable by surrounding
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    65
+You may base the path's value off of an environment variable by surrounding
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    66
 the variable name with percent signs.  You can even reference a variable
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    67
 that is set by rsync when the user connects.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    68
-For example, this would use the authorizing user\(cq\&s name in the path:
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    69
+For example, this would use the authorizing user's name in the path:
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    70
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    71
 .nf 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    72
     path = /home/%RSYNC_USER_NAME% 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
    73
@@ -178,40 +178,40 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    74
 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    75
 .IP 
2708
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
    76
 It is fine if the path includes internal spaces \-\- they will be retained
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
    77
-verbatim (which means that you shouldn\(cq\&t try to escape them).  If your final
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
    78
+verbatim (which means that you shouldn't try to escape them).  If your final
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
    79
 directory has a trailing space (and this is somehow not something you wish to
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
    80
 fix), append a trailing slash to the path to avoid losing the trailing
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
    81
 whitespace.
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
    82
 .IP 
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    83
 .IP "\fBuse chroot\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    84
-If \(dq\&use chroot\(dq\& is true, the rsync daemon will chroot
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    85
-to the \(dq\&path\(dq\& before starting the file transfer with the client.  This has
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    86
+If "use chroot" is true, the rsync daemon will chroot
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    87
+to the "path" before starting the file transfer with the client.  This has
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    88
 the advantage of extra protection against possible implementation security
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    89
 holes, but it has the disadvantages of requiring super\-user privileges,
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    90
 of not being able to follow symbolic links that are either absolute or outside
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    91
 of the new root path, and of complicating the preservation of users and groups
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    92
 by name (see below).
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    93
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    94
-As an additional safety feature, you can specify a dot\-dir in the module\(cq\&s
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    95
-\(dq\&path\(dq\& to indicate the point where the chroot should occur.  This allows rsync
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
    96
-to run in a chroot with a non\-\(dq\&/\(dq\& path for the top of the transfer hierarchy.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    97
+As an additional safety feature, you can specify a dot\-dir in the module's
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    98
+"path" to indicate the point where the chroot should occur.  This allows rsync
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
    99
+to run in a chroot with a non\-"/" path for the top of the transfer hierarchy.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   100
 Doing this guards against unintended library loading (since those absolute
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   101
 paths will not be inside the transfer hierarchy unless you have used an unwise
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   102
 pathname), and lets you setup libraries for the chroot that are outside of the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   103
-transfer.  For example, specifying \(dq\&/var/rsync/./module1\(dq\& will chroot to the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   104
-\(dq\&/var/rsync\(dq\& directory and set the inside\-chroot path to \(dq\&/module1\(dq\&.  If you
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   105
+transfer.  For example, specifying "/var/rsync/./module1" will chroot to the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   106
+"/var/rsync" directory and set the inside\-chroot path to "/module1".  If you
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   107
 had omitted the dot\-dir, the chroot would have used the whole path, and the
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   108
-inside\-chroot path would have been \(dq\&/\(dq\&.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   109
+inside\-chroot path would have been "/".
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   110
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   111
-When \(dq\&use chroot\(dq\& is false or the inside\-chroot path is not \(dq\&/\(dq\&, rsync will:
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   112
+When "use chroot" is false or the inside\-chroot path is not "/", rsync will:
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   113
 (1) munge symlinks by
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   114
-default for security reasons (see \(dq\&munge symlinks\(dq\& for a way to turn this
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   115
+default for security reasons (see "munge symlinks" for a way to turn this
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   116
 off, but only if you trust your users), (2) substitute leading slashes in
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   117
-absolute paths with the module\(cq\&s path (so that options such as
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   118
+absolute paths with the module's path (so that options such as
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   119
 \fB\-\-backup\-dir\fP, \fB\-\-compare\-dest\fP, etc. interpret an absolute path as
2708
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
   120
-rooted in the module\(cq\&s \(dq\&path\(dq\& dir), and (3) trim \(dq\&..\(dq\& path elements from
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   121
+rooted in the module's "path" dir), and (3) trim ".." path elements from
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   122
 args if rsync believes they would escape the module hierarchy.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   123
-The default for \(dq\&use chroot\(dq\& is true, and is the safer choice (especially
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   124
+The default for "use chroot" is true, and is the safer choice (especially
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   125
 if the module is not read\-only).
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   126
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   127
 When this parameter is enabled, rsync will not attempt to map users and groups
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   128
@@ -231,12 +231,12 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   129
 used by these library functions (traditionally /etc/passwd and
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   130
 /etc/group, but perhaps additional dynamic libraries as well).
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   131
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   132
-If you copy the necessary resources into the module\(cq\&s chroot area, you
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   133
-should protect them through your OS\(cq\&s normal user/group or ACL settings (to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   134
-prevent the rsync module\(cq\&s user from being able to change them), and then
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   135
-hide them from the user\(cq\&s view via \(dq\&exclude\(dq\& (see how in the discussion of
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   136
+If you copy the necessary resources into the module's chroot area, you
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   137
+should protect them through your OS's normal user/group or ACL settings (to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   138
+prevent the rsync module's user from being able to change them), and then
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   139
+hide them from the user's view via "exclude" (see how in the discussion of
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   140
 that parameter).  At that point it will be safe to enable the mapping of users
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   141
-and groups by name using the \(dq\&numeric ids\(dq\& daemon parameter (see below).
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   142
+and groups by name using the "numeric ids" daemon parameter (see below).
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   143
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   144
 Note also that you are free to setup custom user/group information in the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   145
 chroot area that is different from your normal system.  For example, you
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   146
@@ -250,7 +250,7 @@
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   147
 the \fB\-\-numeric\-ids\fP command\-line option.  By default, this parameter is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   148
 enabled for chroot modules and disabled for non\-chroot modules.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   149
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   150
-A chroot\-enabled module should not have this parameter enabled unless you\(cq\&ve
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   151
+A chroot\-enabled module should not have this parameter enabled unless you've
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   152
 taken steps to ensure that the module has the necessary resources it needs
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   153
 to translate names, and that it is not possible for a user to change those
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   154
 resources.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   155
@@ -260,52 +260,52 @@
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   156
 all symlinks in the same way as the (non\-daemon\-affecting)
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   157
 \fB\-\-munge\-links\fP command\-line option (using a method described below).
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   158
 This should help protect your files from user trickery when
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   159
-your daemon module is writable.  The default is disabled when \(dq\&use chroot\(dq\&
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   160
-is on and the inside\-chroot path is \(dq\&/\(dq\&, otherwise it is enabled.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   161
+your daemon module is writable.  The default is disabled when "use chroot"
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   162
+is on and the inside\-chroot path is "/", otherwise it is enabled.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   163
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   164
 If you disable this parameter on a daemon that is not read\-only, there
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   165
 are tricks that a user can play with uploaded symlinks to access
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   166
-daemon\-excluded items (if your module has any), and, if \(dq\&use chroot\(dq\&
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   167
+daemon\-excluded items (if your module has any), and, if "use chroot"
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   168
 is off, rsync can even be tricked into showing or changing data that
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   169
-is outside the module\(cq\&s path (as access\-permissions allow).
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   170
+is outside the module's path (as access\-permissions allow).
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   171
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   172
 The way rsync disables the use of symlinks is to prefix each one with
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   173
-the string \(dq\&/rsyncd\-munged/\(dq\&.  This prevents the links from being used
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   174
+the string "/rsyncd\-munged/".  This prevents the links from being used
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   175
 as long as that directory does not exist.  When this parameter is enabled,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   176
 rsync will refuse to run if that path is a directory or a symlink to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   177
-a directory.  When using the \(dq\&munge symlinks\(dq\& parameter in a chroot area
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   178
-that has an inside\-chroot path of \(dq\&/\(dq\&, you should add \(dq\&/rsyncd\-munged/\(dq\&
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   179
+a directory.  When using the "munge symlinks" parameter in a chroot area
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   180
+that has an inside\-chroot path of "/", you should add "/rsyncd\-munged/"
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   181
 to the exclude setting for the module so that
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   182
-a user can\(cq\&t try to create it.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   183
+a user can't try to create it.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   184
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   185
 Note:  rsync makes no attempt to verify that any pre\-existing symlinks in
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   186
-the module\(cq\&s hierarchy are as safe as you want them to be (unless, of
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   187
+the module's hierarchy are as safe as you want them to be (unless, of
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   188
 course, it just copied in the whole hierarchy).  If you setup an rsync
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   189
 daemon on a new area or locally add symlinks, you can manually protect your
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   190
-symlinks from being abused by prefixing \(dq\&/rsyncd\-munged/\(dq\& to the start of
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   191
-every symlink\(cq\&s value.  There is a perl script in the support directory
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   192
-of the source code named \(dq\&munge\-symlinks\(dq\& that can be used to add or remove
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   193
+symlinks from being abused by prefixing "/rsyncd\-munged/" to the start of
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   194
+every symlink's value.  There is a perl script in the support directory
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   195
+of the source code named "munge\-symlinks" that can be used to add or remove
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   196
 this prefix from your symlinks.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   197
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   198
-When this parameter is disabled on a writable module and \(dq\&use chroot\(dq\& is off
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   199
-(or the inside\-chroot path is not \(dq\&/\(dq\&),
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   200
-incoming symlinks will be modified to drop a leading slash and to remove \(dq\&..\(dq\&
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   201
-path elements that rsync believes will allow a symlink to escape the module\(cq\&s
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   202
+When this parameter is disabled on a writable module and "use chroot" is off
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   203
+(or the inside\-chroot path is not "/"),
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   204
+incoming symlinks will be modified to drop a leading slash and to remove ".."
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   205
+path elements that rsync believes will allow a symlink to escape the module's
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   206
 hierarchy.  There are tricky ways to work around this, though, so you had
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   207
 better trust your users if you choose this combination of parameters.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   208
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   209
 .IP "\fBcharset\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   210
 This specifies the name of the character set in which the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   211
-module\(cq\&s filenames are stored.  If the client uses an \fB\-\-iconv\fP option,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   212
-the daemon will use the value of the \(dq\&charset\(dq\& parameter regardless of the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   213
+module's filenames are stored.  If the client uses an \fB\-\-iconv\fP option,
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   214
+the daemon will use the value of the "charset" parameter regardless of the
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   215
 character set the client actually passed.  This allows the daemon to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   216
 support charset conversion in a chroot module without extra files in the
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   217
 chroot area, and also ensures that name\-translation is done in a consistent
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   218
-manner.  If the \(dq\&charset\(dq\& parameter is not set, the \fB\-\-iconv\fP option is
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   219
-refused, just as if \(dq\&iconv\(dq\& had been specified via \(dq\&refuse options\(dq\&.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   220
+manner.  If the "charset" parameter is not set, the \fB\-\-iconv\fP option is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   221
+refused, just as if "iconv" had been specified via "refuse options".
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   222
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   223
 If you wish to force users to always use \fB\-\-iconv\fP for a particular
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   224
-module, add \(dq\&no\-iconv\(dq\& to the \(dq\&refuse options\(dq\& parameter.  Keep in mind
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   225
+module, add "no\-iconv" to the "refuse options" parameter.  Keep in mind
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   226
 that this will restrict access to your module to very new rsync clients.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   227
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   228
 .IP "\fBmax connections\fP"
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   229
@@ -314,15 +314,15 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   230
 Any clients connecting when the maximum has been reached will receive a
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   231
 message telling them to try later.  The default is 0, which means no limit.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   232
 A negative value disables the module.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   233
-See also the \(dq\&lock file\(dq\& parameter.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   234
+See also the "lock file" parameter.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   235
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   236
 .IP "\fBlog file\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   237
-When the \(dq\&log file\(dq\& parameter is set to a non\-empty
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   238
+When the "log file" parameter is set to a non\-empty
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   239
 string, the rsync daemon will log messages to the indicated file rather
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   240
 than using syslog. This is particularly useful on systems (such as AIX)
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   241
 where 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   242
 \f(CWsyslog()\fP
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   243
-doesn\(cq\&t work for chrooted programs.  The file is
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   244
+doesn't work for chrooted programs.  The file is
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   245
 opened before 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   246
 \f(CWchroot()\fP
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   247
 is called, allowing it to be placed outside
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   248
@@ -337,7 +337,7 @@
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   249
 This setting can be overridden by using the \fB\-\-log\-file=FILE\fP or
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   250
 \fB\-\-dparam=logfile=FILE\fP command\-line options.  The former overrides
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   251
 all the log\-file parameters of the daemon and all module settings.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   252
-The latter sets the daemon\(cq\&s log file and the default for all the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   253
+The latter sets the daemon's log file and the default for all the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   254
 modules, which still allows modules to override the default setting.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   255
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   256
 .IP "\fBsyslog facility\fP"
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   257
@@ -347,43 +347,43 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   258
 defined on your system. Common names are auth, authpriv, cron, daemon,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   259
 ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   260
 local1, local2, local3, local4, local5, local6 and local7. The default
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   261
-is daemon.  This setting has no effect if the \(dq\&log file\(dq\& setting is a
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   262
+is daemon.  This setting has no effect if the "log file" setting is a
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   263
 non\-empty string (either set in the per\-modules settings, or inherited
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   264
 from the global settings).
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   265
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   266
 .IP "\fBmax verbosity\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   267
 This parameter allows you to control
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   268
-the maximum amount of verbose information that you\(cq\&ll allow the daemon to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   269
+the maximum amount of verbose information that you'll allow the daemon to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   270
 generate (since the information goes into the log file). The default is 1,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   271
 which allows the client to request one level of verbosity.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   272
 .IP 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   273
-This also affects the user\(cq\&s ability to request higher levels of \fB\-\-info\fP and
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   274
+This also affects the user's ability to request higher levels of \fB\-\-info\fP and
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   275
 \fB\-\-debug\fP logging.  If the max value is 2, then no info and/or debug value
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   276
 that is higher than what would be set by \fB\-vv\fP will be honored by the daemon
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   277
 in its logging.  To see how high of a verbosity level you need to accept for a
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   278
-particular info/debug level, refer to \(dq\&rsync \-\-info=help\(dq\& and \(dq\&rsync \-\-debug=help\(dq\&.
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   279
+particular info/debug level, refer to "rsync \-\-info=help" and "rsync \-\-debug=help".
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   280
 For instance, it takes max\-verbosity 4 to be able to output debug TIME2 and FLIST3.
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   281
 .IP 
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   282
 .IP "\fBlock file\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   283
 This parameter specifies the file to use to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   284
-support the \(dq\&max connections\(dq\& parameter. The rsync daemon uses record
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   285
+support the "max connections" parameter. The rsync daemon uses record
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   286
 locking on this file to ensure that the max connections limit is not
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   287
 exceeded for the modules sharing the lock file.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   288
 The default is \f(CW/var/run/rsyncd.lock\fP.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   289
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   290
 .IP "\fBread only\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   291
 This parameter determines whether clients
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   292
-will be able to upload files or not. If \(dq\&read only\(dq\& is true then any
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   293
-attempted uploads will fail. If \(dq\&read only\(dq\& is false then uploads will
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   294
+will be able to upload files or not. If "read only" is true then any
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   295
+attempted uploads will fail. If "read only" is false then uploads will
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   296
 be possible if file permissions on the daemon side allow them. The default
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   297
 is for all modules to be read only.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   298
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   299
-Note that \(dq\&auth users\(dq\& can override this setting on a per\-user basis.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   300
+Note that "auth users" can override this setting on a per\-user basis.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   301
 .IP 
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   302
 .IP "\fBwrite only\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   303
 This parameter determines whether clients
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   304
-will be able to download files or not. If \(dq\&write only\(dq\& is true then any
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   305
-attempted downloads will fail. If \(dq\&write only\(dq\& is false then downloads
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   306
+will be able to download files or not. If "write only" is true then any
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   307
+attempted downloads will fail. If "write only" is false then downloads
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   308
 will be possible if file permissions on the daemon side allow them.  The
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   309
 default is for this parameter to be disabled.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   310
 .IP 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   311
@@ -391,8 +391,8 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   312
 This parameter determines whether this module is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   313
 listed when the client asks for a listing of available modules.  In addition,
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   314
 if this is false, the daemon will pretend the module does not exist
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   315
-when a client denied by \(dq\&hosts allow\(dq\& or \(dq\&hosts deny\(dq\& attempts to access it.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   316
-Realize that if \(dq\&reverse lookup\(dq\& is disabled globally but enabled for the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   317
+when a client denied by "hosts allow" or "hosts deny" attempts to access it.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   318
+Realize that if "reverse lookup" is disabled globally but enabled for the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   319
 module, the resulting reverse lookup to a potentially client\-controlled DNS
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   320
 server may still reveal to the client that it hit an existing module.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   321
 The default is for modules to be listable.
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   322
@@ -400,10 +400,10 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   323
 .IP "\fBuid\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   324
 This parameter specifies the user name or user ID that
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   325
 file transfers to and from that module should take place as when the daemon
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   326
-was run as root. In combination with the \(dq\&gid\(dq\& parameter this determines what
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   327
+was run as root. In combination with the "gid" parameter this determines what
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   328
 file permissions are available. The default when run by a super\-user is to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   329
-switch to the system\(cq\&s \(dq\&nobody\(dq\& user.  The default for a non\-super\-user is to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   330
-not try to change the user.  See also the \(dq\&gid\(dq\& parameter.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   331
+switch to the system's "nobody" user.  The default for a non\-super\-user is to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   332
+not try to change the user.  See also the "gid" parameter.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   333
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   334
 The RSYNC_USER_NAME environment variable may be used to request that rsync run
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   335
 as the authorizing user.  For example, if you want a rsync to run as the same
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   336
@@ -418,16 +418,16 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   337
 .IP "\fBgid\fP"
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   338
 This parameter specifies one or more group names/IDs that will be
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   339
 used when accessing the module.  The first one will be the default group, and
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   340
-any extra ones be set as supplemental groups.  You may also specify a \(dq\&*\(dq\& as
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   341
+any extra ones be set as supplemental groups.  You may also specify a "*" as
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   342
 the first gid in the list, which will be replaced by all the normal groups for
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   343
-the transfer\(cq\&s user (see \(dq\&uid\(dq\&).  The default when run by a super\-user is to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   344
-switch to your OS\(cq\&s \(dq\&nobody\(dq\& (or perhaps \(dq\&nogroup\(dq\&) group with no other
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   345
+the transfer's user (see "uid").  The default when run by a super\-user is to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   346
+switch to your OS's "nobody" (or perhaps "nogroup") group with no other
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   347
 supplementary groups.  The default for a non\-super\-user is to not change any
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   348
 group attributes (and indeed, your OS may not allow a non\-super\-user to try to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   349
 change their group settings).
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   350
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   351
 .IP "\fBfake super\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   352
-Setting \(dq\&fake super = yes\(dq\& for a module causes the
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   353
+Setting "fake super = yes" for a module causes the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   354
 daemon side to behave as if the \fB\-\-fake\-super\fP command\-line option had
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   355
 been specified.  This allows the full attributes of a file to be stored
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   356
 without having to have the daemon actually running as root.
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   357
@@ -443,17 +443,17 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   358
 tampering with private administrative files, such as files you may add to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   359
 support uid/gid name translations.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   360
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   361
-The daemon filter chain is built from the \(dq\&filter\(dq\&, \(dq\&include from\(dq\&, \(dq\&include\(dq\&,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   362
-\(dq\&exclude from\(dq\&, and \(dq\&exclude\(dq\& parameters, in that order of priority.  Anchored
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   363
+The daemon filter chain is built from the "filter", "include from", "include",
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   364
+"exclude from", and "exclude" parameters, in that order of priority.  Anchored
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   365
 patterns are anchored at the root of the module.  To prevent access to an
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   366
-entire subtree, for example, \(dq\&/secret\(dq\&, you \fImust\fP exclude everything in the
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   367
+entire subtree, for example, "/secret", you \fImust\fP exclude everything in the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   368
 subtree; the easiest way to do this is with a triple\-star pattern like
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   369
-\(dq\&/secret/***\(dq\&.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   370
+"/secret/***".
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   371
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   372
-The \(dq\&filter\(dq\& parameter takes a space\-separated list of daemon filter rules,
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   373
+The "filter" parameter takes a space\-separated list of daemon filter rules,
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   374
 though it is smart enough to know not to split a token at an internal space in
2708
0671d3e048aa 15752593 SUNBT7107925 bump rsync to 3.0.9
klauw <ken.lauw@oracle.com>
parents: 297
diff changeset
   375
-a rule (e.g. \(dq\&\- /foo  \- /bar\(dq\& is parsed as two rules).  You may specify one or
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   376
-more merge\-file rules using the normal syntax.  Only one \(dq\&filter\(dq\& parameter can
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   377
+a rule (e.g. "\- /foo  \- /bar" is parsed as two rules).  You may specify one or
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   378
+more merge\-file rules using the normal syntax.  Only one "filter" parameter can
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   379
 apply to a given module in the config file, so put all the rules you want in a
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   380
 single parameter.  Note that per\-directory merge\-file rules do not provide as
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   381
 much protection as global rules, but they can be used to make \fB\-\-delete\fP work
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   382
@@ -463,27 +463,27 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   383
 .IP "\fBexclude\fP"
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   384
 This parameter takes a space\-separated list of daemon
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   385
 exclude patterns.  As with the client \fB\-\-exclude\fP option, patterns can be
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   386
-qualified with \(dq\&\- \(dq\& or \(dq\&+ \(dq\& to explicitly indicate exclude/include.  Only one
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   387
-\(dq\&exclude\(dq\& parameter can apply to a given module.  See the \(dq\&filter\(dq\& parameter
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   388
+qualified with "\- " or "+ " to explicitly indicate exclude/include.  Only one
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   389
+"exclude" parameter can apply to a given module.  See the "filter" parameter
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   390
 for a description of how excluded files affect the daemon.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   391
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   392
 .IP "\fBinclude\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   393
-Use an \(dq\&include\(dq\& to override the effects of the \(dq\&exclude\(dq\&
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   394
-parameter.  Only one \(dq\&include\(dq\& parameter can apply to a given module.  See the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   395
-\(dq\&filter\(dq\& parameter for a description of how excluded files affect the daemon.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   396
+Use an "include" to override the effects of the "exclude"
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   397
+parameter.  Only one "include" parameter can apply to a given module.  See the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   398
+"filter" parameter for a description of how excluded files affect the daemon.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   399
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   400
 .IP "\fBexclude from\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   401
 This parameter specifies the name of a file
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   402
 on the daemon that contains daemon exclude patterns, one per line.  Only one
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   403
-\(dq\&exclude from\(dq\& parameter can apply to a given module; if you have multiple
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   404
-exclude\-from files, you can specify them as a merge file in the \(dq\&filter\(dq\&
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   405
-parameter.  See the \(dq\&filter\(dq\& parameter for a description of how excluded files
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   406
+"exclude from" parameter can apply to a given module; if you have multiple
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   407
+exclude\-from files, you can specify them as a merge file in the "filter"
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   408
+parameter.  See the "filter" parameter for a description of how excluded files
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   409
 affect the daemon.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   410
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   411
 .IP "\fBinclude from\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   412
-Analogue of \(dq\&exclude from\(dq\& for a file of daemon include
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   413
-patterns.  Only one \(dq\&include from\(dq\& parameter can apply to a given module.  See
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   414
-the \(dq\&filter\(dq\& parameter for a description of how excluded files affect the
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   415
+Analogue of "exclude from" for a file of daemon include
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   416
+patterns.  Only one "include from" parameter can apply to a given module.  See
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   417
+the "filter" parameter for a description of how excluded files affect the
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   418
 daemon.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   419
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   420
 .IP "\fBincoming chmod\fP"
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   421
@@ -514,23 +514,23 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   422
 this module. The usernames do not need to exist on the local
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   423
 system. The rules may contain shell wildcard characters that will be matched
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   424
 against the username provided by the client for authentication. If
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   425
-\(dq\&auth users\(dq\& is set then the client will be challenged to supply a
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   426
+"auth users" is set then the client will be challenged to supply a
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   427
 username and password to connect to the module. A challenge response
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   428
 authentication protocol is used for this exchange. The plain text
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   429
 usernames and passwords are stored in the file specified by the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   430
-\(dq\&secrets file\(dq\& parameter. The default is for all users to be able to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   431
-connect without a password (this is called \(dq\&anonymous rsync\(dq\&).
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   432
+"secrets file" parameter. The default is for all users to be able to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   433
+connect without a password (this is called "anonymous rsync").
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   434
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   435
-In addition to username matching, you can specify groupname matching via a \(cq\&@\(cq\&
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   436
+In addition to username matching, you can specify groupname matching via a '@'
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   437
 prefix.  When using groupname matching, the authenticating username must be a
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   438
 real user on the system, or it will be assumed to be a member of no groups.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   439
-For example, specifying \(dq\&@rsync\(dq\& will match the authenticating user if the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   440
+For example, specifying "@rsync" will match the authenticating user if the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   441
 named user is a member of the rsync group.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   442
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   443
 Finally, options may be specified after a colon (:).  The options allow you to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   444
-\(dq\&deny\(dq\& a user or a group, set the access to \(dq\&ro\(dq\& (read\-only), or set the access
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   445
-to \(dq\&rw\(dq\& (read/write).  Setting an auth\-rule\-specific ro/rw setting overrides
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   446
-the module\(cq\&s \(dq\&read only\(dq\& setting.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   447
+"deny" a user or a group, set the access to "ro" (read\-only), or set the access
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   448
+to "rw" (read/write).  Setting an auth\-rule\-specific ro/rw setting overrides
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   449
+the module's "read only" setting.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   450
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   451
 Be sure to put the rules in the order you want them to be matched, because the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   452
 checking stops at the first matching user or group, and that is the only auth
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   453
@@ -542,54 +542,54 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   454
 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   455
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   456
 In the above rule, user joe will be denied access no matter what.  Any user
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   457
-that is in the group \(dq\&guest\(dq\& is also denied access.  The user \(dq\&admin\(dq\& gets
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   458
-access in read/write mode, but only if the admin user is not in group \(dq\&guest\(dq\&
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   459
+that is in the group "guest" is also denied access.  The user "admin" gets
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   460
+access in read/write mode, but only if the admin user is not in group "guest"
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   461
 (because the admin user\-matching rule would never be reached if the user is in
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   462
-group \(dq\&guest\(dq\&).  Any other user who is in group \(dq\&rsync\(dq\& will get read\-only
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   463
+group "guest").  Any other user who is in group "rsync" will get read\-only
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   464
 access.  Finally, users susan, joe, and sam get the ro/rw setting of the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   465
-module, but only if the user didn\(cq\&t match an earlier group\-matching rule.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   466
+module, but only if the user didn't match an earlier group\-matching rule.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   467
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   468
 See the description of the secrets file for how you can have per\-user passwords
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   469
 as well as per\-group passwords.  It also explains how a user can authenticate
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   470
 using their user password or (when applicable) a group password, depending on
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   471
 what rule is being authenticated.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   472
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   473
-See also the section entitled \(dq\&USING RSYNC\-DAEMON FEATURES VIA A REMOTE
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   474
-SHELL CONNECTION\(dq\& in \fBrsync\fP(1) for information on how handle an
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   475
+See also the section entitled "USING RSYNC\-DAEMON FEATURES VIA A REMOTE
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   476
+SHELL CONNECTION" in \fBrsync\fP(1) for information on how handle an
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   477
 rsyncd.conf\-level username that differs from the remote\-shell\-level
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   478
 username when using a remote shell to connect to an rsync daemon.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   479
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   480
 .IP "\fBsecrets file\fP"
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   481
 This parameter specifies the name of a file that contains
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   482
 the username:password and/or @groupname:password pairs used for authenticating
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   483
-this module. This file is only consulted if the \(dq\&auth users\(dq\& parameter is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   484
+this module. This file is only consulted if the "auth users" parameter is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   485
 specified.  The file is line\-based and contains one name:password pair per
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   486
 line.  Any line has a hash (#) as the very first character on the line is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   487
 considered a comment and is skipped.  The passwords can contain any characters
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   488
 but be warned that many operating systems limit the length of passwords that
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   489
 can be typed at the client end, so you may find that passwords longer than 8
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   490
-characters don\(cq\&t work.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   491
+characters don't work.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   492
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   493
 The use of group\-specific lines are only relevant when the module is being
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   494
-authorized using a matching \(dq\&@groupname\(dq\& rule.  When that happens, the user
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   495
-can be authorized via either their \(dq\&username:password\(dq\& line or the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   496
-\(dq\&@groupname:password\(dq\& line for the group that triggered the authentication.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   497
+authorized using a matching "@groupname" rule.  When that happens, the user
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   498
+can be authorized via either their "username:password" line or the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   499
+"@groupname:password" line for the group that triggered the authentication.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   500
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   501
 It is up to you what kind of password entries you want to include, either
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   502
-users, groups, or both.  The use of group rules in \(dq\&auth users\(dq\& does not
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   503
+users, groups, or both.  The use of group rules in "auth users" does not
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   504
 require that you specify a group password if you do not want to use shared
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   505
 passwords.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   506
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   507
-There is no default for the \(dq\&secrets file\(dq\& parameter, you must choose a name
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   508
+There is no default for the "secrets file" parameter, you must choose a name
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   509
 (such as \f(CW/etc/rsyncd.secrets\fP).  The file must normally not be readable
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   510
-by \(dq\&other\(dq\&; see \(dq\&strict modes\(dq\&.  If the file is not found or is rejected, no
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   511
-logins for a \(dq\&user auth\(dq\& module will be possible.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   512
+by "other"; see "strict modes".  If the file is not found or is rejected, no
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   513
+logins for a "user auth" module will be possible.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   514
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   515
 .IP "\fBstrict modes\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   516
 This parameter determines whether or not
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   517
-the permissions on the secrets file will be checked.  If \(dq\&strict modes\(dq\& is
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   518
+the permissions on the secrets file will be checked.  If "strict modes" is
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   519
 true, then the secrets file must not be readable by any user ID other
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   520
-than the one that the rsync daemon is running under.  If \(dq\&strict modes\(dq\& is
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   521
+than the one that the rsync daemon is running under.  If "strict modes" is
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   522
 false, the check is not performed.  The default is true.  This parameter
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   523
 was added to accommodate rsync running on the Windows operating system.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   524
 .IP 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   525
@@ -604,7 +604,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   526
 .RS 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   527
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   528
 a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   529
-of the form a:b:c::d:e:f. In this case the incoming machine\(cq\&s IP address
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   530
+of the form a:b:c::d:e:f. In this case the incoming machine's IP address
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   531
 must match exactly.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   532
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   533
 an address/mask in the form ipaddr/n where ipaddr is the IP address
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   534
@@ -619,11 +619,11 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   535
 a hostname pattern using wildcards. If the hostname of the connecting IP
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   536
 (as determined by a reverse lookup) matches the wildcarded name (using the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   537
 same rules as normal unix filename matching), the client is allowed in.  This
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   538
-only works if \(dq\&reverse lookup\(dq\& is enabled (the default).
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   539
+only works if "reverse lookup" is enabled (the default).
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   540
 .IP o 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   541
 a hostname. A plain hostname is matched against the reverse DNS of the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   542
-connecting IP (if \(dq\&reverse lookup\(dq\& is enabled), and/or the IP of the given
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   543
-hostname is matched against the connecting IP (if \(dq\&forward lookup\(dq\& is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   544
+connecting IP (if "reverse lookup" is enabled), and/or the IP of the given
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   545
+hostname is matched against the connecting IP (if "forward lookup" is
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   546
 enabled, as it is by default).  Any match will be allowed in.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   547
 .RE
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   548
 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   549
@@ -640,31 +640,31 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   550
 .RE
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   551
 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   552
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   553
-You can also combine \(dq\&hosts allow\(dq\& with a separate \(dq\&hosts deny\(dq\&
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   554
-parameter. If both parameters are specified then the \(dq\&hosts allow\(dq\& parameter is
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   555
+You can also combine "hosts allow" with a separate "hosts deny"
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   556
+parameter. If both parameters are specified then the "hosts allow" parameter is
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   557
 checked first and a match results in the client being able to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   558
-connect. The \(dq\&hosts deny\(dq\& parameter is then checked and a match means
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   559
+connect. The "hosts deny" parameter is then checked and a match means
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   560
 that the host is rejected. If the host does not match either the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   561
-\(dq\&hosts allow\(dq\& or the \(dq\&hosts deny\(dq\& patterns then it is allowed to
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   562
+"hosts allow" or the "hosts deny" patterns then it is allowed to
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   563
 connect.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   564
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   565
-The default is no \(dq\&hosts allow\(dq\& parameter, which means all hosts can connect.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   566
+The default is no "hosts allow" parameter, which means all hosts can connect.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   567
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   568
 .IP "\fBhosts deny\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   569
 This parameter allows you to specify a
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   570
 list of patterns that are matched against a connecting clients
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   571
 hostname and IP address. If the pattern matches then the connection is
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   572
-rejected. See the \(dq\&hosts allow\(dq\& parameter for more information.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   573
+rejected. See the "hosts allow" parameter for more information.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   574
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   575
-The default is no \(dq\&hosts deny\(dq\& parameter, which means all hosts can connect.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   576
+The default is no "hosts deny" parameter, which means all hosts can connect.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   577
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   578
 .IP "\fBreverse lookup\fP"
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   579
 Controls whether the daemon performs a reverse lookup
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   580
-on the client\(cq\&s IP address to determine its hostname, which is used for
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   581
-\(dq\&hosts allow\(dq\&/\(dq\&hosts deny\(dq\& checks and the \(dq\&%h\(dq\& log escape.  This is enabled by
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   582
+on the client's IP address to determine its hostname, which is used for
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   583
+"hosts allow"/"hosts deny" checks and the "%h" log escape.  This is enabled by
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   584
 default, but you may wish to disable it to save time if you know the lookup will
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   585
 not return a useful result, in which case the daemon will use the name
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   586
-\(dq\&UNDETERMINED\(dq\& instead.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   587
+"UNDETERMINED" instead.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   588
 .IP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   589
 If this parameter is enabled globally (even by default), rsync performs the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   590
 lookup as soon as a client connects, so disabling it for a module will not
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   591
@@ -690,7 +690,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   592
 This tells the rsync daemon to completely
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   593
 ignore files that are not readable by the user. This is useful for
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   594
 public archives that may have some non\-readable files among the
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   595
-directories, and the sysadmin doesn\(cq\&t want those files to be seen at all.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   596
+directories, and the sysadmin doesn't want those files to be seen at all.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   597
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   598
 .IP "\fBtransfer logging\fP"
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   599
 This parameter enables per\-file
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   600
@@ -698,7 +698,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   601
 used by ftp daemons.  The daemon always logs the transfer at the end, so
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   602
 if a transfer is aborted, no mention will be made in the log file.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   603
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   604
-If you want to customize the log lines, see the \(dq\&log format\(dq\& parameter.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   605
+If you want to customize the log lines, see the "log format" parameter.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   606
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   607
 .IP "\fBlog format\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   608
 This parameter allows you to specify the
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   609
@@ -706,17 +706,17 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   610
 The format is a text string containing embedded single\-character escape
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   611
 sequences prefixed with a percent (%) character.  An optional numeric
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   612
 field width may also be specified between the percent and the escape
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   613
-letter (e.g. \(dq\&\fB%\-50n %8l %07p\fP\(dq\&).
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   614
+letter (e.g. "\fB%\-50n %8l %07p\fP").
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   615
 In addition, one or more apostrophes may be specified prior to a numerical
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   616
 escape to indicate that the numerical value should be made more human\-readable.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   617
 The 3 supported levels are the same as for the \fB\-\-human\-readable\fP
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   618
 command\-line option, though the default is for human\-readability to be off.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   619
-Each added apostrophe increases the level (e.g. \(dq\&\fB%'\&'\&l %'\&b %f\fP\(dq\&).
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   620
+Each added apostrophe increases the level (e.g. "\fB%''l %'b %f\fP").
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   621
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   622
-The default log format is \(dq\&%o %h [%a] %m (%u) %f %l\(dq\&, and a \(dq\&%t [%p] \(dq\&
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   623
-is always prefixed when using the \(dq\&log file\(dq\& parameter.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   624
+The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   625
+is always prefixed when using the "log file" parameter.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   626
 (A perl script that will summarize this default log format is included
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   627
-in the rsync source code distribution in the \(dq\&support\(dq\& subdirectory:
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   628
+in the rsync source code distribution in the "support" subdirectory:
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   629
 rsyncstats.)
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   630
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   631
 The single\-character escapes that are understood are as follows:
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   632
@@ -733,9 +733,9 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   633
 .IP o 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   634
 %C the full\-file MD5 checksum if \fB\-\-checksum\fP is enabled or a file was transferred (only for protocol 30 or above).
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   635
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   636
-%f the filename (long form on sender; no trailing \(dq\&/\(dq\&)
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   637
+%f the filename (long form on sender; no trailing "/")
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   638
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   639
-%G the gid of the file (decimal) or \(dq\&DEFAULT\(dq\&
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   640
+%G the gid of the file (decimal) or "DEFAULT"
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   641
 .IP o 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   642
 %h the remote host name (only available for a daemon)
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   643
 .IP o 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   644
@@ -743,15 +743,15 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   645
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   646
 %l the length of the file in bytes
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   647
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   648
-%L the string \(dq\& \-> SYMLINK\(dq\&, \(dq\& => HARDLINK\(dq\&, or \(dq\&\(dq\& (where \fBSYMLINK\fP or \fBHARDLINK\fP is a filename)
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   649
+%L the string " \-> SYMLINK", " => HARDLINK", or "" (where \fBSYMLINK\fP or \fBHARDLINK\fP is a filename)
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   650
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   651
 %m the module name
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   652
 .IP o 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   653
 %M the last\-modified time of the file
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   654
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   655
-%n the filename (short form; trailing \(dq\&/\(dq\& on dir)
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   656
+%n the filename (short form; trailing "/" on dir)
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   657
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   658
-%o the operation, which is \(dq\&send\(dq\&, \(dq\&recv\(dq\&, or \(dq\&del.\(dq\& (the latter includes the trailing period)
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   659
+%o the operation, which is "send", "recv", or "del." (the latter includes the trailing period)
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   660
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   661
 %p the process ID of this rsync session
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   662
 .IP o 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   663
@@ -765,7 +765,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   664
 .RE
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   665
 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   666
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   667
-For a list of what the characters mean that are output by \(dq\&%i\(dq\&, see the
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   668
+For a list of what the characters mean that are output by "%i", see the
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   669
 \fB\-\-itemize\-changes\fP option in the rsync manpage.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   670
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   671
 Note that some of the logged output changes when talking with older
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   672
@@ -775,7 +775,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   673
 .IP "\fBtimeout\fP"
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   674
 This parameter allows you to override the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   675
 clients choice for I/O timeout for this module. Using this parameter you
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   676
-can ensure that rsync won\(cq\&t wait on a dead client forever. The timeout
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   677
+can ensure that rsync won't wait on a dead client forever. The timeout
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   678
 is specified in seconds. A value of zero means no timeout and is the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   679
 default. A good choice for anonymous rsync daemons may be 600 (giving
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   680
 a 10 minute timeout).
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   681
@@ -796,15 +796,15 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   682
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   683
 The reason the above refuses all delete options is that the options imply
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   684
 \fB\-\-delete\fP, and implied options are refused just like explicit options.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   685
-As an additional safety feature, the refusal of \(dq\&delete\(dq\& also refuses
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   686
+As an additional safety feature, the refusal of "delete" also refuses
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   687
 \fBremove\-source\-files\fP when the daemon is the sender; if you want the latter
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   688
-without the former, instead refuse \(dq\&delete\-*\(dq\& \-\- that refuses all the
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   689
+without the former, instead refuse "delete\-*" \-\- that refuses all the
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   690
 delete modes without affecting \fB\-\-remove\-source\-files\fP.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   691
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   692
 When an option is refused, the daemon prints an error message and exits.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   693
 To prevent all compression when serving files,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   694
-you can use \(dq\&dont compress = *\(dq\& (see below)
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   695
-instead of \(dq\&refuse options = compress\(dq\& to avoid returning an error to a
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   696
+you can use "dont compress = *" (see below)
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   697
+instead of "refuse options = compress" to avoid returning an error to a
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   698
 client that requests compression.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   699
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   700
 .IP "\fBdont compress\fP"
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   701
@@ -813,16 +813,16 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   702
 when pulling files from the daemon (no analogous parameter exists to
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   703
 govern the pushing of files to a daemon).
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   704
 Compression is expensive in terms of CPU usage, so it
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   705
-is usually good to not try to compress files that won\(cq\&t compress well,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   706
+is usually good to not try to compress files that won't compress well,
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   707
 such as already compressed files.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   708
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   709
-The \(dq\&dont compress\(dq\& parameter takes a space\-separated list of
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   710
+The "dont compress" parameter takes a space\-separated list of
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   711
 case\-insensitive wildcard patterns. Any source filename matching one
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   712
 of the patterns will not be compressed during transfer.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   713
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   714
 See the \fB\-\-skip\-compress\fP parameter in the \fBrsync\fP(1) manpage for the list
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   715
 of file suffixes that are not compressed by default.  Specifying a value
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   716
-for the \(dq\&dont compress\(dq\& parameter changes the default when the daemon is
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   717
+for the "dont compress" parameter changes the default when the daemon is
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   718
 the sender.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   719
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   720
 .IP "\fBpre\-xfer exec\fP, \fBpost\-xfer exec\fP"
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   721
@@ -831,7 +831,7 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   722
 transfer is aborted before it begins.  Any output from the script on stdout (up
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   723
 to several KB) will be displayed to the user when aborting, but is NOT
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   724
 displayed if the script returns success.  Any output from the script on stderr
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   725
-goes to the daemon\(cq\&s stderr, which is typically discarded (though see
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   726
+goes to the daemon's stderr, which is typically discarded (though see
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   727
 \-\-no\-detatch option for a way to see the stderr output, which can assist with
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   728
 debugging).
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   729
 .IP 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   730
@@ -844,26 +844,26 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   731
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   732
 \fBRSYNC_MODULE_PATH\fP: The path configured for the module.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   733
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   734
-\fBRSYNC_HOST_ADDR\fP: The accessing host\(cq\&s IP address.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   735
+\fBRSYNC_HOST_ADDR\fP: The accessing host's IP address.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   736
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   737
-\fBRSYNC_HOST_NAME\fP: The accessing host\(cq\&s name.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   738
+\fBRSYNC_HOST_NAME\fP: The accessing host's name.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   739
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   740
-\fBRSYNC_USER_NAME\fP: The accessing user\(cq\&s name (empty if no user).
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   741
+\fBRSYNC_USER_NAME\fP: The accessing user's name (empty if no user).
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   742
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   743
 \fBRSYNC_PID\fP: A unique number for this transfer.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   744
 .IP o 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   745
 \fBRSYNC_REQUEST\fP: (pre\-xfer only) The module/path info specified
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   746
 by the user.  Note that the user can specify multiple source files,
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   747
-so the request can be something like \(dq\&mod/path1 mod/path2\(dq\&, etc.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   748
+so the request can be something like "mod/path1 mod/path2", etc.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   749
 .IP o 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   750
 \fBRSYNC_ARG#\fP: (pre\-xfer only) The pre\-request arguments are set
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   751
-in these numbered values. RSYNC_ARG0 is always \(dq\&rsyncd\(dq\&, followed by
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   752
+in these numbered values. RSYNC_ARG0 is always "rsyncd", followed by
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   753
 the options that were used in RSYNC_ARG1, and so on.  There will be a
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   754
-value of \(dq\&.\(dq\& indicating that the options are done and the path args
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   755
+value of "." indicating that the options are done and the path args
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   756
 are beginning \-\- these contain similar information to RSYNC_REQUEST,
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   757
 but with values separated and the module name stripped off.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   758
 .IP o 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   759
-\fBRSYNC_EXIT_STATUS\fP: (post\-xfer only) the server side\(cq\&s exit value.
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   760
+\fBRSYNC_EXIT_STATUS\fP: (post\-xfer only) the server side's exit value.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   761
 This will be 0 for a successful run, a positive value for an error that the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   762
 server generated, or a \-1 if rsync failed to exit properly.  Note that an
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   763
 error that occurs on the client side does not currently get sent to the
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   764
@@ -877,7 +877,7 @@
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   765
 .IP 
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   766
 Even though the commands can be associated with a particular module, they
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   767
 are run using the permissions of the user that started the daemon (not the
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   768
-module\(cq\&s uid/gid setting) without any chroot restrictions.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   769
+module's uid/gid setting) without any chroot restrictions.
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   770
 .IP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   771
 .SH "CONFIG DIRECTIVES"
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   772
 
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   773
@@ -885,14 +885,14 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   774
 There are currently two config directives available that allow a config file to
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   775
 incorporate the contents of other files:  \fB&include\fP and \fB&merge\fP.  Both
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   776
 allow a reference to either a file or a directory.  They differ in how
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   777
-segregated the file\(cq\&s contents are considered to be.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   778
+segregated the file's contents are considered to be.
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   779
 .PP 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   780
 The \fB&include\fP directive treats each file as more distinct, with each one
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   781
 inheriting the defaults of the parent file, starting the parameter parsing
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   782
 as globals/defaults, and leaving the defaults unchanged for the parsing of
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   783
 the rest of the parent file.
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   784
 .PP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   785
-The \fB&merge\fP directive, on the other hand, treats the file\(cq\&s contents as
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   786
+The \fB&merge\fP directive, on the other hand, treats the file's contents as
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   787
 if it were simply inserted in place of the directive, and thus it can set
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   788
 parameters in a module started in another file, can affect the defaults for
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   789
 other files, etc.
4255
3c054cb83142 20524211 update rsync to 3.1.1
Lukas Rovensky <Lukas.Rovensky@oracle.com>
parents: 3071
diff changeset
   790
@@ -901,8 +901,8 @@
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   791
 in all the \fB*.conf\fP or \fB*.inc\fP files (respectively) that are contained inside
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   792
 that directory (without any
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   793
 recursive scanning), with the files sorted into alpha order.  So, if you have a
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   794
-directory named \(dq\&rsyncd.d\(dq\& with the files \(dq\&foo.conf\(dq\&, \(dq\&bar.conf\(dq\&, and
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   795
-\(dq\&baz.conf\(dq\& inside it, this directive:
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   796
+directory named "rsyncd.d" with the files "foo.conf", "bar.conf", and
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   797
+"baz.conf" inside it, this directive:
297
3940bc347ca8 7034286 Problem with utility/rsync (fix patches)
Norm Jacobs <Norm.Jacobs@Oracle.COM>
parents: 296
diff changeset
   798
 .PP 
3071
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   799
 .nf 
b3248af1296a 18414592 update rsync to 3.1.0
Danek Duvall <danek.duvall@oracle.com>
parents: 2708
diff changeset
   800
     &include /path/rsyncd.d