xdelta3.1 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  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. .SH OPTIONS
  39. standard options:
  40. .TP
  41. .BI "\-0 .. \-9"
  42. compression level
  43. .TP
  44. .BI "\-c"
  45. use stdout
  46. .TP
  47. .BI "\-d"
  48. decompress
  49. .TP
  50. .BI \-e
  51. compress
  52. .TP
  53. .BI \-f
  54. force overwrite
  55. .TP
  56. .BI \-h
  57. show help
  58. .TP
  59. .BI \-q
  60. be quiet
  61. .TP
  62. .BI \-v
  63. be verbose (max 2)
  64. .TP
  65. .BI \-V
  66. show version
  67. .TP
  68. memory options:
  69. .TP
  70. .BI \-B
  71. .RI bytes
  72. source window size
  73. .TP
  74. .BI \-W
  75. .RI bytes
  76. input window size
  77. .TP
  78. .BI \-P
  79. .RI size
  80. compression duplicates window
  81. .TP
  82. .BI \-I
  83. .RI size
  84. instruction buffer size (0 = unlimited)
  85. .TP
  86. compression options:
  87. .TP
  88. .BI \-s
  89. .RI source
  90. source file to copy from (if any)
  91. .TP
  92. .BI "\-S " [djw|fgk]
  93. enable/disable secondary compression
  94. .TP
  95. .BI \-N
  96. disable small string-matching compression
  97. .TP
  98. .BI \-D
  99. disable external decompression (encode/decode)
  100. .TP
  101. .BI \-R
  102. disable external recompression (decode)
  103. .TP
  104. .BI \-n
  105. disable checksum (encode/decode)
  106. .TP
  107. .BI \-C
  108. soft config (encode, undocumented)
  109. .TP
  110. .BI "\-A " [apphead]
  111. disable/provide application header (encode)
  112. .TP
  113. .BI \-J
  114. disable output (check/compute only)
  115. .TP
  116. .BI \-T
  117. use alternate code table (test)
  118. .SH NOTES
  119. The
  120. .B XDELTA
  121. environment variable may contain extra args:
  122. .RS
  123. XDELTA="-s source-x.y.tar.gz" \\
  124. .br
  125. tar --use-compress-program=xdelta3 -cf \\
  126. .br
  127. target-x.z.tar.gz.vcdiff target-x.y/
  128. .SH EXAMPLES
  129. Compress the differences between SOURCE and TARGET, yielding OUT,
  130. using "djw" secondary compression:
  131. xdelta3 -S djw -s SOURCE TARGET OUT
  132. Do the same, using standard input and output:
  133. xdelta3 -S djw -s SOURCE < TARGET > OUT
  134. To decompress OUT, using SOURCE, yielding TARGET:
  135. xdelta3 -d -s SOURCE OUT TARGET
  136. .SH AUTHOR
  137. xdelta3 was written by Josh MacDonald <josh.macdonald@gmail.com>.
  138. .PP
  139. This manual page was written by Leo 'costela' Antunes <costela@debian.org>
  140. for the Debian project (but may be used by others).