to try to build some hardware-accelerated checksum routines. Rsync also needs
a modern awk, which might be provided via gawk or nawk on some OSes.
-## Autoconf & man pages
+## Autoconf & manpages
If you're installing from the git repo (instead of a release tar file) you'll
also need the GNU autotools (autoconf & automake) and your choice of 2 python3
-markdown libraries: cmarkgfm or commonmark (needed to generate the man pages).
+markdown libraries: cmarkgfm or commonmark (needed to generate the manpages).
If your OS doesn't provide a python3-cmarkgfm or python3-commonmark package,
you can run the following to install the commonmark python library for your
build user (after installing python3's pip package):
> ./md2man --test rsync-ssl.1.md
-Alternately, you can avoid generating the man pages by fetching the very latest
+Alternately, you can avoid generating the manpages by fetching the very latest
versions (that match the latest git source) from the [generated-files][6] dir.
One way to do that is to run:
If your rsync script depends on the old arg-splitting behavior, either run
it with the [`--old-args`](rsync.1#opt) option or `export RSYNC_OLD_ARGS=1`
in the script's environment. See also the [ADVANCED USAGE](rsync.1#)
- section of rsync's man page.
+ section of rsync's manpage.
- A long-standing bug was preventing rsync from figuring out the current
locale's decimal point character, which made rsync always output numbers
and `--delete*` rsync options on the server side.
- The log format has been tweaked slightly to add seconds to the timestamp
and to output the command executed as a tuple (making the args clearer).
- - An rrsync.1 man page was added (in the support dir with rrsync).
+ - An rrsync.1 manpage was added (in the support dir with rrsync).
- Added options to the lsh script to facilitate rrsync testing. (See the
support dir.)
- Try to support a client that sent a remote rsync a wacko stderr file handle
(such as an older File::RsyncP perl library used by BackupPC).
- - Lots of man page improvements, including better html versions.
+ - Lots of manpage improvements, including better HTML versions.
### PACKAGING RELATED:
- Give configure the `--with-rrsync` option if you want `make install` to
- install the (now python3) rrsync script and its new man page.
+ install the (now python3) rrsync script and its new manpage.
- If the rrsync script is installed, its package should be changed to depend
on python3 and the (suggested but not mandatory) python3 braceexpand lib.
- Put optimizations into their own list in the `--version` output.
- - Improved the man page a bit more.
+ - Improved the manpage a bit more.
### PACKAGING RELATED:
- The daemon now locks its pid file (when configured to use one) so that it
will not fail to start when the file exists but no daemon is running.
- - Various man page improvements, including some html representations (that
+ - Various manpage improvements, including some html representations (that
aren't installed by default).
- Made `-V` the short option for `--version` and improved its information.
- Add installed bash script: /usr/bin/rsync-ssl
- - Add installed man page: /usr/man/man1/rsync-ssl.1
+ - Add installed manpage: /usr/man/man1/rsync-ssl.1
- Tweak auxiliary doc file names, such as: README.md, INSTALL.md, & NEWS.md.
SIMD checksum optimizations.
- Add _build_ dependency for _either_ python3-cmarkcfm or python3-commonmark
- to allow for patching of man pages or building a git release. This is not
- required for a release-tar build, since it comes with pre-built man pages.
+ to allow for patching of manpages or building a git release. This is not
+ required for a release-tar build, since it comes with pre-built manpages.
Note that cmarkcfm is faster than commonmark, but they generate the same
data. The commonmark dependency is easiest to install since it's native
python, and can even be installed via `pip3 install --user commonmark` if
- Silenced some annoying warnings about major() & minor() by improving an
autoconf include-file check.
- - Converted the man pages from yodl to markdown. They are now processed via a
+ - Converted the manpages from yodl to markdown. They are now processed via a
simple python3 script using the cmarkgfm **or** commonmark library. This
should make it easier to package rsync, since yodl is rather obscure.
### DEVELOPER RELATED:
- - Tweak the `make` output when yodl isn't around to create the man pages.
+ - Tweak the `make` output when yodl isn't around to create the manpages.
- Changed an obsolete autoconf compile macro.
- - Support newer yodl versions when converting man pages.
+ - Support newer yodl versions when converting manpages.
------------------------------------------------------------------------------
- Avoid trying to reference `SO_BROADCAST` if the OS doesn't support it.
- - Fix some issues with the post-processing of the man pages.
+ - Fix some issues with the post-processing of the manpages.
- Fixed the user home-dir handling in the lsh script. (See the support dir.)
of files, and the ensuring that daemon excludes can't affect a dot-dir arg.
- Improved some build rules for those that build in a separate directory from
- the source, including better install rules for the man pages, and the fixing
+ the source, including better install rules for the manpages, and the fixing
of a proto.h-tstamp rule that could make the binaries get rebuild without
cause.
- Added the `--log-file=FILE` and `--log-file-format=FORMAT` options. These
can be used to tell any rsync to output what it is doing to a log file.
- They work with a client rsync, a non-daemon server rsync (see the man page
+ They work with a client rsync, a non-daemon server rsync (see the manpage
for instructions), and also allows the overriding of rsyncd.conf settings
when starting a daemon.
- Added two config items to the rsyncd.conf parsing: `pre-xfer exec` and
`post-xfer exec`. These allow a command to be specified on a per-module
basis that will be run before and/or after a daemon-mode transfer. (See the
- man page for a list of the environment variables that are set with
+ manpage for a list of the environment variables that are set with
information about the transfer.)
- When using the `--relative` option, you can now insert a dot dir in the
usually run with the `--no-detach` option that was necessary to see the
error on stderr).
- - The man pages now consistently refer to an rsync daemon as a `daemon`
+ - The manpages now consistently refer to an rsync daemon as a `daemon`
instead of a `server` (to distinguish it from the server process in a
non-daemon transfer).
without using a temporary file. The matching of existing data in the
destination file can be severely limited by this, but there are also cases
where this is more efficient (such as appending data). Use only when needed
- (see the man page for more details).
+ (see the manpage for more details).
- Added the `write only` option for the daemon's config file.
- Added long-option names for `-4` and `-6` (namely `--ipv4` and `--ipv6`) and
- documented all these options in the man page.
+ documented all these options in the manpage.
- Improved the handling of the `--bwlimit` option so that it's less bursty,
more accurate, and works properly over a larger range of values.
### BUILD CHANGES:
- Added a `gen` target to rebuild most of the generated files, including
- configure, config.h.in, the man pages, and proto.h.
+ configure, config.h.in, the manpages, and proto.h.
- If `make proto` doesn't find some changes in the prototypes, the proto.h
file is left untouched (its time-stamp used to always be updated).
- Added `--no-whole-file` and `--no-blocking-io` options (Dave Dykstra)
- Made the `--write-batch` and `--read-batch` options actually work and added
- documentation in the man page (Jos Backus)
+ documentation in the manpage (Jos Backus)
- If the daemon is unable to fork a child to accept a connection, print an
error message. (Colin Walters)
-------------
Rsync can also talk to "rsync daemons" which can provide anonymous or
-authenticated rsync. See the rsyncd.conf(5) man page for details on how
-to setup an rsync daemon. See the rsync(1) man page for info on how to
+authenticated rsync. See the rsyncd.conf(5) manpage for details on how
+to setup an rsync daemon. See the rsync(1) manpage for info on how to
connect to an rsync daemon.
if (remote_protocol < MIN_PROTOCOL_VERSION
|| remote_protocol > MAX_PROTOCOL_VERSION) {
rprintf(FERROR,"protocol version mismatch -- is your shell clean?\n");
- rprintf(FERROR,"(see the rsync man page for an explanation)\n");
+ rprintf(FERROR,"(see the rsync manpage for an explanation)\n");
exit_cleanup(RERR_PROTOCOL);
}
if (remote_protocol < OLD_PROTOCOL_VERSION) {
CFLAGS="$CFLAGS -pg"
fi
-AC_MSG_CHECKING([if md2man can create man pages])
+AC_MSG_CHECKING([if md2man can create manpages])
if test x"$ac_cv_path_PYTHON3" = x; then
AC_MSG_RESULT(no - python3 not found)
md2man_works=no
AC_MSG_CHECKING([if we require man-page building])
AC_ARG_ENABLE([md2man],
- AS_HELP_STRING([--disable-md2man],[disable to omit man page creation]))
+ AS_HELP_STRING([--disable-md2man],[disable to omit manpage creation]))
if test x"$enable_md2man" != x"no"; then
if test -f "$srcdir/rsync.1"; then
AC_MSG_RESULT(optional)
AC_MSG_RESULT(required)
if test x"$md2man_works" = x"no"; then
err_msg="$err_msg$nl- You need python3 and either the cmarkgfm OR commonmark python3 lib in order"
- err_msg="$err_msg$nl to build man pages based on the git source (man pages are included in the"
+ err_msg="$err_msg$nl to build manpages based on the git source (manpages are included in the"
err_msg="$err_msg$nl official release tar files)."
no_lib="$no_lib md2man"
fi
fi
AC_ARG_WITH(rrsync,
- AS_HELP_STRING([--with-rrsync],[also install the rrsync script and its man page]))
+ AS_HELP_STRING([--with-rrsync],[also install the rrsync script and its manpage]))
if test x"$with_rrsync" != x"yes"; then
with_rrsync=no
else
echo "$err_msg"
echo ""
echo "See the INSTALL file for hints on how to install the missing libraries and/or"
- echo "how to generate (or fetch) man pages:"
+ echo "how to generate (or fetch) manpages:"
echo " https://github.com/WayneD/rsync/blob/master/INSTALL.md"
echo ""
echo "To disable one or more features, the relevant configure options are:"
fi = argparse.Namespace(**fi.groupdict())
fi.want_manpage = not not fi.sect
if fi.want_manpage:
- fi.title = fi.prog + '(' + fi.sect + ') man page'
+ fi.title = fi.prog + '(' + fi.sect + ') manpage'
else:
fi.title = fi.prog + ' for rsync'
st.txt += BOLD_FONT[0]
elif tag == 'em' or tag == 'i':
if st.want_manpage:
- tag = 'u' # Change it into underline to be more like the man page
+ tag = 'u' # Change it into underline to be more like the manpage
st.txt += UNDR_FONT[0]
elif tag == 'ol':
start = 1
add_to_txt = NORM_FONT[0]
elif tag == 'em' or tag == 'i':
if st.want_manpage:
- tag = 'u' # Change it into underline to be more like the man page
+ tag = 'u' # Change it into underline to be more like the manpage
add_to_txt = NORM_FONT[0]
elif tag == 'ol' or tag == 'ul':
if st.list_state.pop() == 'dl':
#
# build build the config files [the default w/no arg]
# fetch fetch the latest dev autoconfig files
-# fetchgen fetch all the latest dev generated files (including man pages)
+# fetchgen fetch all the latest dev generated files (including manpages)
# fetchSRC fetch the latest dev source files [NON-GENERATED FILES]
#
# The script stops after the first successful action.
rsync-ssl [--type=SSL_TYPE] RSYNC_ARGS
```
-The online version of this man page (that includes cross-linking of topics)
+The online version of this manpage (that includes cross-linking of topics)
is available at <https://download.samba.org/pub/rsync/rsync-ssl.1>.
## DESCRIPTION
## VERSION
-This man page is current for version @VERSION@ of rsync.
+This manpage is current for version @VERSION@ of rsync.
## CREDITS
Usages with just one SRC arg and no DEST arg will list the source files instead
of copying.
-The online version of this man page (that includes cross-linking of topics)
+The online version of this manpage (that includes cross-linking of topics)
is available at <https://download.samba.org/pub/rsync/rsync.1>.
## DESCRIPTION
daemon already running (or it needs to have configured something like inetd to
spawn an rsync daemon for incoming connections on a particular port). For full
information on how to start a daemon that will handling incoming socket
-connections, see the [**rsyncd.conf**(5)](rsyncd.conf.5) man page -- that is
+connections, see the [**rsyncd.conf**(5)](rsyncd.conf.5) manpage -- that is
the config file for the daemon, and it contains the full details for how to run
the daemon (including stand-alone and inetd configurations).
## OPTION SUMMARY
Here is a short summary of the options available in rsync. Each option also
-has its own detailed description later in this man page.
+has its own detailed description later in this manpage.
[comment]: # (help-rsync.h)
[comment]: # (Keep these short enough that they'll be under 80 chars when indented by 7 chars.)
One side-effect of incremental recursion is that any missing
sub-directories inside a recursively-scanned directory are (by default)
created prior to recursing into the sub-dirs. This earlier creation point
- (commpared to a non-incremental recursion) allows rsync to then set the
+ (compared to a non-incremental recursion) allows rsync to then set the
modify time of the finished directory right away (without having to delay
that until a bunch of recursive copying has finished). However, these
early directories don't yet have their completed mode, mtime, or ownership
A caution for those that choose to combine [`--inplace`](#opt) with
`--update`: an interrupted transfer will leave behind a partial file on the
receiving side that has a very recent modified time, so re-running the
- transfer will probably **not** continue the interrutped file. As such, it
+ transfer will probably **not** continue the interrupted file. As such, it
is usually best to avoid combining this with[ `--inplace`](#opt) unless you
- have implemented manual steps to handle any interrutped in-progress files.
+ have implemented manual steps to handle any interrupted in-progress files.
0. `--inplace`
0. `--no-whole-file`, `--no-W`
- Disable whole-file updating when it is enaled by default for a local
+ Disable whole-file updating when it is enabled by default for a local
transfer. This usually slows rsync down, but it can be useful if you are
trying to minimize the writes to the destination file (if combined with
[`--inplace`](#opt)) or for testing the checksum-based update algorithm.
This option can provide endless fun for people who like to tune their
systems to the utmost degree. You can set all sorts of socket options
- which may make transfers faster (or slower!). Read the man page for the
+ which may make transfers faster (or slower!). Read the manpage for the
`setsockopt()` system call for details on some of the options you may be
able to set. By default no special socket options are set. This only
affects direct socket connections to a remote rsync daemon.
socket when directly contacting an rsync daemon, as well as the forwarding
of the `-4` or `-6` option to ssh when rsync can deduce that ssh is being
used as the remote shell. For other remote shells you'll need to specify
- the "`--rsh SHELL -4`" option directly (or whatever ipv4/ipv6 hint options
+ the "`--rsh SHELL -4`" option directly (or whatever IPv4/IPv6 hint options
it uses).
See also [the daemon version of these options](#dopt--ipv4).
background daemon. The daemon will read the config file (rsyncd.conf) on
each connect made by a client and respond to requests accordingly.
- See the [**rsyncd.conf**(5)](rsyncd.conf.5) man page for more details.
+ See the [**rsyncd.conf**(5)](rsyncd.conf.5) manpage for more details.
0. `--address=ADDRESS`
no matching pattern is found, then the filename is not skipped.
Aside: because the interactions of filter rules can be complex, it is useful to
-use the `--debug=FILTER` option if things aren't working they way you expect.
+use the `--debug=FILTER` option if things aren't working the way you expect.
The level-1 output (the default if no level number is specified) mentions the
filter rule that is first matched by each file in the transfer. It also warns
if a filter rule has trailing whitespace. The level-2 output mentions a lot
## VERSION
-This man page is current for version @VERSION@ of rsync.
+This manpage is current for version @VERSION@ of rsync.
## INTERNAL OPTIONS
rsyncd.conf
-The online version of this man page (that includes cross-linking of topics)
+The online version of this manpage (that includes cross-linking of topics)
is available at <https://download.samba.org/pub/rsync/rsyncd.conf.5>.
## DESCRIPTION
0. `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 is no motd file. This can be overridden by the
+ This parameter allows you to specify a "message of the day" (MOTD) to display
+ to clients on each connect. This usually contains site information and any
+ legal notices. The default is no MOTD file. This can be overridden by the
`--dparam=motdfile=FILE` command-line option when starting the daemon.
0. `pid file`
This parameter can provide endless fun for people who like to tune their
systems to the utmost degree. You can set all sorts of socket options which
- may make transfers faster (or slower!). Read the man page for the
+ may make transfers faster (or slower!). Read the manpage for the
**setsockopt()** system call for details on some of the options you may be
able to set. By default no special socket options are set. These settings
can also be specified via the `--sockopts` command-line option.
addresses which match the masked IP address will be allowed in.
- a hostname pattern using wildcards. If the hostname of the connecting IP
(as determined by a reverse lookup) matches the wildcarded name (using
- the same rules as normal unix filename matching), the client is allowed
+ the same rules as normal Unix filename matching), the client is allowed
in. This only works if "[reverse lookup](#)" is enabled (the default).
- a hostname. A plain hostname is matched against the reverse DNS of the
connecting IP (if "[reverse lookup](#)" is enabled), and/or the IP of the
## VERSION
-This man page is current for version @VERSION@ of rsync.
+This manpage is current for version @VERSION@ of rsync.
## CREDITS
#include "help-rsync.h"
rprintf(F,"\n");
rprintf(F,"Use \"rsync --daemon --help\" to see the daemon-mode command-line options.\n");
- rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) man pages for full documentation.\n");
+ rprintf(F,"Please see the rsync(1) and rsyncd.conf(5) manpages for full documentation.\n");
rprintf(F,"See https://rsync.samba.org/ for updates, bug reports, and answers\n");
}
#include "help-rsyncd.h"
rprintf(F,"\n");
rprintf(F,"If you were not trying to invoke rsync as a daemon, avoid using any of the\n");
- rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) man page.\n");
+ rprintf(F,"daemon-specific rsync options. See also the rsyncd.conf(5) manpage.\n");
}
const char *rsync_version(void)
git.samba.org / rsync.git / commitdiff