2
0
mirror of https://github.com/vasi/pixz synced 2024-11-18 15:26:46 +00:00
pixz/pixz.1.asciidoc
Dave Vasilevsky 65e827da82 Add manpage
2012-12-22 15:59:59 -05:00

84 lines
2.2 KiB
Plaintext

PIXZ(1)
=======
:doctype: manpage
NAME
----
pixz - parallel, indexed xz compressor
SYNOPSIS
--------
*pixz* ['OPTIONS'] ['INPUT' ['OUTPUT']]
DESCRIPTION
-----------
pixz compresses and decompresses files using multiple processors. If the input looks like a tar(1) archive, it also creates an index of all the files in the archive. This allows the extraction of only a small segment of the tarball, without needing to decompress the entire archive.
OPTIONS
-------
By default, pixz uses standard input and output, unless 'INPUT' and 'OUTPUT' arguments are provided. If pixz is provided with input but no output, it will delete the input once it's done.
*-d*::
Decompress, instead of compress.
*-t*::
Force non-tarball mode. By default, pixz auto-detects tar data, and if found enters tarball mode.
When compressing in non-tarball mode, no archive index will be created. When decompressing, fast extraction will not be available.
*-l*::
List the archive contents. In tarball mode, lists the files in the tarball. In non-tarball mode, lists the blocks of compressed data.
*-x* 'PATH'::
Extract certain members from an archive, quickly. All members whose path begins with 'PATH' will be extracted.
*-i* 'INPUT'::
Use 'INPUT' as the input.
*-o* 'OUTPUT'::
Use OUTPUT as the output.
*-#*::
Set compression level, from -0 (lowest compression, fastest) to -9 (highest compression, slowest).
*-p* 'CPUS'::
Set the number of CPU cores to use. By default pixz will use the number of cores on the system.
*-h*::
Show pixz's online help.
EXAMPLES
--------
`pixz < myfile > myfile.xz`::
Compress a file with pixz.
`pixz myfile`::
Compress to myfile.pxz, removing the original.
`tar -Ipixz -cf output.tpxz directory`::
Make tar use pixz for compression.
`pixz -x path/to/file < input.tpxz | tar x`::
Extract one file from an archive, quickly.
AUTHOR
------
pixz is written by Dave Vasilevsky.
RESOURCES
---------
The pixz homepage: <http://github.com/vasi/pixz/>
Source downloads: <http://sourceforge.net/projects/pixz/files/>
COPYRIGHT
---------
Copyright (C) 2009-2010 Dave Vasilevsky. Use of this software is granted under the FreeBSD License.
SEE ALSO
--------
xz(1), tar(1)