diff options
Diffstat (limited to 'doc/tarlz.info')
| -rw-r--r-- | doc/tarlz.info | 127 |
1 files changed, 80 insertions, 47 deletions
diff --git a/doc/tarlz.info b/doc/tarlz.info index fa8666c..fc1f092 100644 --- a/doc/tarlz.info +++ b/doc/tarlz.info @@ -11,7 +11,7 @@ File: tarlz.info, Node: Top, Next: Introduction, Up: (dir) Tarlz Manual ************ -This manual is for Tarlz (version 0.13, 27 February 2019). +This manual is for Tarlz (version 0.14, 12 March 2019). * Menu: @@ -48,8 +48,8 @@ tar tools like GNU tar, which treat it like any other tar.lz archive. Tarlz can append files to the end of such compressed archives. Tarlz can create tar archives with five levels of compression -granularity; per file, per block (default), per directory, appendable -solid, and solid. +granularity; per file (--no-solid), per block (--bsolid, default), per +directory (--dsolid), appendable solid (--asolid), and solid (--solid). Of course, compressing each file (or each directory) individually can't achieve a compression ratio as high as compressing solidly the whole tar @@ -107,7 +107,6 @@ equivalent to '-1 --solid' tarlz supports the following options: -'-h' '--help' Print an informative help message describing the options and exit. @@ -118,14 +117,17 @@ equivalent to '-1 --solid' '-A' '--concatenate' - Append tar.lz archives to the end of a tar.lz archive. All the - archives involved must be regular (seekable) files compressed as - multimember lzip files, and the two end-of-file blocks plus any - zero padding must be contained in the last lzip member of each - archive. The intermediate end-of-file blocks are removed as each - new archive is concatenated. Exit with status 0 without modifying - the archive if no FILES have been specified. Tarlz can't - concatenate uncompressed tar archives. + Append one or more archives to the end of an archive. All the + archives involved must be regular (seekable) files, and must be + either all compressed or all uncompressed. Compressed and + uncompressed archives can't be mixed. Compressed archives must be + multimember lzip files with the two end-of-file blocks plus any + zero padding contained in the last lzip member of each archive. + The intermediate end-of-file blocks are removed as each new archive + is concatenated. If the archive is uncompressed, tarlz parses and + skips tar headers until it finds the end-of-file blocks. Exit with + status 0 without modifying the archive if no FILES have been + specified. '-B BYTES' '--data-size=BYTES' @@ -158,21 +160,38 @@ equivalent to '-1 --solid' '--diff' Find differences between archive and file system. For each tar member in the archive, verify that the corresponding file exists - and is of the same type (regular file, directory, etc). Report the - differences found in type, mode (permissions), owner and group - IDs, modification time, file size, file contents (of regular - files), target (of symlinks) and device number (of block/character - special files). + and is of the same type (regular file, directory, etc). Report on + standard output the differences found in type, mode (permissions), + owner and group IDs, modification time, file size, file contents + (of regular files), target (of symlinks) and device number (of + block/character special files). + + As tarlz removes leading slashes from member names, the '-C' + option may be used in combination with '--diff' when absolute + filenames were used on archive creation: 'tarlz -C / -d'. + Alternatively, tarlz may be run from the root directory to perform + the comparison. '--ignore-ids' Make '--diff' ignore differences in owner and group IDs. This option is useful when comparing an '--anonymous' archive. +'--exclude=PATTERN' + Exclude files matching a shell pattern like '*.o'. A file is + considered to match if any component of the filename matches. For + example, '*.o' matches 'foo.o', 'foo.o/bar' and 'foo/bar.o'. + '-f ARCHIVE' '--file=ARCHIVE' Use archive file ARCHIVE. '-' used as an ARCHIVE argument reads from standard input or writes to standard output. +'-h' +'--dereference' + Follow symbolic links during archive creation, appending or + comparison. Archive or compare the files they point to instead of + the links themselves. + '-n N' '--threads=N' Set the number of (de)compression threads, overriding the system's @@ -197,14 +216,18 @@ equivalent to '-1 --solid' '-r' '--append' - Append files to the end of a tar.lz archive. The archive must be a - regular (seekable) file compressed as a multimember lzip file, and - the two end-of-file blocks plus any zero padding must be contained - in the last lzip member of the archive. First this last member is - removed, then the new members are appended, and then a new - end-of-file member is appended to the archive. Exit with status 0 - without modifying the archive if no FILES have been specified. - Tarlz can't append files to an uncompressed tar archive. + Append files to the end of an archive. The archive must be a + regular (seekable) file either compressed or uncompressed. + Compressed members can't be appended to an uncompressed archive, + nor vice versa. If the archive is compressed, it must be a + multimember lzip file with the two end-of-file blocks plus any + zero padding contained in the last lzip member of the archive. + Appending works as follows; first the end-of-file blocks are + removed, then the new members are appended, and finally two new + end-of-file blocks are appended to the archive. If the archive is + uncompressed, tarlz parses and skips tar headers until it finds + the end-of-file blocks. Exit with status 0 without modifying the + archive if no FILES have been specified. '-t' '--list' @@ -221,10 +244,10 @@ equivalent to '-1 --solid' the FILES given. Else extract all the files in the archive. '-0 .. -9' - Set the compression level. The default compression level is '-6'. - Like lzip, tarlz also minimizes the dictionary size of the lzip - members it creates, reducing the amount of memory required for - decompression. + Set the compression level for '--create' and '--append'. The + default compression level is '-6'. Like lzip, tarlz also minimizes + the dictionary size of the lzip members it creates, reducing the + amount of memory required for decompression. Level Dictionary size Match length limit -0 64 KiB 16 bytes @@ -239,8 +262,10 @@ equivalent to '-1 --solid' -9 32 MiB 273 bytes '--uncompressed' - With '--create', don't compress the created tar archive. Create an - uncompressed tar archive instead. + With '--create', don't compress the tar archive created. Create an + uncompressed tar archive instead. With '--append', don't compress + the new members appended to the tar archive. Compressed members + can't be appended to an uncompressed archive, nor vice versa. '--asolid' When creating or appending to a compressed archive, use appendable @@ -314,6 +339,14 @@ equivalent to '-1 --solid' the posix pax format; i.e., the lack of a mandatory check sequence in the extended records. *Note crc32::. +'--out-slots=N' + Number of 1 MiB output packets buffered per worker thread during + multi-threaded creation or appending to compressed archives. + Increasing the number of packets may increase compression speed if + the files being archived are larger than 64 MiB compressed, but + requires more memory. Valid values range from 1 to 1024. The + default value is 64. + Exit status: 0 for a normal exit, 1 for environmental problems (file not found, invalid flags, I/O errors, etc), 2 to indicate a corrupt or @@ -345,7 +378,7 @@ sets). The members simply appear one after another in the file, with no additional information before, between, or after them. Each lzip member contains one or more tar members in a simplified -posix pax interchange format; the only pax typeflag value supported by +posix pax interchange format. The only pax typeflag value supported by tarlz (in addition to the typeflag values defined by the ustar format) is 'x'. The pax format is an extension on top of the ustar format that removes the size limitations of the ustar format. @@ -714,7 +747,7 @@ speed by the number of available processors), the uncompressed archive must be at least as large as the number of worker threads times the block size (*note --data-size::). Else some processors will not get any data to compress, and compression will be proportionally slower. The -maximum speed increase achievable on a given file is limited by the +maximum speed increase achievable on a given archive is limited by the ratio (uncompressed_size / data_size). For example, a tarball the size of gcc or linux will scale up to 10 or 12 processors at level -9. @@ -835,20 +868,20 @@ Concept index Tag Table: Node: Top223 -Node: Introduction1089 -Node: Invoking tarlz3228 -Ref: --data-size5107 -Ref: --bsolid10054 -Node: File format13298 -Ref: key_crc3218118 -Node: Amendments to pax format23535 -Ref: crc3224059 -Ref: flawed-compat25084 -Node: Multi-threaded tar27451 -Node: Minimum archive sizes29990 -Node: Examples32120 -Node: Problems33789 -Node: Concept index34315 +Node: Introduction1086 +Node: Invoking tarlz3280 +Ref: --data-size5339 +Ref: --bsolid11442 +Node: File format15072 +Ref: key_crc3219892 +Node: Amendments to pax format25309 +Ref: crc3225833 +Ref: flawed-compat26858 +Node: Multi-threaded tar29225 +Node: Minimum archive sizes31764 +Node: Examples33897 +Node: Problems35566 +Node: Concept index36092 End Tag Table |