Open-source project
RsyncProject/rsync avatar
RsyncProject/rsync

rsync sends the differences, and leaves the flags to the manpage

An open source utility that provides fast incremental file transfer. It also has useful features for backup and restore operations among many other use cases.

5,367 stars630 forksCNOASSERTION

At a glance

What is it?
A file copying tool written in C that ships the hard part in an algorithm and the details in manpages. The README covers the transport, the build and where to file bugs, and it stops there.
Who is it for?
Use rsync when you are moving large files across a link and bandwidth matters more than simplicity, and when you already have ssh access on both ends. Be aware that the README is an orientation, not a reference: the option list lives in rsync(1) and daemon setup in rsyncd.conf(5), and no day to day flag is named in the README itself.
Can I use it commercially?
Check first. The repository uses a licence we do not classify automatically, so read its LICENSE file before any commercial use.
Is it still maintained?
Yes. The repository received new commits within the last day.
What is it written in?
Mainly C, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • RsyncProject/rsync5,367 ★ · +131
Star history
Repository2026-09-232026-11-15
RsyncProject/rsync5.2k5.4k

131 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The delta algorithm is the whole point

Rsync is a file copying tool for both remote and local files, and the reason it is fast is a delta-transfer algorithm. Instead of shipping whole files, it sends just the differences across the link, and it does this without requiring both sets of files to be present at one end of the link beforehand. The README is candid about why that looks impossible at first glance: calculating diffs between two files normally needs local access to both, so the usual mental model of a diff tool does not apply here. If you want the details, the package includes a technical report describing the algorithm. That also tells you what the README will not do for you: this project points at its own documentation rather than restating the algorithm in prose.

It behaves like scp until you start reading options

The usage section is short because the option surface is enormous. You use rsync basically the way you use scp, with the difference that rsync has many additional options, and the complete list is one command away:

bash
rsync --help

Beyond that, the README sends you to the manpage, which is where the details live. Nothing about everyday flags is named in the README itself, so a reader looking for how to preview a transfer, exclude files, or preserve attributes will not find it here. The web site is the other stop: it carries a FAQ list, downloads, resources, and HTML versions of the manpages. In other words the README is a map with three or four pointers on it, and a newcomer has to decide for themselves which of those pages answers the question they came with.

ssh or rsh is the transport, and one of them is required

Rsync normally uses ssh or rsh to communicate with remote systems, and it does not need to be setuid nor any special privileges to install. There is one hard precondition: you must have a working ssh or rsh system. Without a transport on both ends there is nothing to do, which is the first thing to verify when a copy fails before it starts. ssh is the recommended one, for its security features. The alternative to a remote shell is daemon mode, where rsync listens on a socket. That is what public file distribution uses, and authentication and access control are available there. Setup details for a daemon live in the rsyncd.conf(5) manpage, while the rsync(1) manpage covers how to connect to one.

configure and make, plus the CC override for old gcc

Building from source is three steps. Running the configure script creates a Makefile and config.h appropriate for your system, then make produces the binary, and you put a copy of rsync in your search path on the local and remote systems, or use make install:

bash
./configure
make
make install

That path is not frictionless everywhere. On some systems you have to force configure not to use gcc, because gcc may not support features your system does support, and 64 bit file offsets are the example given. The fix is to set the environment variable CC to the name of your native compiler before running configure. If you build rsync yourself and want the maximum feature set, the INSTALL page in the repository is the place that lists which libraries and packages you can use.

The C sources name the features you are looking for

The top level of the repository is a readable index of what rsync does, because the file names are the feature names. Files like exclude.c, checksum.c, backup.c, delete.c, match.c, flist.c, generator.c and hlink.c cover the pattern matching, the checksums, the backup behaviour, deletion, hard link handling and the file list machinery. Others show how it is driven: clientserver.c, loadparm.c for parameters, log.c for output, and authenticate.c for the daemon side. ACL support sits in acls.c, and fileio.c and io.c hold the I/O paths. There are also the build generators (configure, configure.ac, config.guess, m4/) and documentation tooling such as help-from-md.awk, md-convert and maybe-make-man:

