Merging upstream version 3.3.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 44 insertions, 31 deletions

diff --git a/rsyncd.conf.5 b/rsyncd.conf.5
index 249edd4..ce91b49 100644
--- a/rsyncd.conf.5
+++ b/rsyncd.conf.5
@@ -1,4 +1,4 @@
-.TH "rsyncd.conf" "5" "20 Oct 2022" "rsyncd.conf from rsync 3.2.7" "User Commands"
+.TH "rsyncd.conf" "5" "6 Apr 2024" "rsyncd.conf from rsync 3.3.0" "User Commands"
 .\" prefix=/usr
 .P
 .SH "NAME"
@@ -10,7 +10,9 @@ rsyncd.conf \- configuration file for rsync in daemon mode
 rsyncd.conf
 .P
 The online version of this manpage (that includes cross-linking of topics)
-is available at https://download.samba.org/pub/rsync/rsyncd.conf.5.
+is available at
+.UR https://download.samba.org/pub/rsync/rsyncd.conf.5
+.UE .
 .P
 .SH "DESCRIPTION"
 .P
@@ -85,25 +87,7 @@ reread the \fBrsyncd.conf\fP file. The file is re-read on each client connection
 .SH "GLOBAL PARAMETERS"
 .P
 The first parameters in the file (before a [module] header) are the global
-parameters.  Rsync also allows for the use of a "[global]" module name to
-indicate the start of one or more global-parameter sections (the name must be
-lower case).
-.P
-You may also include any module parameters in the global part of the config
-file in which case the supplied value will override the default for that
-parameter.
-.P
-You may use references to environment variables in the values of parameters.
-String parameters will have %VAR% references expanded as late as possible (when
-the string is first used in the program), allowing for the use of variables
-that rsync sets at connection time, such as RSYNC_USER_NAME.  Non-string
-parameters (such as true/false settings) are expanded when read from the config
-file.  If a variable does not exist in the environment, or if a sequence of
-characters is not a valid reference (such as an un-paired percent sign), the
-raw characters are passed through unchanged.  This helps with backward
-compatibility and safety (e.g. expanding a non-existent %VAR% to an empty
-string in a path could result in a very unsafe path).  The safest way to insert
-a literal % into a value is to use %%.
+parameters:
 .P
 .IP "\fBmotd\ file\fP"
 This parameter allows you to specify a "message of the day" (MOTD) to display
@@ -136,6 +120,22 @@ can also be specified via the \fB\-\-sockopts\fP command-line option.
 You can override the default backlog value when the daemon listens for
 connections.  It defaults to 5.
 .P
+You may also include any MODULE PARAMETERS in the global part of the
+config file, in which case the supplied value will override the default for
+that parameter.
+.P
+You may use references to environment variables in the values of parameters.
+String parameters will have %VAR% references expanded as late as possible (when
+the string is first used in the program), allowing for the use of variables
+that rsync sets at connection time, such as RSYNC_USER_NAME.  Non-string
+parameters (such as true/false settings) are expanded when read from the config
+file.  If a variable does not exist in the environment, or if a sequence of
+characters is not a valid reference (such as an un-paired percent sign), the
+raw characters are passed through unchanged.  This helps with backward
+compatibility and safety (e.g. expanding a non-existent %VAR% to an empty
+string in a path could result in a very unsafe path).  The safest way to insert
+a literal % into a value is to use %%.
+.P
 .SH "MODULE PARAMETERS"
 .P
 After the global parameters you should define a number of modules, each module
@@ -144,11 +144,17 @@ a module name in square brackets [module] followed by the parameters for that
 module.  The module name cannot contain a slash or a closing square bracket.
 If the name contains whitespace, each internal sequence of whitespace will be
 changed into a single space, while leading or trailing whitespace will be
-discarded.  Also, the name cannot be "global" as that exact name indicates that
-global parameters follow (see above).
+discarded.
+.P
+There is also a special module name of "[global]" that does not define a module
+but instead switches back to the global settings context where default
+parameters can be specified.  Because each defined module gets its full set of
+parameters as a combination of the default values that are set at that position
+in the config file plus its own parameter list, the use of a "[global]" section
+can help to maintain shared config values for multiple modules.
 .P
-As with GLOBAL PARAMETERS, you may use references to environment variables in
-the values of parameters.  See the GLOBAL PARAMETERS section for more details.
+As with GLOBAL PARAMETERS, you may use references to environment variables
+in the values of parameters.  See that section for details.
 .P
 .IP "\fBcomment\fP"
 This parameter specifies a description string that is displayed next to the
@@ -1021,7 +1027,7 @@ before it begins.  Any output from the \fBpre-xfer\ exec\fP command on stdout
 \fInot\fP displayed if the script returns success.  The other programs cannot
 send any text to the user.  All output except for the \fBpre-xfer\ exec\fP
 stdout goes to the corresponding daemon's stdout/stderr, which is typically
-discarded.  See the \fB\-\-no-detatch\fP option for a way to see the daemon's
+discarded.  See the \fB\-\-no-detach\fP option for a way to see the daemon's
 output, which can assist with debugging.
 .IP
 Note that the \fBearly\ exec\fP command runs before any part of the transfer
@@ -1284,19 +1290,25 @@ susan:herpass
 .SH "BUGS"
 .P
 Please report bugs! The rsync bug tracking system is online at
-https://rsync.samba.org/.
+.UR https://rsync.samba.org/
+.UE .
 .P
 .SH "VERSION"
 .P
-This manpage is current for version 3.2.7 of rsync.
+This manpage is current for version 3.3.0 of rsync.
 .P
 .SH "CREDITS"
 .P
 Rsync is distributed under the GNU General Public License.  See the file
 COPYING for details.
 .P
-An rsync web site is available at https://rsync.samba.org/ and its github
-project is https://github.com/WayneD/rsync.
+An rsync web site is available at
+.UR https://rsync.samba.org/
+.UE
+and its github
+project is
+.UR https://github.com/WayneD/rsync
+.UE .
 .P
 .SH "THANKS"
 .P
@@ -1310,4 +1322,5 @@ people have later contributed to it. It is currently maintained by Wayne
 Davison.
 .P
 Mailing lists for support and development are available at
-https://lists.samba.org/.
+.UR https://lists.samba.org/
+.UE .