components/pixz/files/pixz.1
author pkidd <patrick.kidd@oracle.com>
Wed, 27 Jan 2016 12:14:36 -0800
branchs11u3-sru
changeset 5354 f2f3e6f8b341
parent 2657 b69f0d9bab77
permissions -rw-r--r--
Added tag 0.175.3.5.0.4.0, S11.3SRU5.4 for changeset 592f054591f7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2657
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     1
'\" te
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     2
.TH pixz 1
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     3
.SH NAME
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     4
pixz \- parallel, indexing version of XZ
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     5
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     6
.SH SYNOPSIS
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     7
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     8
.nf
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     9
\fB/usr/bin/pixz\fR input output.pxz
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    10
.fi
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    11
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    12
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    13
.nf
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    14
\fB/usr/bin/pixz\fR -d input.pxz output
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    15
.fi
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    16
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    17
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    18
.nf
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    19
\fB/usr/bin/pixz\fR -l input.tpxz
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    20
.fi
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    21
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    22
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    23
.nf
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    24
\fB/usr/bin/pixz\fR -x /path/to/file < input.tpxz
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    25
.fi
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    26
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    27
.SH DESCRIPTION
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    28
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    29
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    30
The existing XZ Utils ( http://tukaani.org/xz/ ) provide great compression
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    31
in the .xz file format, but they have two significant problems:
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    32
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    33
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    34
.RS +4
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    35
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    36
.ie t \(bu
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    37
.el o
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    38
They are single-threaded, while most users nowadays have multi-core computers.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    39
.RE
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    40
.RS +4
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    41
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    42
.ie t \(bu
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    43
.el o
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    44
The .xz files they produce are just one big block of compressed data, rather than a collection of smaller blocks. This makes random access to the original data impossible.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    45
.RE
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    46
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    47
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    48
With pixz, both these problems are solved.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    49
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    50
.SH EXAMPLES
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    51
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    52
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    53
Specifying input and output:
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    54
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    55
.ne 2
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    56
.mk
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    57
.na
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    58
$ pixz < foo.tar > foo.tpxz
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    59
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    60
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    61
.sp .6
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    62
.RS 4n
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    63
Same as 'pixz foo.tar foo.tpxz'
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    64
.RE
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    65
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    66
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    67
.ne 2
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    68
.mk
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    69
.na
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    70
$ pixz -i foo.tar -o foo.tpxz
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    71
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    72
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    73
.sp .6
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    74
.RS 4n
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    75
Ditto. These both work for -x, -d and -l too, eg:
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    76
.RE
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    77
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    78
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    79
.ne 2
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    80
.mk
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    81
.na
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    82
$ pixz -x -i foo.tpxz -o foo.tar file1 file2 ...
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    83
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    84
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    85
.sp .6
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    86
.RS 4n
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    87
# Extract the files from foo.tpxz into foo.tar
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    88
.RE
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    89
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    90
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    91
.ne 2
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    92
.mk
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    93
.na
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    94
$ pixz foo.tar
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    95
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    96
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    97
.sp .6
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    98
.RS 4n
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    99
Compress it to foo.tpxz, removing the original
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   100
.RE
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   101
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   102
.sp
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   103
.ne 2
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   104
.mk
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   105
.na
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   106
$ pixz -d foo.tpxz
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   107
.LP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   108
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   109
.sp .6
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   110
.RS 4n
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   111
Extract it to foo.tar, removing the original
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   112
.RE
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   113
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   114
.SH OPTIONS
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   115
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   116
.B -1
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   117
Faster, worse compression.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   118
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   119
.B -9
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   120
Better, slower compression.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   121
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   122
.B -p <number>
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   123
Cap the number of threads at <number>.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   124
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   125
.B -t
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   126
Compress but don't treat it as a tarball (don't index it).
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   127
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   128
.B -d
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   129
Decompress, don't check that contents match index.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   130
.TP
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   131
.B -l
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   132
List the xz blocks instead of files.
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   133
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   134
.SH WARNING
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   135
Running pixz without the -t flag will cause it to treat the input
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   136
as a tarball, as long as it looks vaguely tarball-like. This means if the
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   137
file starts with at least 1024 zero bytes, pixz will assume it's empty, and
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   138
truncate the output! If your input files aren't tarballs, run with -t or
b69f0d9bab77 PSARC 2012/358 pixz
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   139
face possible data-loss.