summaryrefslogtreecommitdiff
path: root/xdelta3/www/xdelta3-cmdline.html
diff options
context:
space:
mode:
authordotdotisdead <dotdotisdead@a3eca27d-f21b-0410-9b4a-6511e771f64e>2006-08-27 18:39:38 +0000
committerdotdotisdead <dotdotisdead@a3eca27d-f21b-0410-9b4a-6511e771f64e>2006-08-27 18:39:38 +0000
commita6f202275ec093b9f8948d77b9783f0820f930d8 (patch)
tree95974d74bd0a6577e80ee2eb917cd852ce6ba011 /xdelta3/www/xdelta3-cmdline.html
Source snapshot... broken.
Diffstat (limited to 'xdelta3/www/xdelta3-cmdline.html')
-rwxr-xr-xxdelta3/www/xdelta3-cmdline.html166
1 files changed, 166 insertions, 0 deletions
diff --git a/xdelta3/www/xdelta3-cmdline.html b/xdelta3/www/xdelta3-cmdline.html
new file mode 100755
index 0000000..cabb547
--- /dev/null
+++ b/xdelta3/www/xdelta3-cmdline.html
@@ -0,0 +1,166 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4 <title>Xdelta3 command-line guide (BETA)</title>
5 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
6 <link rel="stylesheet" type="text/css" href="xdelta3.css"/>
7</head>
8<body>
9
10<!-- $Format: "$WWWLeftNavBar$" $ --!>
11<table cellpadding="20px" width=700> <tr> <td class="leftbdr" valign=top height=600 width=100> <div class="leftbody"> <h1>Xdelta</h1> <a href="xdelta3.html">overview</a><br> <a href="xdelta3-cmdline.html">command&nbsp;line</a><br> <a href="xdelta3-api-guide.html">api&nbsp;guide</a><br> <br><a href="http://xdelta.org">xdelta.org</a></h2> </div> </td> <td valign=top width=500>
12
13
14<!-- Copyright (C) 2003 and onward. Joshua P. MacDonald --!>
15
16<h1>command-line guide</h1>
17
18<code>xdelta3</code> can be run with syntax familiar but not similar to gzip;
19it requires you to specify the output file in most cases, rather than applying
20any default filename extensions. These are cases that resemble gzip:<p>
21
22<div class="example">
23<pre>
24xdelta3 -c file_to_compress > delta_file
25xdelta3 -dc delta_file > file_uncompressed
26</pre>
27</div>
28<p>
29
30The <code>-c</code> option says to write to the standard output. The
31<code>-d</code> option says to decode. The default action is to encode (also
32specified by <code>-e</code>). <code>xdelta3</code> also supports long
33command names, these two commands are equivalent to the ones abvove:<p>
34
35<div class="example">
36<pre>
37xdelta3 encode file_to_compress > delta_file
38xdelta3 decode delta_file > file_uncompressed
39</pre>
40</div>
41<p>
42
43<code>xdelta3</code> has the notion of a default filename for decoding. If
44you specified a file name during the encode step, it is used as the default
45for decoding. The <code>-s</code> option specifies a <em>source file</em> for
46delta-compression.<p>
47
48<div class="example">
49<pre>
50xdelta3 -s source_file target_file delta_file
51xdelta3 -d delta_file
52</pre>
53</div>
54<p>
55
56The second line above fills in "source_file" and "target_file" as the input
57and output filenames. Without the <code>-f</code> option,
58<code>xdelta3</code> will not overwrite an existing file. When there are no
59default filenames (e.g., in decode), standard input and standard output are
60used. In the example below, the default source filename is applied in
61decoding.
62<p>
63
64<div class="example">
65<pre>
66cat target_file | xdelta3 -s source_file > delta_file
67xdelta3 -d < delta_file > target_file.1
68</pre>
69</div>
70<p>
71
72<code>xdelta3</code> recognizes externally compressed inputs, so the following
73command produces the expected results:<p>
74
75<div class="example">
76<pre>
77xdelta3 -s beta2.tar.gz beta3.tar.gz beta3.tar.gz.xd
78xdelta3 -ds beta2.tar.gz beta3.tar.gz.xd beta3.tar.gz.1
79</pre>
80</div>
81<p>
82
83You can avoid the intermediate file and use <code>xdelta3</code> together
84with a <code>tar</code>-pipeline.
85
86<div class="example">
87<pre>
88tar -cf - beta3 | xdelta3 -s beta2.tar > beta3.tar.xd
89xdelta3 -d beta3.tar.xd | tar -xf -
90</pre>
91</div>
92<p>
93
94<code>xdelta</code> can print various information about a compressed file with
95the "printhdr" command. The "printhdrs" command prints information about each
96<em>window</em> of the encoding. The "printdelta" command prints the actual
97encoding for each window, in human-readable format.<p>
98
99<div class="example">
100<pre>
101# xdelta3 printdelta delta_file
102VCDIFF version: 0
103VCDIFF header size: 5
104VCDIFF header indicator: none
105VCDIFF secondary compressor: none
106VCDIFF window number: 0
107VCDIFF window indicator: VCD_SOURCE VCD_ADLER32
108VCDIFF adler32 checksum: 48BFADB6
109VCDIFF copy window length: 2813
110VCDIFF copy window offset: 0
111VCDIFF delta encoding length: 93
112VCDIFF target window length: 2903
113VCDIFF data section length: 72
114VCDIFF inst section length: 8
115VCDIFF addr section length: 3
116 Offset Code Type1 Size1 @Addr1 + Type2 Size2 @Addr2
117 000000 019 CPY_0 1535 @0
118 001535 001 ADD 72
119 001607 019 CPY_0 1296 @1517
120</pre>
121</div>
122<br>
123<p>
124
125
126<h1>xdelta3 -h</h1>
127
128<pre>
129usage: xdelta3 [command/options] [input [output]]
130commands are:
131 encode encodes the input
132 decode decodes the input
133 config prints xdelta3 configuration
134 test run the builtin tests
135special commands for VCDIFF inputs:
136 printhdr print information about the first window
137 printhdrs print information about all windows
138 printdelta print information about the entire delta
139options are:
140 -c use stdout instead of default
141 -d same as decode command
142 -e same as encode command
143 -f force overwrite
144 -n disable checksum (encode/decode)
145 -D disable external decompression (encode/decode)
146 -R disable external recompression (decode)
147 -N disable small string-matching compression
148 -S [djw|fgk] disable/enable secondary compression
149 -A [apphead] disable/provide application header
150 -s source source file to copy from (if any)
151 -B blksize source file block size
152 -W winsize input window buffer size
153 -v be verbose (max 2)
154 -q be quiet
155 -h show help
156 -V show version
157 -P repeat count (for profiling)
158</pre>
159<p>
160
161</td>
162</tr>
163</table>
164
165</body>
166</html>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-14 03:54:01 +0000