blob: 63319c5aecf9e345d1c3561245b19aef305a93b3 [file] [log] [blame]
openvcdiff311c7142008-08-26 19:29:25 +00001.\" Copyright (c) 2008, Google Inc.
2.\"
3.\" Licensed under the Apache License, Version 2.0 (the "License");
4.\" you may not use this file except in compliance with the License.
5.\" You may obtain a copy of the License at
6.\"
7.\" http://www.apache.org/licenses/LICENSE-2.0
8.\"
9.\" Unless required by applicable law or agreed to in writing, software
10.\" distributed under the License is distributed on an "AS IS" BASIS,
11.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12.\" See the License for the specific language governing permissions and
13.\" limitations under the License.
14.\" This file was originally generated by help2man 1.23.
15.TH VCDIFF "1" "August 2008" "vcdiff" "open-vcdiff"
16.SH NAME
17vcdiff \- encoder/decoder for VCDIFF (RFC 3284) format
18.SH DESCRIPTION
19.HP
20\fBvcdiff\fR {\fBencode\fR|\fBdelta\fR|\fBdecode\fR|\fBpatch\fR}
21\fB\-dictionary\fR <filename>
22[<options>]
23.HP
24\fBencode\fR or \fBdelta\fR:
25create delta file from dictionary and target file
26.HP
27\fBdecode\fR or \fBpatch\fR:
28reconstruct target file from dictionary and delta file
29.HP
30\fB\-dictionary\fR <filename>
31.br
32File containing dictionary data (also known as source data.)
33Required for all operations.
34.HP
35\fB\-target\fR <filename>
36.br
37File name of the target file (unencoded data).
38The default value (blank) causes vcdiff to use standard input for encode,
39or standard output for decode.
40.HP
41\fB\-delta\fR <filename>
42.br
43File name of the delta file (encoded data).
44The default value (blank) causes vcdiff to use standard output for encode,
45or standard input for decode.
46.HP
47\fB\-checksum\fR
48.br
49Include an Adler32 checksum of the target data when encoding.
50Default is false.
51.HP
52\fB\-interleaved\fR
53.br
54Use interleaved format. Default is false.
55.HP
56\fB\-stats\fR
57.br
58Write a report to stderr, containing the original target size,
59compressed delta size, and compression percentage.
60Default is false.
61.HP
62\fB\-target_matches\fR
63.br
64Find duplicate strings in target data as well as dictionary data.
65Default is false.
66.HP
67\fB\-buffersize\fR <integer>
68.br
69The memory buffer size (in bytes) used for reading the input file.
70Default is 1048576 (1 MB); if the input file is smaller than that,
71the buffer will match the file size. This parameter does not usually
72need to be specified.
73.SH "SEE ALSO"
74Further documentation for
75.B open-vcdiff
76can be found online at
77.B http://code.google.com/p/open-vcdiff/
78.PP