OLD | NEW |
1 '\" t | 1 '\" t |
2 .\" | 2 .\" |
3 .\" Author: Lasse Collin | 3 .\" Author: Lasse Collin |
4 .\" | 4 .\" |
5 .\" This file has been put into the public domain. | 5 .\" This file has been put into the public domain. |
6 .\" You can do whatever you want with this file. | 6 .\" You can do whatever you want with this file. |
7 .\" | 7 .\" |
8 .TH XZ 1 "2012-05-27" "Tukaani" "XZ Utils" | 8 .TH XZ 1 "2013-06-21" "Tukaani" "XZ Utils" |
9 . | 9 . |
10 .SH NAME | 10 .SH NAME |
11 xz, unxz, xzcat, lzma, unlzma, lzcat \- Compress or decompress .xz and .lzma fil
es | 11 xz, unxz, xzcat, lzma, unlzma, lzcat \- Compress or decompress .xz and .lzma fil
es |
12 . | 12 . |
13 .SH SYNOPSIS | 13 .SH SYNOPSIS |
14 .B xz | 14 .B xz |
15 .RI [ option ]... | 15 .RI [ option... ] |
16 .RI [ file ]... | 16 .RI [ file... ] |
17 .PP | 17 . |
| 18 .SH COMMAND ALIASES |
18 .B unxz | 19 .B unxz |
19 is equivalent to | 20 is equivalent to |
20 .BR "xz \-\-decompress" . | 21 .BR "xz \-\-decompress" . |
21 .br | 22 .br |
22 .B xzcat | 23 .B xzcat |
23 is equivalent to | 24 is equivalent to |
24 .BR "xz \-\-decompress \-\-stdout" . | 25 .BR "xz \-\-decompress \-\-stdout" . |
25 .br | 26 .br |
26 .B lzma | 27 .B lzma |
27 is equivalent to | 28 is equivalent to |
(...skipping 673 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
701 in the single-threaded mode. | 702 in the single-threaded mode. |
702 It may vary slightly between | 703 It may vary slightly between |
703 .B xz | 704 .B xz |
704 versions. | 705 versions. |
705 Memory requirements of some of the future multithreaded modes may | 706 Memory requirements of some of the future multithreaded modes may |
706 be dramatically higher than that of the single-threaded mode. | 707 be dramatically higher than that of the single-threaded mode. |
707 .IP \(bu 3 | 708 .IP \(bu 3 |
708 DecMem contains the decompressor memory requirements. | 709 DecMem contains the decompressor memory requirements. |
709 That is, the compression settings determine | 710 That is, the compression settings determine |
710 the memory requirements of the decompressor. | 711 the memory requirements of the decompressor. |
711 The exact decompressor memory usage is slighly more than | 712 The exact decompressor memory usage is slightly more than |
712 the LZMA2 dictionary size, but the values in the table | 713 the LZMA2 dictionary size, but the values in the table |
713 have been rounded up to the next full MiB. | 714 have been rounded up to the next full MiB. |
714 .RE | 715 .RE |
715 .TP | 716 .TP |
716 .BR \-e ", " \-\-extreme | 717 .BR \-e ", " \-\-extreme |
717 Use a slower variant of the selected compression preset level | 718 Use a slower variant of the selected compression preset level |
718 .RB ( \-0 " ... " \-9 ) | 719 .RB ( \-0 " ... " \-9 ) |
719 to hopefully get a little bit better compression ratio, | 720 to hopefully get a little bit better compression ratio, |
720 but with bad luck this can also make it worse. | 721 but with bad luck this can also make it worse. |
721 Decompressor memory usage is not affected, | 722 Decompressor memory usage is not affected, |
(...skipping 168 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
890 will increase the memory usage dramatically. | 891 will increase the memory usage dramatically. |
891 Note that if multithreading will be the default, | 892 Note that if multithreading will be the default, |
892 it will probably be done so that single-threaded and | 893 it will probably be done so that single-threaded and |
893 multithreaded modes produce the same output, | 894 multithreaded modes produce the same output, |
894 so compression ratio won't be significantly affected | 895 so compression ratio won't be significantly affected |
895 if threading will be enabled by default. | 896 if threading will be enabled by default. |
896 . | 897 . |
897 .SS "Custom compressor filter chains" | 898 .SS "Custom compressor filter chains" |
898 A custom filter chain allows specifying | 899 A custom filter chain allows specifying |
899 the compression settings in detail instead of relying on | 900 the compression settings in detail instead of relying on |
900 the settings associated to the preset levels. | 901 the settings associated to the presets. |
901 When a custom filter chain is specified, | 902 When a custom filter chain is specified, |
902 the compression preset level options | 903 preset options (\fB\-0\fR ... \fB\-9\fR and \fB\-\-extreme\fR) |
903 (\fB\-0\fR ... \fB\-9\fR and \fB\-\-extreme\fR) are | 904 earlier on the command line are forgotten. |
904 silently ignored. | 905 If a preset option is specified |
| 906 after one or more custom filter chain options, |
| 907 the new preset takes effect and |
| 908 the custom filter chain options specified earlier are forgotten. |
905 .PP | 909 .PP |
906 A filter chain is comparable to piping on the command line. | 910 A filter chain is comparable to piping on the command line. |
907 When compressing, the uncompressed input goes to the first filter, | 911 When compressing, the uncompressed input goes to the first filter, |
908 whose output goes to the next filter (if any). | 912 whose output goes to the next filter (if any). |
909 The output of the last filter gets written to the compressed file. | 913 The output of the last filter gets written to the compressed file. |
910 The maximum number of filters in the chain is four, | 914 The maximum number of filters in the chain is four, |
911 but typically a filter chain has only one or two filters. | 915 but typically a filter chain has only one or two filters. |
912 .PP | 916 .PP |
913 Many filters have limitations on where they can be | 917 Many filters have limitations on where they can be |
914 in the filter chain: | 918 in the filter chain: |
(...skipping 12 matching lines...) Expand all Loading... |
927 it was specified when compressing. | 931 it was specified when compressing. |
928 .PP | 932 .PP |
929 Filters take filter-specific | 933 Filters take filter-specific |
930 .I options | 934 .I options |
931 as a comma-separated list. | 935 as a comma-separated list. |
932 Extra commas in | 936 Extra commas in |
933 .I options | 937 .I options |
934 are ignored. | 938 are ignored. |
935 Every option has a default value, so you need to | 939 Every option has a default value, so you need to |
936 specify only those you want to change. | 940 specify only those you want to change. |
| 941 .PP |
| 942 To see the whole filter chain and |
| 943 .IR options , |
| 944 use |
| 945 .B "xz \-vv" |
| 946 (that is, use |
| 947 .B \-\-verbose |
| 948 twice). |
| 949 This works also for viewing the filter chain options used by presets. |
937 .TP | 950 .TP |
938 \fB\-\-lzma1\fR[\fB=\fIoptions\fR] | 951 \fB\-\-lzma1\fR[\fB=\fIoptions\fR] |
939 .PD 0 | 952 .PD 0 |
940 .TP | 953 .TP |
941 \fB\-\-lzma2\fR[\fB=\fIoptions\fR] | 954 \fB\-\-lzma2\fR[\fB=\fIoptions\fR] |
942 .PD | 955 .PD |
943 Add LZMA1 or LZMA2 filter to the filter chain. | 956 Add LZMA1 or LZMA2 filter to the filter chain. |
944 These filters can be used only as the last filter in the chain. | 957 These filters can be used only as the last filter in the chain. |
945 .IP "" | 958 .IP "" |
946 LZMA1 is a legacy filter, | 959 LZMA1 is a legacy filter, |
(...skipping 22 matching lines...) Expand all Loading... |
969 preset modifiers. | 982 preset modifiers. |
970 The integer can be from | 983 The integer can be from |
971 .B 0 | 984 .B 0 |
972 to | 985 to |
973 .BR 9 , | 986 .BR 9 , |
974 matching the command line options \fB\-0\fR ... \fB\-9\fR. | 987 matching the command line options \fB\-0\fR ... \fB\-9\fR. |
975 The only supported modifier is currently | 988 The only supported modifier is currently |
976 .BR e , | 989 .BR e , |
977 which matches | 990 which matches |
978 .BR \-\-extreme . | 991 .BR \-\-extreme . |
979 The default | 992 If no |
980 .I preset | 993 .B preset |
981 is | 994 is specified, the default values of LZMA1 or LZMA2 |
982 .BR 6 , | |
983 from which the default values for the rest of the LZMA1 or LZMA2 | |
984 .I options | 995 .I options |
985 are taken. | 996 are taken from the preset |
| 997 .BR 6 . |
986 .TP | 998 .TP |
987 .BI dict= size | 999 .BI dict= size |
988 Dictionary (history buffer) | 1000 Dictionary (history buffer) |
989 .I size | 1001 .I size |
990 indicates how many bytes of the recently processed | 1002 indicates how many bytes of the recently processed |
991 uncompressed data is kept in memory. | 1003 uncompressed data is kept in memory. |
992 The algorithm tries to find repeating byte sequences (matches) in | 1004 The algorithm tries to find repeating byte sequences (matches) in |
993 the uncompressed data, and replace them with references | 1005 the uncompressed data, and replace them with references |
994 to the data currently in the dictionary. | 1006 to the data currently in the dictionary. |
995 The bigger the dictionary, the higher is the chance | 1007 The bigger the dictionary, the higher is the chance |
(...skipping 575 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1571 It makes the output of | 1583 It makes the output of |
1572 .B xz | 1584 .B xz |
1573 easier to parse by other programs. | 1585 easier to parse by other programs. |
1574 Currently | 1586 Currently |
1575 .B \-\-robot | 1587 .B \-\-robot |
1576 is supported only together with | 1588 is supported only together with |
1577 .BR \-\-version , | 1589 .BR \-\-version , |
1578 .BR \-\-info\-memory , | 1590 .BR \-\-info\-memory , |
1579 and | 1591 and |
1580 .BR \-\-list . | 1592 .BR \-\-list . |
1581 It will be supported for normal compression and | 1593 It will be supported for compression and |
1582 decompression in the future. | 1594 decompression in the future. |
1583 . | 1595 . |
1584 .SS Version | 1596 .SS Version |
1585 .B "xz \-\-robot \-\-version" | 1597 .B "xz \-\-robot \-\-version" |
1586 will print the version number of | 1598 will print the version number of |
1587 .B xz | 1599 .B xz |
1588 and liblzma in the following format: | 1600 and liblzma in the following format: |
1589 .PP | 1601 .PP |
1590 .BI XZ_VERSION= XYYYZZZS | 1602 .BI XZ_VERSION= XYYYZZZS |
1591 .br | 1603 .br |
(...skipping 580 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2172 the same uncompressed input file | 2184 the same uncompressed input file |
2173 may vary between XZ Utils versions even if | 2185 may vary between XZ Utils versions even if |
2174 compression options are identical. | 2186 compression options are identical. |
2175 This is because the encoder can be improved | 2187 This is because the encoder can be improved |
2176 (faster or better compression) | 2188 (faster or better compression) |
2177 without affecting the file format. | 2189 without affecting the file format. |
2178 The output can vary even between different | 2190 The output can vary even between different |
2179 builds of the same XZ Utils version, | 2191 builds of the same XZ Utils version, |
2180 if different build options are used. | 2192 if different build options are used. |
2181 .PP | 2193 .PP |
2182 The above means that implementing | 2194 The above means that once |
2183 .B \-\-rsyncable | 2195 .B \-\-rsyncable |
2184 to create rsyncable | 2196 has been implemented, |
2185 .B .xz | 2197 the resulting files won't necessarily be rsyncable |
2186 files is not going to happen without | 2198 unless both old and new files have been compressed |
2187 freezing a part of the encoder | 2199 with the same xz version. |
2188 implementation, which can then be used with | 2200 This problem can be fixed if a part of the encoder |
2189 .BR \-\-rsyncable . | 2201 implementation is frozen to keep rsyncable output |
| 2202 stable across xz versions. |
2190 . | 2203 . |
2191 .SS "Embedded .xz decompressors" | 2204 .SS "Embedded .xz decompressors" |
2192 Embedded | 2205 Embedded |
2193 .B .xz | 2206 .B .xz |
2194 decompressor implementations like XZ Embedded don't necessarily | 2207 decompressor implementations like XZ Embedded don't necessarily |
2195 support files created with integrity | 2208 support files created with integrity |
2196 .I check | 2209 .I check |
2197 types other than | 2210 types other than |
2198 .B none | 2211 .B none |
2199 and | 2212 and |
(...skipping 377 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2577 .BR xzmore (1), | 2590 .BR xzmore (1), |
2578 .BR gzip (1), | 2591 .BR gzip (1), |
2579 .BR bzip2 (1), | 2592 .BR bzip2 (1), |
2580 .BR 7z (1) | 2593 .BR 7z (1) |
2581 .PP | 2594 .PP |
2582 XZ Utils: <http://tukaani.org/xz/> | 2595 XZ Utils: <http://tukaani.org/xz/> |
2583 .br | 2596 .br |
2584 XZ Embedded: <http://tukaani.org/xz/embedded.html> | 2597 XZ Embedded: <http://tukaani.org/xz/embedded.html> |
2585 .br | 2598 .br |
2586 LZMA SDK: <http://7-zip.org/sdk.html> | 2599 LZMA SDK: <http://7-zip.org/sdk.html> |
OLD | NEW |