Introduction to Library Functions                     librsync(3)



NAME
     librsync - library for delta compression of streams

SYNOPSYS
      #include 
      #include 
      #include 

      cc ... -lrsync


DESCRIPTION
     The librsync library implements network delta-compression of
     streams and files.  The algorithm is similar to that used in
     the rsync(1) and xdelta(2)  programs,  but  specialized  for
     transfer  of  arbitrary-length  octet  streams.  Unlike most
     diff programs, librsync does not require access to  both  of
     the  files  on  the  same  machine,  but rather only a short
     ``signature'' of the old file and the complete  contents  of
     the new file.

     The canonical use of librsync is in the rproxy(8)  reference
     implementation  of the rsync proposed extension to HTP.  It
     may be useful to other programs  which  wish  to  do  delta-
     compression  in  HTP,  or within their own protocol.  There
     are HTP-specific utility  functions  within  librsync,  but
     they need not be used.

     A number of tools such as rdiff(1) provide command-line  and
     scriptable access to rsync functions.

SEE ALSO
     rdiff(1)

     rdiff and librsync Manual

     http:/rproxy.sourceforge.net/                            or
     http:/linuxcare.com.au/rproxy/.

     /usr/share/doc/librsync-0.9.7

     draft-pool-rsync

BUGS
     The rsync protocol is still evolving.  There may be bugs  in
     the implementation.  The interface may change in the future,
     but it is becoming more stable.

     Many routines will  panic  in  case  of  error  rather  than
     returning  an error code to the caller.  Patches to fix this
     are welcome, but at the current state of development  abort-
     ing  seems  as  useful  as  trusting  to possibly-incomplete



Martin Pool Last change: $Date: 2003/06/12 06:03:32 $           1






Introduction to Library Functions                     librsync(3)



     checking in the client.

AUTHOR
     Martin   Pool   ,   with   Andrew    Tridgell
     .

     rdiff development has been supported by Linuxcare,  Inc  and
     VA Linux Systems.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     
       ATRIBUTE TYPE     ATRIBUTE VALUE
    
     Availability         SUNWlibrsync   
    
     Interface Stability  Volatile       
    

NOTES
     Source for librsync is available on http:/opensolaris.org.
































Martin Pool Last change: $Date: 2003/06/12 06:03:32 $           2