readme.djg
1DJGPP Port of XDelta 1.1.2
2~~~~~~~~~~~~~~~~~~~~~~~~~~
3
4Installing the Binary Package
5-----------------------------
6
7Unzip the distribution preserving the directory structure - use PKUNZIP's -d
8option; use an equivalent option with other unzippers. Unzip into the top
9DJGPP installation directory, e.g. c:\djgpp.
10
11XDelta should now be ready for use. A man page for XDelta is provided - use:
12
13 man xdelta
14
15to view it. You will need to have installed the man program from the v2apps/
16directory of the DJGPP archive for this to work.
17
18Installing the Source Package
19-----------------------------
20
21You should only install the source package if you want to rebuild XDelta from
22the sources. To build the port, I used the following packages:
23
24. DJGPP 2.03
25. GNU bash 2.04
26. GNU gcc 2.95.3
27. GNU binutils 2.11.2
28. GNU sed 3.02
29. GNU awk 3.0.3
30. GNU fileutils 4.0
31. GNU shellutils 1.12
32. GNU textutils 2.0
33. glib 1.2.10
34. zlib 1.1.3
35
36It may be possible to build XDelta with other versions of each package, but
37this has not been tested.
38
39Unzip the distribution preserving the directory structure - use PKUNZIP's -d
40option; use an equivalent option with other unzippers. Unzip into the top
41DJGPP installation directory, e.g. c:\djgpp.
42
43No changes were needed to XDelta to make it work with DJGPP.
44
45Before building XDelta, it must be configured. This is done from bash
46in the source directory using:
47
48 ./configure --disable-shared
49
50The parameter '--disable-shared' is needed to get round a bug in
51libtool 1.4. libtool tries to use gcc's '-fPIC' option, which produces
52code that binutils does not understand (for DJGPP). '-fPIC' is used
53for generating relocatable code for dynamic linking. Since DJGPP does not
54support dynamic linking, we can use '--disable-shared' to stop '-fPIC'
55from being used.
56
57For more information on the libtool problem, please see the following
58post on djgpp-workers:
59
60http://www.delorie.com/djgpp/mail-archives/browse.cgi?p=djgpp-workers/2001/06/18/16:32:47
61
62You may wish to install XDelta somewhere else. In that case, use
63the '--prefix' option, e.g.
64
65 ./configure --disable-shared --prefix=/where/i/want/xdelta
66
67Once this has compelted, build using:
68
69 make
70
71If these compelte successfully, XDelta and its libraries can be installed
72using:
73
74 make install
75
76Some notes on using XDelta
77--------------------------
78
79* XDelta is fairly simple - to see what options are available, use:
80
81 xdelta --help
82
83* The '-p' or '--pristine' option prevents XDelta from using gzip
84 compression, this avoids creating temporary files. This option
85 is presented because gzip does not support exact re-compression,
86 since there is no way to save the configuration used to produce
87 a particular gzip file.
88
89* XDelta's buffers are sized (by default) according to the amount of
90 free physical memory. It defaults to using 87.5% (7/8) of
91 the available memory.
92
93 Under Windows this sometimes does not detect the amount of
94 free memory correctly (well, on this author's machine at least).
95 Sometimes it was necessary to tell xdelta what amount of memory
96 to use:
97
98 xdelta patch --maxmem=32M ...
99
100 NB: More memory means faster patching, with large patches & files.
101
102 It is recommend you run XDelta in verbose mode, to see how much
103 memory it is using:
104
105 xdelta patch -V ...
106
107libxdelta and libedsio
108----------------------
109
110XDelta is actually just a front-end for two libraries - libxdelta
111and libedsio. libxdelta is a library for handling XDelta-format deltas.
112libedsio is a library for handling serialised I/O. Both these libraries are
113included in the port and can be used in your own programs.
114
115Unfortunately, there is no documentation for these libraries - the only
116reference is the source code. If you are interested in libxdelta and libedsio,
117please download the source distribution. Please note that I am not familiar
118with these libraries and I will not be able to answer any queries on them.
119
120libxdelta and libedsio come with *-config files, which return compilation
121and linking parameters. They are similar to glib-config. Example:
122
123 bash-2.04$ xdelta-config --cflags
124 -I/dev/env/DJDIR/lib/glib/include -I/dev/env/DJDIR/include
125 bash-2.04$ $DJDIR/bin/xdelta-config --libs
126 -L/dev/env/DJDIR/lib -lxdelta -ledsio -lglib
127
128Finally
129-------
130
131If you have any comments or problems with this port, please feel free to
132e-mail me. I hope this port is useful.
133
134Thanks, bye,
135
136Richard Dawe <rich@phekda.freeserve.co.uk> 2001-10-05
137