1librsync(3)                Library Functions Manual                librsync(3)
2
3
4

NAME

6       librsync - library for delta compression of streams
7

SYNOPSYS

9        #include <stdio.h>
10        #include <stdlib.h>
11        #include <librsync.h>
12
13        cc ... -lrsync
14
15

DESCRIPTION

17       The  librsync  library  implements network delta-compression of streams
18       and files.  The algorithm is similar to that used in the  rsync(1)  and
19       xdelta(2)  programs,  but  specialized for transfer of arbitrary-length
20       octet streams.  Unlike most diff programs, librsync  does  not  require
21       access  to  both  of  the  files on the same machine, but rather only a
22       short ``signature'' of the old file and the complete  contents  of  the
23       new file.
24
25       The canonical use of librsync is in the rproxy(8) reference implementa‐
26       tion of the rsync proposed extension to HTTP.   It  may  be  useful  to
27       other  programs  which  wish to do delta-compression in HTTP, or within
28       their own protocol.  There are HTTP-specific utility  functions  within
29       librsync, but they need not be used.
30
31       A  number of tools such as rdiff(1) provide command-line and scriptable
32       access to rsync functions.
33

SEE ALSO

35       rdiff(1)
36
37       rdiff and librsync Manual
38
39       http://rproxy.sourceforge.net/ or http://linuxcare.com.au/rproxy/.
40
41       draft-pool-rsync
42

BUGS

44       The rsync protocol is still evolving.  There may be bugs in the  imple‐
45       mentation.   The interface may change in the future, but it is becoming
46       more stable.
47
48       Many routines will panic in case of  error  rather  than  returning  an
49       error  code to the caller.  Patches to fix this are welcome, but at the
50       current state of development aborting seems as useful  as  trusting  to
51       possibly-incomplete checking in the client.
52

AUTHOR

54       Martin     Pool     <mbp@sourcefrog.net>,    with    Andrew    Tridgell
55       <tridge@samba.org>.
56
57       rdiff development has been supported by Linuxcare,  Inc  and  VA  Linux
58       Systems.
59
60
61
62Martin Pool                         $Date$                         librsync(3)
Impressum