xdelta3.1

   1 .TH XDELTA3 "1" "August 2009" "Xdelta3"
   2 .SH NAME
   3 xdelta3 \- VCDIFF (RFC 3284) binary diff tool
   4 .SH SYNOPSIS
   5 .B xdelta3
   6 .RI [ command ]
   7 .RI [ options ]
   8 .RI [ input
   9 .RI [ output ]]
  10 .SH DESCRIPTION
  11 .B xdelta3
  12 is a binary diff tool that uses the VCDIFF (RFC 3284) format and compression.
  13 .SH COMMANDS
  14 .TP
  15 .BI config
  16 prints xdelta3 configuration
  17 .TP
  18 .BI decode
  19 decompress the input, also set by -d
  20 .TP
  21 .BI encode
  22 compress the input, also set by -e (default)
  23 .TP
  24 .BI test
  25 run the builtin tests
  26 .TP
  27 .BI printdelta
  28 print information about the entire delta
  29 .TP
  30 .BI printhdr
  31 print information about the first window
  32 .TP
  33 .BI printhdrs
  34 print information about all windows
  35 .TP
  36 .BI recode
  37 encode with new application/secondary settings
  38
  39 .SH OPTIONS
  40 standard options:
  41 .TP
  42 .BI "\-0 .. \-9"
  43 compression level
  44 .TP
  45 .BI "\-c"
  46 use stdout
  47 .TP
  48 .BI "\-d"
  49 decompress
  50 .TP
  51 .BI \-e
  52 compress
  53 .TP
  54 .BI \-f
  55 force overwrite
  56 .TP
  57 .BI \-h
  58 show help
  59 .TP
  60 .BI \-q
  61 be quiet
  62 .TP
  63 .BI \-v
  64 be verbose (max 2)
  65 .TP
  66 .BI \-V
  67 show version
  68
  69 .TP
  70 memory options:
  71 .TP
  72 .BI \-B
  73 .RI bytes
  74 source window size
  75 .TP
  76 .BI \-W
  77 .RI bytes
  78 input window size
  79 .TP
  80 .BI \-P
  81 .RI size
  82 compression duplicates window
  83 .TP
  84 .BI \-I
  85 .RI size
  86 instruction buffer size (0 = unlimited)
  87
  88 .TP
  89 compression options:
  90 .TP
  91 .BI \-s
  92 .RI source
  93 source file to copy from (if any)
  94 .TP
  95 .BI "\-S " [djw|fgk]
  96 enable/disable secondary compression
  97 .TP
  98 .BI \-N
  99 disable small string-matching compression
 100 .TP
 101 .BI \-D
 102 disable external decompression (encode/decode)
 103 .TP
 104 .BI \-R
 105 disable external recompression (decode)
 106 .TP
 107 .BI \-n
 108 disable checksum (encode/decode)
 109 .TP
 110 .BI \-C
 111 soft config (encode, undocumented)
 112 .TP
 113 .BI "\-A " [apphead]
 114 disable/provide application header (encode)
 115 .TP
 116 .BI \-J
 117 disable output (check/compute only)
 118 .TP
 119 .BI \-T
 120 use alternate code table (test)
 121
 122 .SH NOTES
 123 The
 124 .B XDELTA
 125 environment variable may contain extra args:
 126
 127 .RS
 128 XDELTA="-s source-x.y.tar.gz" \\
 129 .br
 130 tar --use-compress-program=xdelta3 -cf \\
 131 .br
 132 target-x.z.tar.gz.vcdiff target-x.y/
 133
 134 .SH EXAMPLES
 135
 136 Compress the differences between SOURCE and TARGET, yielding OUT,
 137 using "djw" secondary compression:
 138
 139 xdelta3 -S djw -s SOURCE TARGET OUT
 140
 141 Do the same, using standard input and output:
 142
 143 xdelta3 -S djw -s SOURCE < TARGET > OUT
 144
 145 To decompress OUT, using SOURCE, yielding TARGET:
 146
 147 xdelta3 -d -s SOURCE OUT TARGET
 148
 149 .SH AUTHOR
 150 xdelta3 was written by Josh MacDonald <josh.macdonald@gmail.com>.
 151 .PP
 152 This manual page was written by Leo 'costela' Antunes <costela@debian.org>
 153 for the Debian project (but may be used by others).