text
exclude.c
checksum.c
backup.c
delete.c
match.c
hlink.c
acls.c
clientserver.c

Two report addresses, and one for security

Bug reporting has its own page on the web site, with links to the current bug list and advice on how to write a report that gets acted on. Before filing, the README suggests two things you can do yourself: search for the error message you received, or look in the mailing list archives. That ordering matters, since the archives are searchable and many failures have known answers. Reports go to the instructions on the bug tracking page, or by email to the project's rsync mailing address. Security issues have their own route and should not go through the public list: the README asks for details of a security issue to be emailed to a separate project address. Real time discussion happens on a Discord server, and there are two mailing lists, an open discussion list where releases are announced and an announcement only list.

Wayne Davison maintained rsync from 2004 to 2024

The copyright section is where the project's history and its license meet. Rsync was originally written by Andrew Tridgell and Paul Mackerras, and the README singles out Wayne Davison, who maintained rsync from 2004 to 2024. A handover like that is worth checking against the release record before you depend on the tool. The record looks healthy: tags v3.5.1 on 21 September 2026, v3.5.0 on 13 August 2026 and v3.4.4 on 8 June 2026, with the last push on 30 October 2026. Licensing is GNU GPL, with the terms in the COPYING file in the distribution. The source is mirrored on GitHub and on Samba's own git server, and the download page lists the ways to grab it.

Editorial conclusion

Use rsync when you are moving large files across a link and bandwidth matters more than simplicity, and when you already have ssh access on both ends. Be aware that the README is an orientation, not a reference: the option list lives in rsync(1) and daemon setup in rsyncd.conf(5), and no day to day flag is named in the README itself. Before you build from source, read INSTALL.md for the optional libraries, check that your compiler supports large file offsets, and put a copy of the binary in the search path on both ends or your remote command will not be found.

Frequently asked questions

What is rsync used for, according to RsyncProject/rsync?

The repository calls rsync a fast file copying tool for both remote and local files, with useful features for backup and restore operations among other use cases. Its speed comes from a delta-transfer algorithm that sends just the differences across a link rather than whole files.

Is anything faster than rsync?

The README makes no comparison with other tools and offers no benchmarks. It argues the speed from the algorithm instead: a delta transfer brings remote files into sync very fast by sending only the differences, without needing both sets of files at one end of the link beforehand.

Does rsync exist on Windows?

Nothing in the README mentions Windows. What it covers is remote access through ssh or rsh, daemon mode listening on a socket, and building from source with the configure script followed by make, with an optional CC override when gcc lacks features such as 64 bit file offsets.

how to use rsync over ssh

Rsync normally uses ssh or rsh to communicate with remote systems, and you must have a working one of those on both ends. Using ssh is recommended for its security features. The complete option list comes from rsync --help, with the details in the rsync(1) manpage.

how to use rsync to copy files

You use rsync basically the way you use scp, except that rsync has many additional options. Type rsync --help for the full list of supported options, then read the manpage for the detail on each one.

how to install rsync

Run the configure script, which creates a Makefile and config.h appropriate for your system, then type make. Install by putting a copy of rsync in your search path on the local and remote systems, or by using make install. No special privileges are required and it does not need to be setuid.

Official sources

  1. Issues
  2. Project website
  3. README
  4. Releases
  5. RsyncProject/rsync on GitHub
Community

Where developers are discussing it

Posts on Hacker News, dev.to and Lobsters that link to this repository, found by our scan of those communities. 1 in the last 30 days; newest first.

Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/rsyncproject-rsync.svg)](https://hysenlabs.com/projects/rsyncproject-rsync)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/rsyncproject-rsync.svg)](https://hysenlabs.com/projects/rsyncproject-rsync)

Was this useful?