Mercurial > repos > rliterman > csp2
diff CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/pbzip2.1 @ 68:5028fdace37b
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author | jpayne |
---|---|
date | Tue, 18 Mar 2025 16:23:26 -0400 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man1/pbzip2.1 Tue Mar 18 16:23:26 2025 -0400 @@ -0,0 +1,176 @@ +.TH pbzip2 1 +.SH NAME +pbzip2 \- parallel bzip2 file compressor, v1.1.10 +.SH SYNOPSIS +.B pbzip2 +.RB [ " \-123456789 " ] +.RB [ " \-b#cdfhklm#p#qrS#tvVz " ] +[ +.I "filenames \&..." +] +.SH DESCRIPTION +.I pbzip2 +is a parallel implementation of the bzip2 block-sorting file +compressor that uses pthreads and achieves near-linear speedup on SMP +machines. The output of this version is fully compatible with bzip2 +v1.0.2 or newer (ie: anything compressed with +.I pbzip2 +can be decompressed with bzip2). +.PP +.I pbzip2 +should work on any system that has a pthreads compatible C++ +compiler (such as gcc). It has been tested on: Linux, Windows (cygwin), +Solaris, Tru64/OSF1, HP-UX, and Irix. +.PP +The default settings for +.I pbzip2 +will work well in most cases. The only switch you will likely need to +use is -d to decompress files and -p to set the # of processors for +.I pbzip2 +to use if autodetect is not supported +on your system, or you want to use a specific # of CPUs. +.SH OPTIONS +.TP +.B \-b# +Where # is block size in 100k steps (default 9 = 900k) +.TP +.B \-c, \-\-stdout +Output to standard out (stdout) +.TP +.B \-d,\-\-decompress +Decompress file +.TP +.B \-f,\-\-force +Force, overwrite existing output file +.TP +.B \-h,\-\-help +Print this help message +.TP +.B \-k,\-\-keep +Keep input file, do not delete +.TP +.B \-l,\-\-loadavg +Load average determines max number processors to use +.TP +.B \-m# +Where # is max memory usage in 1MB steps (default 100 = 100MB) +.TP +.B \-p# +Where # is the number of processors (default: autodetect) +.TP +.B \-q,\-\-quiet +Quiet mode (default) +.TP +.B \-r,\-\-read +Read entire input file into RAM and split between processors +.TP +.B \-S# +Child thread stack size in 1KB steps (default stack size if unspecified) +.TP +.B \-t,\-\-test +Test compressed file integrity +.TP +.B \-v,\-\-verbose +Verbose mode +.TP +.B \-V +Display version info for +.I pbzip2 +then exit +.TP +.B \-z,\-\-compress +Compress file (default) +.TP +.B \-1,\-\-fast ... \-9,\-\-best +Set BWT block size to 100k .. 900k (default 900k). +.TP +.B \-\-ignore-trailing-garbage=# +Ignore trailing garbage flag (1 - ignored; 0 - forbidden) +.PP +If no file names are given, pbzip2 compresses or decompresses from standard input to standard output. +.SH FILE SIZES +You should be able to compress files larger than 4GB with +.I pbzip2. +.PP +Files that are compressed with +.I pbzip2 +are broken up into pieces and +each individual piece is compressed. This is how +.I pbzip2 +runs faster +on multiple CPUs since the pieces can be compressed simultaneously. +The final .bz2 file may be slightly larger than if it was compressed +with the regular bzip2 program due to this file splitting (usually +less than 0.2% larger). Files that are compressed with +.I pbzip2 +will also gain considerable speedup when decompressed using +.I pbzip2. +.PP +Files that were compressed using bzip2 will not see speedup since +bzip2 packages the data into a single chunk that cannot be split +between processors. +.SH EXAMPLES +Example 1: pbzip2 myfile.tar +.PP +This example will compress the file "myfile.tar" into the compressed file +"myfile.tar.bz2". It will use the autodetected # of processors (or 2 +processors if autodetect not supported) with the default file block size +of 900k and default BWT block size of 900k. +.PP +Example 2: pbzip2 -b15k myfile.tar +.PP +This example will compress the file "myfile.tar" into the compressed file +"myfile.tar.bz2". It will use the autodetected # of processors (or 2 +processors if autodetect not supported) with a file block size of 1500k +and a BWT block size of 900k. The file "myfile.tar" will not be deleted +after compression is finished. +.PP +Example 3: pbzip2 -p4 -r -5 myfile.tar second*.txt +.PP +This example will compress the file "myfile.tar" into the compressed file +"myfile.tar.bz2". It will use 4 processors with a BWT block size of 500k. +The file block size will be the size of "myfile.tar" divided by 4 (# of +processors) so that the data will be split evenly among each processor. +This requires you have enough RAM for pbzip2 to read the entire file into +memory for compression. Pbzip2 will then use the same options to compress +all other files that match the wildcard "second*.txt" in that directory. +.PP +Example 4: tar cf myfile.tar.bz2 --use-compress-prog=pbzip2 dir_to_compress/ +.br +Example 4: tar -c directory_to_compress/ | pbzip2 -c > myfile.tar.bz2 +.PP +These examples will compress the data being given to pbzip2 via pipe +from TAR into the compressed file "myfile.tar.bz2". It will use the +autodetected # of processors (or 2 processors if autodetect not +supported) with the default file block size of 900k and default BWT +block size of 900k. TAR is collecting all of the files from the +"directory_to_compress/" directory and passing the data to pbzip2 as +it works. +.PP +Example 5: pbzip2 -d -m500 myfile.tar.bz2 +.PP +This example will decompress the file "myfile.tar.bz2" into the decompressed +file "myfile.tar". It will use the autodetected # of processors (or 2 +processors if autodetect not supported). It will use a maximum of 500MB of +memory for decompression. The switches -b, -r, and -1..-9 are not valid for +decompression. +.PP +Example 6: pbzip2 -dc myfile.tar.bz2 | tar x +.PP +This example will decompress and untar the file "myfile.tar.bz2" piping +the output of the decompressing pbzip2 to tar. +.PP +Example 7: pbzip2 -c < myfile.txt > myfile.txt.bz2 +.PP +This example will read myfile.txt from standard input compressing +it to standard output which is redirected to to myfile.txt.bz2. +.SH "SEE ALSO" +bzip2(1) +gzip(1) +lzip(1) +rzip(1) +zip(1) +.SH AUTHOR +Jeff Gilchrist + +http://compression.ca