diff options
author | Ben Elliston <bje@air.net.au> | 2002-01-25 21:25:34 +0000 |
---|---|---|
committer | Ben Elliston <bje@air.net.au> | 2002-01-25 21:25:34 +0000 |
commit | b74508c31238ba61d1947601ba8c777c593790f7 (patch) | |
tree | 2387c388cc860c3bd661251fb1b0fe137fa955f4 /doc/librsync.3 | |
parent | 36a3c60e724b140abdf2551bbb7bd1ed10c005db (diff) | |
download | librsync-b74508c31238ba61d1947601ba8c777c593790f7.tar.gz |
* doc/Makefile.am: New file.
* Doxyfile: Move from here ..
* doc/Doxyfile.in: .. to here (with added substitutions).
* codeheader.c: Move from here ..
* doc/codeheader.c: .. to here.
* codeheader.man: Move from here ..
* doc/codeheader.man: .. to here.
* codeheader.sh: Move from here ..
* doc/codeheader.sh: .. to here.
* doyxgen.css: Move from here ..
* doc/doxygen.css: .. to here.
* extra.dox: Move from here ..
* doc/extra.dox: .. to here.
* header.html: Move from here ..
* doc/header.html: .. to here.
* librsync.3: Move from here ..
* doc/librsync.3: .. to here.
* main.dox: Move from here ..
* doc/main.dox: .. to here.
* rdiff.1: Move from here ..
* doc/rdiff.1: .. to here.
* rdiff.dox: Move from here ..
* doc/rdiff.dox: .. to here.
* rproxy-small-logo.png: Move from here ..
* doc/rproxy-small-logo.png: .. to here.
Diffstat (limited to 'doc/librsync.3')
-rw-r--r-- | doc/librsync.3 | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/librsync.3 b/doc/librsync.3 new file mode 100644 index 0000000..b6b8e2e --- /dev/null +++ b/doc/librsync.3 @@ -0,0 +1,72 @@ +.\" +.\" librsync -- dynamic caching and delta update in HTTP +.\" $Id$ +.\" +.\" Copyright (C) 2000, 2001 by Martin Pool <mbp@samba.org> +.\" +.\" This program is free software; you can redistribute it and/or +.\" modify it under the terms of the GNU Lesser General Public License +.\" as published by the Free Software Foundation; either version 2.1 of +.\" the License, or (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, but +.\" WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +.\" Lesser General Public License for more details. +.\" +.\" You should have received a copy of the GNU Lesser General Public +.\" License along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.TH librsync 3 "$Date$" "Martin Pool" +.SH NAME +librsync \- library for delta compression of streams +.SH SYNOPSYS + #include \fB<stdio.h>\fP +.br + #include \fB<stdlib.h>\fP +.br + #include \fB<rsync.h>\fP + + cc ... \fB-lrsync\fP + +.SH DESCRIPTION +The \fBlibrsync\fP library implements network delta-compression of +streams and files. The algorithm is similar to that used in the +\fBrsync(1)\fP and \fBxdelta(2)\fP programs, but specialized for +transfer of arbitrary-length octet streams. Unlike most diff +programs, \fBlibrsync\fP 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. +.PP +The canonical use of \fBlibrsync\fP is in the \fBrproxy(8)\fP +reference implementation of the \fIrsync\fP proposed extension to +HTTP. It may be useful to other programs which wish to do +delta-compression in HTTP, or within their own protocol. There are +HTTP-specific utility functions within \fBlibrsync\fP, but they need +not be used. +.PP +A number of tools such as \fBrdiff(1)\fP provide command-line and +scriptable access to rsync functions. +.SH "SEE ALSO" +.BR rdiff "(1)" +.PP +.I rdiff and librsync Manual +.PP +\fIhttp://rproxy.sourceforge.net/\fP or \fIhttp://linuxcare.com.au/rproxy/\fP. +.PP +\fIdraft-pool-rsync\fP +.SH 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. +.PP +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 aborting seems as useful as trusting to +possibly-incomplete checking in the client. +.SH "AUTHOR" +Martin Pool <mbp@samba.org>, with Andrew Tridgell <tridge@samba.org>. +.PP +rdiff development has been supported by Linuxcare, Inc and VA Linux +Systems. |