mirror of
https://github.com/RsyncProject/rsync.git
synced 2026-05-02 03:55:48 -04:00
Replace startdit|enddit with description for newer yodl.
Fixes bug 13115.
This commit is contained in:
37
rsync.yo
37
rsync.yo
@@ -494,7 +494,8 @@ command-line parsing. Keep in mind that a leading tilde (~) in a filename is
|
||||
substituted by your shell, so --option=~/foo will not change the tilde into
|
||||
your home directory (remove the '=' for that).
|
||||
|
||||
startdit()
|
||||
description(
|
||||
|
||||
dit(bf(--help)) Print a short help page describing the options
|
||||
available in rsync and exit. For backward-compatibility with older
|
||||
versions of rsync, the help will also be output if you use the bf(-h)
|
||||
@@ -909,6 +910,9 @@ There is also a backward-compatibility helper option, bf(--old-dirs) (or
|
||||
bf(--old-d)) that tells rsync to use a hack of "-r --exclude='/*/*'" to get
|
||||
an older rsync to list a single directory without recursing.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(-l, --links)) When symlinks are encountered, recreate the
|
||||
symlink on the destination.
|
||||
|
||||
@@ -975,6 +979,9 @@ This works because rsync calls bf(lstat)(2) on the source arg as given, and the
|
||||
trailing slash makes bf(lstat)(2) follow the symlink, giving rise to a directory
|
||||
in the file-list which overrides the symlink found during the scan of "src/./".
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(-K, --keep-dirlinks)) This option causes the receiving side to treat
|
||||
a symlink to a directory as though it were a real directory, but only if it
|
||||
matches a real directory from the sender. Without this option, the
|
||||
@@ -1346,6 +1353,9 @@ bf(--copy-unsafe-links)), a symlink to a directory on another device is
|
||||
treated like a mount-point. Symlinks to non-directories are unaffected
|
||||
by this option.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(--existing, --ignore-non-existing)) This tells rsync to skip
|
||||
creating files (including directories) that do not exist
|
||||
yet on the destination. If this option is
|
||||
@@ -1769,6 +1779,9 @@ between adjacent entries. If the input is not sorted, some path elements
|
||||
(implied directories) may end up being scanned multiple times, and rsync will
|
||||
eventually unduplicate them after they get turned into file-list elements.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(-0, --from0)) This tells rsync that the rules/filenames it reads from a
|
||||
file are terminated by a null ('\0') character, not a NL, CR, or CR+LF.
|
||||
This affects bf(--exclude-from), bf(--include-from), bf(--files-from), and any
|
||||
@@ -2309,6 +2322,9 @@ and a hash (#), followed by exactly 3 octal digits. For example, a newline
|
||||
would output as "\#012". A literal backslash that is in a filename is not
|
||||
escaped unless it is followed by a hash and 3 digits (0-9).
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(-h, --human-readable)) Output numbers in a more human-readable format.
|
||||
There are 3 possible levels: (1) output numbers with a separator between each
|
||||
set of 3 digits (either a comma or a period, depending on if the decimal point
|
||||
@@ -2600,6 +2616,9 @@ file previously generated by bf(--write-batch).
|
||||
If em(FILE) is bf(-), the batch data will be read from standard input.
|
||||
See the "BATCH MODE" section for details.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(--protocol=NUM)) Force an older protocol version to be used. This
|
||||
is useful for creating a batch file that is compatible with an older
|
||||
version of rsync. For instance, if rsync 2.6.4 is being used with the
|
||||
@@ -2656,13 +2675,14 @@ applications that want repeatable block checksums, or in the case where the
|
||||
user wants a more random checksum seed. Setting NUM to 0 causes rsync to use
|
||||
the default of code(time()) for checksum seed.
|
||||
|
||||
enddit()
|
||||
)
|
||||
|
||||
manpagesection(DAEMON OPTIONS)
|
||||
|
||||
The options allowed when starting an rsync daemon are as follows:
|
||||
|
||||
startdit()
|
||||
description(
|
||||
|
||||
dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The
|
||||
daemon you start running may be accessed using an rsync client using
|
||||
the bf(host::module) or bf(rsync://host/module/) syntax.
|
||||
@@ -2742,7 +2762,8 @@ is the case.
|
||||
|
||||
dit(bf(-h, --help)) When specified after bf(--daemon), print a short help
|
||||
page describing the options available for starting an rsync daemon.
|
||||
enddit()
|
||||
|
||||
)
|
||||
|
||||
manpagesection(FILTER RULES)
|
||||
|
||||
@@ -3387,7 +3408,7 @@ show why each individual file is included or excluded.
|
||||
|
||||
manpagesection(EXIT VALUES)
|
||||
|
||||
startdit()
|
||||
description(
|
||||
dit(bf(0)) Success
|
||||
dit(bf(1)) Syntax or usage error
|
||||
dit(bf(2)) Protocol incompatibility
|
||||
@@ -3411,11 +3432,11 @@ dit(bf(24)) Partial transfer due to vanished source files
|
||||
dit(bf(25)) The --max-delete limit stopped deletions
|
||||
dit(bf(30)) Timeout in data send/receive
|
||||
dit(bf(35)) Timeout waiting for daemon connection
|
||||
enddit()
|
||||
)
|
||||
|
||||
manpagesection(ENVIRONMENT VARIABLES)
|
||||
|
||||
startdit()
|
||||
description(
|
||||
dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
|
||||
ignore patterns in .cvsignore files. See the bf(--cvs-exclude) option for
|
||||
more details.
|
||||
@@ -3440,7 +3461,7 @@ are used to determine the default username sent to an rsync daemon.
|
||||
If neither is set, the username defaults to "nobody".
|
||||
dit(bf(HOME)) The HOME environment variable is used to find the user's
|
||||
default .cvsignore file.
|
||||
enddit()
|
||||
)
|
||||
|
||||
manpagefiles()
|
||||
|
||||
|
||||
@@ -93,7 +93,8 @@ 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 %%.
|
||||
|
||||
startdit()
|
||||
description(
|
||||
|
||||
dit(bf(motd file)) This parameter allows you to specify a
|
||||
"message of the day" to display to clients on each connect. This
|
||||
usually contains site information and any legal notices. The default
|
||||
@@ -126,7 +127,7 @@ via the bf(--sockopts) command-line option.
|
||||
dit(bf(listen backlog)) You can override the default backlog value when the
|
||||
daemon listens for connections. It defaults to 5.
|
||||
|
||||
enddit()
|
||||
)
|
||||
|
||||
manpagesection(MODULE PARAMETERS)
|
||||
|
||||
@@ -144,7 +145,7 @@ global parameters follow (see above).
|
||||
As with GLOBAL PARAMETERS, you may use references to environment variables in
|
||||
the values of parameters. See the GLOBAL PARAMETERS section for more details.
|
||||
|
||||
startdit()
|
||||
description(
|
||||
|
||||
dit(bf(comment)) This parameter specifies a description string
|
||||
that is displayed next to the module name when clients obtain a list
|
||||
@@ -233,7 +234,7 @@ A chroot-enabled module should not have this parameter enabled unless you've
|
||||
taken steps to ensure that the module has the necessary resources it needs
|
||||
to translate names, and that it is not possible for a user to change those
|
||||
resources. That includes being the code being able to call functions like
|
||||
code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam())).
|
||||
code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam()).
|
||||
You should test what libraries and config files are required for your OS
|
||||
and get those setup before starting to test name mapping in rsync.
|
||||
|
||||
@@ -371,6 +372,9 @@ default is for this parameter to be disabled.
|
||||
Helpful hint: you probably want to specify "refuse options = delete" for a
|
||||
write-only module.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(list)) This parameter determines whether this module is
|
||||
listed when the client asks for a listing of available modules. In addition,
|
||||
if this is false, the daemon will pretend the module does not exist
|
||||
@@ -572,6 +576,9 @@ than the one that the rsync daemon is running under. If "strict modes" is
|
||||
false, the check is not performed. The default is true. This parameter
|
||||
was added to accommodate rsync running on the Windows operating system.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(hosts allow)) This parameter allows you to specify a list of comma-
|
||||
and/or whitespace-separated patterns that are matched against a connecting
|
||||
client's hostname and IP address. If none of the patterns match, then the
|
||||
@@ -712,6 +719,9 @@ Note that some of the logged output changes when talking with older
|
||||
rsync versions. For instance, deleted files were only output as verbose
|
||||
messages prior to rsync 2.6.4.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(timeout)) This parameter allows you to override the
|
||||
clients choice for I/O timeout for this module. Using this parameter you
|
||||
can ensure that rsync won't wait on a dead client forever. The timeout
|
||||
@@ -759,6 +769,9 @@ of file suffixes that are not compressed by default. Specifying a value
|
||||
for the "dont compress" parameter changes the default when the daemon is
|
||||
the sender.
|
||||
|
||||
)
|
||||
description(
|
||||
|
||||
dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run
|
||||
before and/or after the transfer. If the bf(pre-xfer exec) command fails, the
|
||||
transfer is aborted before it begins. Any output from the script on stdout (up
|
||||
@@ -799,7 +812,7 @@ Even though the commands can be associated with a particular module, they
|
||||
are run using the permissions of the user that started the daemon (not the
|
||||
module's uid/gid setting) without any chroot restrictions.
|
||||
|
||||
enddit()
|
||||
)
|
||||
|
||||
manpagesection(CONFIG DIRECTIVES)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user