pax [-cdnv] [-H | -L] [-f archive] [-o options]... [-s replstr]... [pattern]...
pax -r [-cdiknuv@/] [-H | -L] [-f archive] [-o options]... [-p string]... [-s replstr]... [pattern]...
pax -w [-dituvX@/] [-H | -L] [-b blocksize] [-a] [-f archive] [-o options]... [-s replstr]... [-x format] [file]...
pax -r -w [-diklntuvX@/] [-H | -L] [-o options]... [-p string]... [-s replstr]... [file]... directory
If an attempt is made to extract a directory when the directory already exists, this is not considered an error. If an attempt is made to extract a FIFO when the FIFO already exists, this is not considered an error.
The ownership, access and modification times, and file mode of the restored files are discussed under the -p option.
If no file operands are specified, a list of files to copy, one per line, are read from the standard input. A file of type directory includes all of the files in the file hierarchy rooted at the file.
The effect of the copy is as if the copied files were written to an archive file and then subsequently extracted, except that there can be hard links between the original and the copied files. If the destination directory is a subdirectory of one of the files to be copied, the results are unspecified. It is an error if directory does not exist, is not writable by the user, or is not a directory.
In read or copy modes, if intermediate directories are necessary to extract an archive member, pax performs actions equivalent to the mkdir(2) function, called with the following arguments:
If any specified pattern or file operands are not matched by at least one file or archive member, pax writes a diagnostic message to standard error for each one that did not match and exits with a non-zero exit status.
The supported archive formats are automatically detected on input. The default output archive format is tar(1).
A single archive can span multiple files. pax determines what file to read or write as the next file.
If the selected archive format supports the specification of linked files, it is an error if these files cannot be linked when the archive is extracted, except if the files to be linked are symbolic links and the system is not capable of making hard links to symbolic links. In that case, separate copies of the symbolic link are created instead. Any of the various names in the archive that represent a file can be used to select the file for extraction. For archive formats that do not store file contents with each name that causes a hard link, if the file that contains the data is not extracted during this pax session, either the data is restored from the original file, or a diagnostic message is displayed with the name of a file that can be used to extract the data. In traversing directories, pax detects infinite loops, that is, entering a previously visited directory that is an ancestor of the last file visited. When it detects an infinite loop, pax writes a diagnostic message to standard error and terminates.
The results of extracting a hard link to a file that has been renamed during extraction are unspecified.
Some keywords apply only to certain file formats, as indicated with each description. Use of keywords that are inapplicable to the file format being processed produces undefined results.
Keywords in the options argument must be a string that would be a valid portable filename.
Keywords are not expected to be filenames, merely to follow the same character composition rules as portable filenames.
Keywords can be preceded with white space. The value field consists of zero or more characters. Within value, the application precedes any literal comma with a backslash, which is ignored, but preserves the comma as part of value. A comma as the final character, or a comma followed solely by white space as the final characters, in options is ignored. Multiple -o options can be specified. If keywords given to these multiple -o options conflict, the keywords and values appearing later in command line sequence take precedence and the earlier ones are silently ignored. The following keyword values of options are supported for the file formats as indicated:
would suppress security-related information.
When multiple -o delete=pattern options are specified, the patterns are additive. All keywords matching the specified string patterns are omitted from extended header records that pax produces.
Any other '%' characters in string produce undefined results.
If no -o exthdr.name=string is specified, pax uses the following default value:
Any other '%' characters in string produce undefined results.
If no -o globexthdr.name=string is specified, pax uses the following default value:
where $TMPDIR represents the value of the TMPDIR environment variable. If TMPDIR is not set, pax uses /tmp.
If no -o invalid= option is specified, pax acts as if -o invalid=bypass were specified. Any overwriting of existing files that can be allowed by the -o invalid= actions are subject to permission (-p) and modification time (-u) restrictions, and are suppressed if the -k option is also specified.
In addition to these keywords, if the -x pax format is specified, any of the keywords and values, including implementation extensions, can be used in -o option-arguments, in either of two modes:
pax -r -o " gname:=mygroup, " <archive
the group name is forced to a new value for all files read from the archive.
In the preceding list, preserve indicates that an attribute stored in the archive is given to the extracted file, subject to the permissions of the invoking process. Otherwise, the attribute is determined as part of the normal file creation action. The access and modification times of the file is preserved unless otherwise specified with the -p option or not stored in the archive. All attributes that are not preserved are determined as part of the normal file creation action.
If neither the e nor the o specification character is specified, or the user ID and group ID are not preserved for any reason, pax does not set the setuid and setgid bits of the file mode.
If the preservation of any of these items fails for any reason, pax writes a diagnostic message to standard error. Failure to preserve these items affects the final exit status, but does not cause the extracted file to be deleted.
If file-characteristic letters in any of the string option-arguments are duplicated or conflict with each other, the ones given last take precedence. For example, if -p eme is specified, file modification times are preserved.
-s /old/new/ [gp]
where, as in ed, old is a basic regular expression and new can contain an ampersand (&), a \n backreference, where n is a digit, or subexpression matching. The old string is also permitted to contain newlines.
Any non-null character can be used as a delimiter (/ shown here). Multiple -s expressions can be specified. The expressions are applied in the order specified, terminating with the first successful substitution. The optional trailing g is as defined in the ed command. The optional trailing p causes successful substitutions to be written to standard error. File or archive member names that substitute to the empty string are ignored when reading and writing archives.
This archive format allows files with UIDs and GIDs up to 262143 to be stored in the archive. Files with UIDs and GIDs greater than this value are archived with the UID and GID of 60001.
Similar to ustar. Also allows archiving and extracting files whose size is greater than 8GB; whose UID, GID, devmajor, or devminor values are greater than 2097151; whose path (including filename) is greater than 255 characters; or whose linkname is greater than 100 characters.
This archive format allows files with UIDs and GIDs up to 2097151 to be stored in the archive. Files with UIDs and GIDs greater than this value are archived with the UID and GID of 60001.
Any attempt to append to an archive file in a format different from the existing archive format causes pax to exit immediately with a non-zero exit status.
In copy mode, if no -x format is specified, pax behaves as if -x pax were specified.
When traversing the file hierarchy specified by a path name, pax descends into the attribute directory for any file with extended attributes. Extended attributes go into the archive as special files.
When this flag is used during file extraction, any extended attributes associated with a file being extracted are also extracted. Extended attribute files can only be extracted from an archive as part of a normal file extract. Attempts to explicitly extract attribute records are ignored.
When traversing the file hierarchy specified by a path name, pax descends into the attribute directory for any file with extended attributes. Extended attributes go into the archive as special files. When this flag is used during file extraction, any extended attributes associated with a file being extracted are also extracted. Extended attribute files can only be extracted from an archive as part of a normal file extract. Attempts to explicitly extract attribute records are ignored.
Specifying more than one of the mutually-exclusive options -H and -L is not considered an error. The last option specified determines the behavior of the utility.
The options that operate on the names of files or archive members (-c, -i, -n, -s, -u and -v) interact as follows.
In read mode, the archive members are selected based on the user-specified pattern operands as modified by the -c, -n and -u options. Then, any -s and -i options modify, in that order, the names of the selected files. The -v option writes names resulting from these modifications.
In write mode, the files are selected based on the user-specified path names as modified by the -n and -u options. Then, any -s and -i options modify, in that order, the names of these selected files. The -v option writes names resulting from these modifications.
If both the -u and -n options are specified, pax does not consider a file selected unless it is newer than the file to which it is compared.
The result of the keyword conversion argument is the value from the applicable header field or extended header, without any trailing NULs.
All keyword values used as conversion arguments are translated from the UTF -8 encoding to the character set appropriate for the local file system, user database, and so on, as applicable.
%b %e %H:%M %Y
(keyword[,keyword] ... )
The values for all the keywords that are non-null are concatenated, each separated by a '/'. The default is (path) if the keyword path is defined. Otherwise, the default is (prefix,name).
"%s -> %s", value of keyword, contents of link
Otherwise, the %L conversion specification is the equivalent of %F.
In list mode, when the -o listopt=format option has been specified, the selected archive members are written to standard output using the format described above under List Mode Format Specifications. In list mode without the -o listopt=format option, the table of contents of the selected archive members are written to standard output using the following format:
If the -v option is specified in list mode, the table of contents of the selected archive members are written to standard output using the following formats:
"%s == %s\n", <ls -l listing, linkname
"%s\n", <ls -l listing>
where <ls -l listing> is the format specified by the ls command with the -l option. When writing path names in this format, it is unspecified what is written for fields for which the underlying archive format does not have the correct information, although the correct number of blank-character-separated fields are written.
In list mode, standard output is not buffered more than a line at a time.
These path names are written as soon as processing is begun on the file or archive member, and are flushed to standard error. The trailing NEWLINE character, which is not buffered, is written when the file has been read or written.
If the -s option is specified, and the replacement string has a trailing p, substitutions are written to standard error in the following format:
"%s >> %s\n", <original pathname>, <new pathname>
In all operating modes of pax, optional messages of unspecified format concerning the input archive format and volume number, the number of files, blocks, volumes, and media parts as well as other diagnostic messages can be written to standard error.
In all formats, for both standard output and standard error, it is unspecified how non-printable characters in path names or link names are written.
When pax is in read mode or list mode, using the -x pax archive format, and a file name, link name, owner name, or any other field in an extended header record cannot be translated from the pax UTF-8 codeset format to the codeset and current locale of the implementation, pax writes a diagnostic message to standard error, processes the file as described for the -o invalid= option, and then processes the next file in the archive.
If the extraction of a file from an archive is prematurely terminated by a signal or error, pax can have only partially extracted the file or, if the -n option was not specified, can have extracted a file of the same name as that specified by the user, but which is not the file the user wanted. Additionally, the file modes of extracted directories can have additional bits from the read, write, execute mask set as well as incorrect modification and access times.
The one path name per line format of standard input precludes path names containing newlines. Although such path names violate the portable filename guidelines, they can exist and their presence can inhibit usage of pax within shell scripts. This problem is inherited from historical archive programs. The problem can be avoided by listing file name arguments on the command line instead of on standard input.
It is almost certain that appropriate privileges are required for pax to accomplish parts of this. Specifically, creating files of type block special or character special, restoring file access times unless the files are owned by the user (the -t option), or preserving file owner, group, and mode (the -p option) all probably require appropriate privileges.
In read mode, implementations are permitted to overwrite files when the archive has multiple members with the same name. This can fail if permissions on the first version of the file do not permit it to be overwritten.
When using the -x xustar and -x -pax archive formats, if the underlying file system reports that the file being archived contains holes, the Solaris pax utility records the presence of holes in an extended header record when the file is archived. If this extended header record is associated with a file in the archive, those holes are recreated whenever that file is extracted from the archive. See the SEEK_DATA and SEEK_HOLE whence values in lseek(2). In all other cases, any NUL (\0) characters found in the archive are written to the file when it is extracted.
See largefile(7) for the description of the behavior of pax when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
The following command:
example% pax -w -f /dev/rmt/1m .
copies the contents of the current directory to tape drive 1, medium density. This assumes historical System V device naming procedures. The historical BSD device name would be /dev/rmt9.
Example 2 Copying the Directory Hierarchy
The following commands:
example% mkdir newdir example% pax -rw olddir newdir
copy the olddir directory hierarchy to newdir.
Example 3 Reading an Archive Extracted Relative to the Current Directory
The following command:
example% pax -r -s ',^//*usr//*,,' -f a.pax
reads the archive a.pax, with all files rooted in /usr in the archive extracted relative to the current directory.
Example 4 Overriding the Default Output Description
Using the option:
-o listopt="%M %(atime)T %(size)D %(name)s"
overrides the default output description in Standard Output and instead writes:
-rw-rw- - - Jan 12 15:53 2003 1492 /usr/foo/bar
Using the options:
-o listopt='%L\t%(size)D\n%.7' \ -o listopt='(name)s\n%(atime)T\n%T'
overrides the default output description in standard output and instead writes:
usr/foo/bar -> /tmp 1492 /usr/foo Jan 12 15:53 1991 Jan 31 15:53 2003
At the end of the archive file there are two 512-byte blocks filled with binary zeroes, interpreted as an end-of-archive indicator.
The following is a schematic of an example archive with global extended header records and two actual files in pax format archive. In the example, the second file in the archive has no extended header preceding it, presumably because it has no need for extended attributes.
|Global Extended Header||ustar Header [typeflag=g]|
|Global Extended Header Data|
|File 1: Extended Header is included||ustar Header [typeflag=x]|
|Extended Header Data|
|ustar Header Data for File 1|
|File 2: No Extended Header is included||ustar Header [typeflag=0]|
|Data for File2|
|End of Archive Indicator||Block of binary zeros|
|Block of binary zeros|
For both of these types, the size field is the size of the extended header records in octets. The other fields in the header block are not meaningful to this version of pax. However, if this archive is read by pax conforming to a previous version of ISO POSIX-2:1993 Standard, the header block fields are used to create a regular file that contains the extended header records as data. Therefore, header block field values should be selected to provide reasonable file access to this regular file.
A further difference from the ustar header block is that data blocks for files of typeflag 1 (the digit one) (hard link) might be included, which means that the size field can be greater than zero. Archives created by pax -o linkdata includes these data blocks with the hard links.
An extended header consists of one or more records, each constructed as follows:
"%d %s=%s\n", length, keyword, value
The extended header records are encoded according to the ISO/IEC 10646-1: 2000 standard (UTF-8). length, BLANK, equals sign (=), and NEWLINE are limited to the portable character set, as encoded in UTF-8. keyword and value can be any UTF-8 characters. length is the decimal length of the extended header record in octets, including the trailing NEWLINE.
keyword is one of the entries from the following list or a keyword provided as an implementation extension. Keywords consisting entirely of lowercase letters, digits, and periods are reserved for future standardization. A keyword does not include an equals sign.
In the following list, the notation of file(s) or block(s) are used to acknowledge that a keyword affects the specified single file after a typeflag x extended header, but possibly multiple files after typeflag g. Any requirements in the list for pax to include a record when in write or copy mode applies only when such a record has not already been provided through the use of the -o option. When used in copy mode, pax behaves as if an archive had been created with applicable extended header records and then extracted.
|ISO-IR 646 1990||ISO/IEC646:1990|
|ISO-IR 8859 1 1998||ISO/IEC8859-1:1998|
|ISO-IR 8859 2 1999||ISO/IEC 8859-2:1999|
|ISO-IR 8859 3 1999||ISO/IEC 8859-3:1999|
|ISO-IR 8859 4 1999||ISO/IEC8859-4:1998|
|ISO-IR 8859 5 1999||ISO/IEC8859-5-1999|
|ISO-IR 8859 6 1999||ISO/IEC8859-6-1999|
|ISO-IR 8859 7 1987||ISO/IEC8859-7:1987|
|ISO-IR 8859 8 1999||ISO/IEC8859-8:1999|
|ISO-IR 8859 9 1999||ISO/IEC8859-9:1999|
|ISO-IR 8859 10 1998||ISO/IEC8859-10:1999|
|ISO-IR 8859 13 1998||ISO/IEC8859-13:1998|
|ISO-IR 8859 14 1998||ISO/IEC8859-14:1998|
|ISO-IR 8859 15 1999||ISO/IEC8859-15:1999|
|ISO-IR 10646 2000||ISO/IEC 10646:2000|
|ISO-IR 10646 2000 UTF-8||ISO/IEC 10646,UTF-8 encoding|
The encoding is included in an extended header for information only; when pax is used as described in IEEE Std 1003.1-200x, it does not translate the file data into any other encoding. The BINARY entry indicates unencoded binary data. When used in write or copy mode, it is implementation-defined whether pax includes a charset extended header record for a file.
If the value field is zero length, it deletes any header block field, previously entered extended header value, or global extended header value of the same name.
If a keyword in an extended header record (or in an -o option-argument) overrides or deletes a corresponding field in the ustar header block, pax ignores the contents of that header block field.
Unlike the ustar header block fields, NULLs does not delimit values; all characters within the value field are considered data for the field.
The logical records can be grouped for physical I/O operations, as described under the -bblocksize and -x ustar options. Each group of logical records can be written with a single operation equivalent to the write(2) function. On magnetic tape, the result of this write is a single tape physical block. The last physical block always is the full size, so logical records after the two zero logical records can contain undefined data.
The header logical record is structured as shown in the following table. All lengths and offsets are in decimal.
Table 1 ustar Header Block
|Field Name||Octet Offset||Length (in Octets)|
All characters in the header logical record is represented in the coded character set of the ISO/IEC 646: 1991 standard. For maximum portability between implementations, names should be selected from characters represented by the portable filename character set as octets with the most significant bit zero. If an implementation supports the use of characters outside of slash and the portable filename character set in names for files, users, and groups, one or more implementation-defined encodings of these characters are provided for interchange purposes.
pax never creates filenames on the local system that cannot be accessed using the procedures described in IEEE Std 1003.1-200x. If a filename is found on the medium that would create an invalid filename, it is implementation-defined whether the data from the file is stored on the file hierarchy and under what name it is stored. pax can choose to ignore these files as long as it produces an error indicating that the file is being ignored. Each field within the header logical record is contiguous; that is, there is no padding used.
Each field within the header logical record is contiguous. There is no padding used. Each character on the archive medium is stored contiguously.
The fields magic, uname and gname are character strings, each of which is terminated by a NULL character. The fields name, linkname, and prefix are NULL-terminated character strings except when all characters in the array contain non-NULL characters including the last character. The version field is two octets containing the characters 00 (zero-zero) The typeflag contains a single character. All other fields are leading zero-filled octal numbers using digits from the ISO/IEC 646:1991 standard IRV. Each numeric field is terminated by one or more SPACE of NULL characters.
Each character on the archive medium is stored contiguously. The fields magic, uname, and gname are character strings each terminated by a NULL character.
name, linkname, and prefix are NULL-terminated character strings except when all characters in the array contain non-NULL characters including the last character. The version field is two octets containing the characters 00 (zero-zero). The typeflag contains a single character. All other fields are leading zero-filled octal numbers using digits from the ISO/IEC 646: 1991 standard IRV. Each numeric field is terminated by one or more spaces or NULL characters.
The name and the prefix fields produce the pathname of the file. A new pathname is formed, if prefix is not an empty string (its first character is not NULL), by concatenating prefix (up to the first NULL character), a slash character, and name; otherwise, name is used alone. In either case, name is terminated at the first NULL character. If prefix begins with a NULL character, it is ignored. In this manner, pathnames of at most 256 characters can be supported. If a pathname does not fit in the space provided, pax notifies the user of the error, and does not store any part of the file-header or data-on the medium.
The linkname field does not use the prefix to produce a pathname. As such, a linkname is limited to 100 characters. If the name does not fit in the space provided, pax notifies the user of the error, and does not attempt to store the link on the medium. The mode field provides 12 bits encoded in the ISO/IEC 646: 1991 standard octal digit representation. The encoded bits represent the following values in the ustar mode field:
|Bit Value||IEE Std 1003.1-2001 Bit||Description|
|04000||S_ISUID||Set UID on execution|
|02000||S_ISGID||Set GID on execution|
|01000||reserved||Reserved for future standardization|
|00400||S_IRUSR||Read permission for file owner class|
|00200||S_IWUSR||Write permission for file owner class|
|00100||S_IXUSR||Execute/search permission for file owner class|
|00040||S_IRGRP||Read permission for file group class|
|00020||S_IWGRP||Write permission for file group class|
|00010||S_IXGRP||Execute/search permission for file group class|
|00004||S_IROTH||Read permission for file other class|
|00002||S_IWOTH||Write permission for file other class|
|00001||S_IXOTH||Execute/search permission for file other class|
When appropriate privilege is required to set one of these mode bits, and the user restoring the files from the archive does not have the appropriate privilege, the mode bits for which the user does not have appropriate privilege are ignored. Some of the mode bits in the archive format are not mentioned elsewhere in volume IEEE Std 1003.1-200x. If the implementation does not support those bits, they can be ignored.
The uid and gid fields are the user and group ID of the owner and group of the file, respectively.
The size field is the size of the file in octets. If the typeflag field is set to specify a file to be of type 1 (a link) or 2 (a symbolic link), the size field is specified as zero. If the typeflag field is set to specify a file of type 5 (directory), the size field is interpreted as described under the definition of that record type. No data logical records are stored for types 1, 2, or 5. If the typeflag field is set to 3 (character special file), 4 (block special file), or 6 (FIFO), the meaning of the size field is unspecified by volume IEEE Std 1003.1-200x, and no data logical records is stored on the medium. Additionally, for type 6, the size field is ignored when reading. If the typeflag field is set to any other value, the number of logical records written following the header is (size+511)/512, ignoring any fraction in the result of the division.
The mtime field is the modification time of the file at the time it was archived. It is the ISO/IEC 646: 1991 standard representation of the octal value of the modification time obtained from the stat() function.
The chksum field is the ISO/IEC 646: 1991 standard IRV representation of the octal value of the simple sum of all octets in the header logical record. Each octet in the header is treated as an unsigned value. These values are added to an unsigned integer, initialized to zero, the precision of which is not less than 17 bits. When calculating the checksum, the chksum field is treated as if it were all spaces.
The typeflag field specifies the type of file archived. If a particular implementation does not recognize the type, or the user does not have appropriate privilege to create that type, the file is extracted as if it were a regular file if the file type is defined to have a meaning for the size field that could cause data logical records to be written on the medium. If conversion to a regular file occurs, pax produces an error indicating that the conversion took place. All of the typeflag fields are coded in the ISO/IEC 646: 1991 standard IRV:
When used in write or copy mode and the xustar or pax format (see -x format) was specified, pax includes a SUN.devmajor extended header record for each file whose major device number is too large to fit in 8 octets.
When used in write or copy mode and the xustar or pax format (see -x format) is specified, pax includes a SUN.devminor extended header record for each file whose minor device number is too large to fit in 8 octets.
In write or copy modes and when the xustar or pax format (see -x format) is specified, pax includes a SUN.holesdata extended header record if the underlying file system supports the detection of files with holes (see fpathconf(2)) and reports that there is at least one hole in the file being archived. value consists of two or more consecutive entries of the following form:
where the data and hole offsets are the long values returned by passing SEEK_DATA and SEEK_HOLE to lseek(2), respectively. For example, the following entry is an example of the SUN.holesdata entry in the extended header for a file with data offsets at bytes 0, 24576, and 49152, and hole offsets at bytes 8192, 32768, and 49159: 49 SUN.holesdata= 0 8192 24576 32768 49152 49159:
49 SUN.holesdata= 0 8192 24576 32768 49152 49159
When extracting a file from an archive in read or copy modes, if a SUN.holesdata = pair is found in the extended header for the file, then the file is restored with the holes identified using this data. For example, for the SUN.holesdata provided in the example above, bytes from 0 to 8192 are restored as data, a hole is created up to the next data position (24576), bytes 24576 to 32768 is restored as data, and so forth.
Attempts to archive a socket using ustar interchange format produce a diagnostic message. Handling of other file types is implementation-defined.
The magic field is the specification that this archive was output in this archive format. If this field contains ustar (the five characters from the ISO/IEC 646: 1991 standard IRV shown followed by NULL), the uname and gname fields contain the ISO/IEC 646: 1991 standard IRV representation of the owner and group of the file, respectively (truncated to fit, if necessary). When the file is restored by a privileged, protection-preserving version of the utility, the user and group databases are scanned for these names. If found, the user and group IDs contained within these files are used rather than the values contained within the uid and gid fields.
An archive can be recorded as a series of fixed-size blocks of octets. This blocking is be used only to make physical I/O more efficient. The last group of blocks are always at the full size.
For the octet-oriented cpio archive format, the individual entry information are in the order indicated and described by the following table: Octet-Oriented cpio Archive Entry. See the cpio.h header for additional details.
|Header Field Name||Length (in Octets)||Interpreted as|
|Filename Field Name||Length||Interpreted as|
|Filename Field Name||Length||Interpreted as|
Directories, FIFOs, symbolic links, and regular files are supported on a system conforming to volume IEEE Std 1003.1-200x; additional values defined previously are reserved for compatibility with existing systems. Additional file types can be supported. Such files should not be written to archives intended to be transported to other systems.
|File Permissions Name||Value||Indicates|
|File Type Name||Value||Indicates|
|C_ISBLK||060000||Block special file|
|C_ISCHR||020000||Character special file|
|ATTRIBUTE TYPE||ATTRIBUTE VALUE|
IEEE Std 1003.1-200x, ISO/IEC 646: 1991, ISO POSIX-2:1993 Standard
|June 13, 2021||OmniOS|