summaryrefslogtreecommitdiff
path: root/xdelta1/doc
diff options
context:
space:
mode:
Diffstat (limited to 'xdelta1/doc')
-rw-r--r--xdelta1/doc/Makefile.am3
-rw-r--r--xdelta1/doc/xdelta.1201
-rw-r--r--xdelta1/doc/xdelta.cat138
3 files changed, 0 insertions, 342 deletions
diff --git a/xdelta1/doc/Makefile.am b/xdelta1/doc/Makefile.am
deleted file mode 100644
index 062008a..0000000
--- a/xdelta1/doc/Makefile.am
+++ /dev/null
@@ -1,3 +0,0 @@
1man_MANS = xdelta.1
2
3EXTRA_DIST = xdelta.1 xdelta.cat
diff --git a/xdelta1/doc/xdelta.1 b/xdelta1/doc/xdelta.1
deleted file mode 100644
index 7bd0a8c..0000000
--- a/xdelta1/doc/xdelta.1
+++ /dev/null
@@ -1,201 +0,0 @@
1.ds p \&\s-1Xdelta\s0
2.if n .ds - \%--
3.if t .ds - \(em
4.if !\n(.g \{\
5. if !\w|\*(lq| \{\
6. ds lq ``
7. if \w'\(lq' .ds lq "\(lq
8. \}
9. if !\w|\*(rq| \{\
10. ds rq ''
11. if \w'\(rq' .ds rq "\(rq
12. \}
13.\}
14.de PE
15.sp \\n()Pu
16.ne 2
17.nf
18.IP
19..
20.de EP
21.fi
22.PP
23.sp \\n()Pu
24..
25.TH Xdelta 1
26.SH NAME
27xdelta \- Invoke Xdelta
28.SH SYNOPSIS
29.B xdelta
30.I subcommand
31[
32.IR option ".\|.\|.
33] [
34.IR operand .\|.\|.
35]
36.SH DESCRIPTION
37Xdelta provides the ability to generate deltas between a pair of files
38and later apply those deltas. It operates similar to the
39.B diff
40and
41.B patch
42commands, but works on binary files and does not produce a human
43readable output.
44.PP
45
46Xdelta has three subcommands, delta, patch, and info. Delta accepts
47two file versions and produces a delta, while patch accepts the
48original file version and delta and produces the second version. The
49info command prints useful information about a delta. Each subcommand
50will be detailed seperately.
51
52.SS Gzip processing
53Attempting to compute a delta between compressed input files usually
54results in poor compression. This is because small differences
55between the original contents causes changes in the compression of
56whole blocks of data. To simplify things, Xdelta implements a special
57case for
58.IR gzip (1)
59compressed files. If any version input to the delta command is
60recognized as having gzip compression, it will be automatically
61decompressed into a temporary location prior to comparison. This
62temporary location is either the value of the
63.IR TMPDIR
64environment variable, if set, otherwise "/tmp".
65
66The Xdelta patch header contains a flag indicating that the
67reconstructed version should be recompressed after applying the
68patch. In general, this allows Xdelta to operate transparently on
69gzip compressed inputs.
70
71There is one potential problem when automatically processing gzip
72compressed files, which is that the recompressed content does not
73always match byte-for-byte with the original compressed content. The
74uncompressed content still matches, but if there is an external
75integrity check such as cryptographic signature verification, it may
76fail. To prevent this from happening, the --pristine option disables
77automatic gzip processing.
78
79.SS MD5 integrity check
80By default, Xdelta always verifies the MD5 checksum of the files it
81reconstructs. This prevents you from supplying an incorrect input
82during patch, which would result in corrupt output. Because of this
83feature, you can feel confident that patch has produced valid results.
84The --noverify option disables MD5 verification, but this is only
85recommended for performance testing.
86
87.SS Compressed patch format
88Xdelta uses a fairly simple encoding for its delta, then applies zlib
89compression to the result. You should not have to post-compress an
90Xdelta delta.
91
92.SS Delta
93The delta subcommand has the following synopsis:
94
95.B xdelta
96.I delta
97[
98.IR option ".\|.\|.
99]
100.IR fromfile
101.IR tofile
102.IR patchout
103
104Computes a delta from
105.IR fromfile
106to
107.IR tofile
108and writes it to
109.IR patchout
110
111.SS Patch
112The patch subcommand has the following synopsis:
113
114.B xdelta
115.I patch
116[
117.IR option ".\|.\|.
118]
119.IR patchin
120[
121.IR fromfile
122[
123.IR tofile
124]]
125
126Applies
127.IR patchin
128to
129.IR fromfile
130and produces a reconstructed version of
131.IR tofile.
132
133If fromfile was omitted, Xdelta attempts to use the original fromfile
134name, which is stored in the delta. The from file must be identical
135to the one used to create the delta. If its length or MD5 checksum
136differs, patch will abort with an error message.
137
138If tofile was omitted, Xdelta attempts to use the original tofile
139name, which is also stored in the delta. If the original tofile name
140already exists, a unique filename extension will be added to avoid
141destroying any existing data.
142
143.SS Info
144The info subcommand has the following synopsis:
145
146.B xdelta
147.I info
148.IR patchinfo
149
150Prints information about
151.IR patchinfo
152and the version it reconstructs, including file names, lengths, and
153MD5 checksums.
154
155.SS Options
156
157.IP -0..9
158Set the zlib compression level. Zero indicates no compression. Nine
159indicates maximum compression.
160
161.IP "-h, --help"
162Print a short help message and exit.
163
164.IP "-q, --quiet"
165Quiet. Surpresses several warning messages.
166
167.IP "-v, --version"
168Print the Xdelta version number and exit.
169
170.IP "-V, --verbose"
171Verbose. Prints a bit of extra information.
172
173.IP "-n, --noverify"
174No verify. Turns off MD5 checksum verification of the input and
175output files.
176
177.IP "-m=SIZE, --maxmem=SIZE"
178Set an upper bound on the size of an in-memory page cache. For
179example, --maxmem=32M will use a 32 megabyte page cache.
180
181.IP "-s=BLOCK_SIZE"
182Set the block size, unless it was hard coded (20% speed improvement).
183Should be a power of 2.
184
185.IP "-p, --pristine"
186Disable the automatic decompression of gzipped inputs, to prevent
187unexpected differences in the re-compressed content.
188
189.SH RETURN VALUES
190The delta command exits with status 0 to indicate that no differences
191were found, with status 1 to indicate that some differences were
192found, and with status 2 to indicate an error of some kind. The patch
193and info commands exit with status 0 on success and 2 on failure.
194
195.SH IDENTIFICATION
196Author: Joshua P. MacDonald, jmacd@cs.berkeley.edu
197.br
198.\" $Format: "Manual Page Revision: $Revision$; Release Date: $ProjectDate$."$
199Manual Page Revision: 1.6; Release Date: Sun, 28 Jan 2007 10:02:26 -0800.
200.br
201Copyright \(co 1997, 1998, 1999, 2000, 2001
diff --git a/xdelta1/doc/xdelta.cat b/xdelta1/doc/xdelta.cat
deleted file mode 100644
index 7bc1ed6..0000000
--- a/xdelta1/doc/xdelta.cat
+++ /dev/null
@@ -1,138 +0,0 @@
1Xdelta(1) Xdelta(1)
2
3NAME
4 xdelta - Invoke Xdelta
5
6SYNOPSIS
7 xdelta subcommand [ option... ] [ operand... ]
8
9DESCRIPTION
10
11 Xdelta provides the ability to generate deltas between a pair
12 of files and later apply those deltas. It operates similar to
13 the diff and patch commands, but works on binary files and does
14 not produce a human readable output.
15
16 Xdelta has three subcommands, delta, patch, and info. Delta
17 accepts two file versions and produces a delta, while patch
18 accepts the original file version and delta and produces the
19 second version. The info command prints useful information
20 about a delta. Each subcommand will be detailed seperately.
21
22 Gzip processing
23
24 Attempting to compute a delta between compressed input files
25 usually results in poor compression. This is because small
26 differences between the original contents causes changes in the
27 compression of whole blocks of data. To simplify things,
28 Xdelta implements a special case for gzip(1) compressed files.
29 If any version input to the delta command is recognized as
30 having gzip compression, it will be automatically decompressed
31 into a temporary location prior to comparison. This temporary
32 location is either the value of the TMPDIR environment
33 variable, if set, otherwise "/tmp".
34
35 The Xdelta patch header contains a flag indicating that the
36 reconstructed version should be recompressed after applying
37 the patch. In general, this allows Xdelta to operate
38 transparently on gzip compressed inputs.
39
40 There is one potential problem when automatically processing
41 gzip compressed files, which is that the recompressed content
42 does not always match byte-for-byte with the original
43 compressed content. The uncompressed content still matches,
44 but if there is an external integrity check such as
45 cryptographic signature verification, it may fail. To prevent
46 this from happening, the --pristine option disables automatic
47 gzip processing.
48
49 MD5 integrity check
50
51 By default, Xdelta always verifies the MD5 checksum of the
52 files it reconstructs. This prevents you from supplying an
53 incorrect input during patch, which would result in corrupt
54 output. Because of this feature, you can feel confident that
55 patch has produced valid results. The --noverify option
56 disables MD5 verification, but this is only recommended for
57 performance testing.
58
59 Compressed patch format
60
61 Xdelta uses a fairly simple encoding for its delta, then
62 applies zlib compression to the result. You should not have to
63 post-compress an Xdelta delta.
64
65 Delta
66
67 The delta subcommand has the following synopsis:
68
69 xdelta delta [ option... ] fromfile tofile patchout
70
71 Computes a delta from fromfile to tofile and writes it to patchout
72
73 Patch
74
75 The patch subcommand has the following synopsis:
76
77 xdelta patch [ option... ] patchin [ fromfile [ tofile ]]
78
79 Applies patchin to fromfile and produces a reconstructed
80 version of tofile.
81
82 If fromfile was omitted, Xdelta attempts to use the original
83 fromfile name, which is stored in the delta. The from file
84 must be identical to the one used to create the delta. If its
85 length or MD5 checksum differs, patch will abort with an error
86 message.
87
88 If tofile was omitted, Xdelta attempts to use the original
89 tofile name, which is also stored in the delta. If the
90 original tofile name already exists, a unique filename
91 extension will be added to avoid destroying any existing data.
92
93 Info
94 The info subcommand has the following synopsis:
95
96 xdelta info patchinfo
97
98 Prints information about patchinfo and the version it
99 reconstructs, including file names, lengths, and MD5 checksums.
100
101 Options
102 -0..9 Set the zlib compression level. Zero indicates no
103 compression. Nine indicates maximum compression.
104
105 -h, --help
106 Print a short help message and exit.
107
108 -q, --quiet
109 Quiet. Surpresses several warning messages.
110
111 -v, --version
112 Print the Xdelta version number and exit.
113
114 -V, --verbose
115 Verbose. Prints a bit of extra information.
116
117 -n, --noverify
118 No verify. Turns off MD5 checksum verification of the
119 input and output files.
120
121 -m=SIZE, --maxmem=SIZE
122 Set an upper bound on the size of an in-memory page
123 cache. For example, --maxmem=32M will use a 32 megabyte
124 page cache.
125
126 -s=BLOCK_SIZE
127 Set the block size, unless it was hard coded (20% speed
128 improvement). Should be a power of 2.
129
130 -p, --pristine
131 Disable the automatic decompression of gzipped
132 inputs, to prevent unexpected differences in the
133 re-compressed content.
134
135IDENTIFICATION
136 Author: Joshua P. MacDonald, jmacd@cs.berkeley.edu
137 Manual Page Revision: 1.2; Release Date: Mon, 11 Jun 2001 03:39:53 -0700.
138 Copyright © 1997, 1998, 1999, 2000, 2001
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-08 21:51:31 +0000