2 .\" Copyright (c) 1992 Keith Muller.
3 .\" Copyright (c) 1992, 1993
4 .\" The Regents of the University of California. All rights reserved.
6 .\" This code is derived from software contributed to Berkeley by
7 .\" Keith Muller of the University of California, San Diego.
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\" notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\" notice, this list of conditions and the following disclaimer in the
16 .\" documentation and/or other materials provided with the distribution.
17 .\" 4. Neither the name of the University nor the names of its contributors
18 .\" may be used to endorse or promote products derived from this software
19 .\" without specific prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" @(#)pax.1 8.4 (Berkeley) 4/18/94
41 .Nd read and write file archives and copy directory hierarchies
109 .Op Fl b Ar blocksize
150 .Op Fl diklntuvDHLPXYZ
181 utility will read, write, and list the members of an archive file,
182 and will copy directory hierarchies.
183 These operations are independent of the specific archive format,
184 and support a wide variety of different archive formats.
185 A list of supported archive formats can be found under the description of the
193 options specifies which of the following functional modes
196 .Em list , read , write ,
204 a table of contents of the members of the archive file read from
206 whose pathnames match the specified
208 The table of contents contains one filename per line
209 and is written using single line buffering.
212 Extract the members of the archive file read from the
214 with pathnames matching the specified
216 The archive format and blocking is automatically determined on input.
217 When an extracted file is a directory, the entire file hierarchy
218 rooted at that directory is extracted.
219 All extracted files are created relative to the current file hierarchy.
220 The setting of ownership, access and modification times, and file mode of
221 the extracted files are discussed in more detail under the
226 Write an archive containing the
230 using the specified archive format.
233 operands are specified, a list of files to copy with one per line is read from
237 operand is also a directory, the entire file hierarchy rooted
238 at that directory will be included.
243 operands to the destination
247 operands are specified, a list of files to copy with one per line is read from
252 operand is also a directory the entire file
253 hierarchy rooted at that directory will be included.
256 is as if the copied files were written to an archive file and then
257 subsequently extracted, except that there may be hard links between
258 the original and the copied files (see the
265 must not be one of the
267 operands or a member of a file hierarchy rooted at one of the
272 under these conditions is unpredictable.
275 While processing a damaged archive during a
281 will attempt to recover from media defects and will search through the archive
282 to locate and process the largest number of archive members possible (see the
284 option for more details on error handling).
288 operand specifies a destination directory pathname.
291 operand does not exist, or it is not writable by the user,
292 or it is not of type directory,
294 will exit with a non-zero exit status.
298 operand is used to select one or more pathnames of archive members.
299 Archive members are selected using the pattern matching notation described
304 operand is not supplied, all members of the archive will be selected.
307 matches a directory, the entire file hierarchy rooted at that directory will
311 operand does not select at least one archive member,
315 operands in a diagnostic message to
317 and then exit with a non-zero exit status.
321 operand specifies the pathname of a file to be copied or archived.
324 operand does not select at least one archive member,
328 operand pathnames in a diagnostic message to
330 and then exit with a non-zero exit status.
332 The following options are supported:
335 Read an archive file from
337 and extract the specified
339 If any intermediate directories are needed in order to extract an archive
340 member, these directories will be created as if
342 was called with the bitwise inclusive
345 .Dv S_IRWXU , S_IRWXG ,
348 as the mode argument.
349 When the selected archive format supports the specification of linked
350 files and these files cannot be linked while the archive is being extracted,
352 will write a diagnostic message to
354 and exit with a non-zero exit status at the completion of operation.
358 in the specified archive format.
361 operands are specified,
363 is read for a list of pathnames with one per line without any leading or
369 to the end of an archive that was previously written.
370 If an archive format is not specified with a
372 option, the format currently being used in the archive will be selected.
373 Any attempt to append to an archive in a format different from the
374 format already used in the archive will cause
377 with a non-zero exit status.
378 The blocking size used in the archive volume where writing starts
379 will continue to be used for the remainder of that archive volume.
382 Many storage devices are not able to support the operations necessary
383 to perform an append operation.
384 Any attempt to append to an archive stored on such a device may damage the
385 archive or have other unpredictable results.
386 Tape drives in particular are more likely to not support an append operation.
387 An archive stored in a regular file system file or on a disk device will
388 usually support an append operation.
389 .It Fl b Ar blocksize
393 block the output at a positive decimal integer number of
394 bytes per write to the archive file.
397 must be a multiple of 512 bytes with a maximum of 64512 bytes.
398 Archives larger than 32256 bytes violate the
400 standard and will not be portable to all systems.
407 to specify multiplication by 1024 (1K) or 512, respectively.
412 to indicate a product.
413 A specific archive device may impose additional restrictions on the size
414 of blocking it will support.
415 When blocking is not specified, the default
417 is dependent on the specific archive format being used (see the
421 Match all file or archive members
423 those specified by the
429 Cause files of type directory being copied or archived, or archive members of
430 type directory being extracted, to match only the directory file or archive
431 member and not the file hierarchy rooted at the directory.
435 as the pathname of the input or output archive, overriding the default
445 A single archive may span multiple files and different archive devices.
448 will prompt for the pathname of the file or device of the next volume in the
451 Interactively rename files or archive members.
452 For each archive member matching a
454 operand or each file matching a
460 giving the name of the file, its file mode and its modification time.
463 utility will then read a line from
465 If this line is blank, the file or archive member is skipped.
466 If this line consists of a single period, the
467 file or archive member is processed with no modification to its name.
468 Otherwise, its name is replaced with the contents of the line.
471 utility will immediately exit with a non-zero exit status if
473 is encountered when reading a response or if
475 cannot be opened for reading and writing.
477 Do not overwrite existing files.
485 hard links are made between the source and destination file hierarchies
488 Select the first archive member that matches each
491 No more than one archive member is matched for each
493 When members of type directory are matched, the file hierarchy rooted at that
494 directory is also matched (unless
498 Information to modify the algorithm for extracting or writing archive files
499 which is specific to the archive format specified by
506 Specify one or more file characteristic options (privileges).
509 option-argument is a string specifying file characteristics to be retained or
510 discarded on extraction.
511 The string consists of the specification characters
515 Multiple characteristics can be concatenated within the same string
518 options can be specified.
519 The meaning of the specification characters are as follows:
522 Do not preserve file access times.
523 By default, file access times are preserved whenever possible.
525 .Sq Preserve everything ,
526 the user ID, group ID, file mode bits,
527 file access time, and file modification time.
528 This is intended to be used by
530 someone with all the appropriate privileges, in order to preserve all
531 aspects of the files as they are recorded in the archive.
534 flag is the sum of the
540 Do not preserve file modification times.
541 By default, file modification times are preserved whenever possible.
543 Preserve the user ID and group ID.
547 This intended to be used by a
549 with regular privileges who wants to preserve all aspects of the file other
551 The file times are preserved by default, but two other flags are offered to
552 disable this and use the time of extraction instead.
555 In the preceding list,
557 indicates that an attribute stored in the archive is given to the
558 extracted file, subject to the permissions of the invoking
560 Otherwise the attribute of the extracted file is determined as
561 part of the normal file creation action.
566 specification character is specified, or the user ID and group ID are not
567 preserved for any reason,
575 bits of the file mode.
576 If the preservation of any of these items fails for any reason,
578 will write a diagnostic message to
580 Failure to preserve these items will affect the final exit status,
581 but will not cause the extracted file to be deleted.
582 If the file characteristic letters in any of the string option-arguments are
583 duplicated or conflict with each other, the one(s) given last will take
587 is specified, file modification times are still preserved.
589 Modify the file or archive member names specified by the
593 operands according to the substitution expression
595 using the syntax of the
597 utility regular expressions.
598 The format of these regular expressions are:
603 is a basic regular expression and
605 can contain an ampersand (&), \\n (where n is a digit) back-references,
606 or subexpression matching.
609 string may also contain
612 Any non-null character can be used as a delimiter (/ is shown here).
615 expressions can be specified.
616 The expressions are applied in the order they are specified on the
617 command line, terminating with the first successful substitution.
618 The optional trailing
620 continues to apply the substitution expression to the pathname substring
621 which starts with the first character following the end of the last successful
623 The first unsuccessful substitution stops the operation of the
626 The optional trailing
628 will cause the final result of a successful substitution to be written to
630 in the following format:
631 .Dl <original pathname> >> <new pathname>
632 File or archive member names that substitute to the empty string
633 are not selected and will be skipped.
635 Reset the access times of any file or directory read or accessed by
637 to be the same as they were before being read or accessed by
640 Ignore files that are older (having a less recent file modification time)
641 than a pre-existing file or archive member with the same name.
644 an archive member with the same name as a file in the file system will be
645 extracted if the archive member is newer than the file.
648 a file system member with the same name as an archive member will be
649 written to the archive if it is newer than the archive member.
652 the file in the destination hierarchy is replaced by the file in the source
653 hierarchy or by a link to the file in the source hierarchy if the file in
654 the source hierarchy is newer.
658 operation, produce a verbose table of contents using the format of the
663 For pathnames representing a hard link to a previous member of the archive,
664 the output has the format:
665 .Dl <ls -l listing> == <link name>
666 For pathnames representing a symbolic link, the output has the format:
667 .Dl <ls -l listing> => <link name>
668 Where <ls -l listing> is the output format specified by the
670 utility when used with the
673 Otherwise for all the other operational modes
677 pathnames are written and flushed to
681 as soon as processing begins on that file or
685 is not buffered, and is written only after the file has been read or written.
687 Specify the output archive format, with the default format being
691 utility currently supports the following formats:
692 .Bl -tag -width "sv4cpio"
694 The extended cpio interchange format specified in the
697 The default blocksize for this format is 5120 bytes.
698 Inode and device information about a file (used for detecting file hard links
699 by this format) which may be truncated by this format is detected by
703 The old binary cpio format.
704 The default blocksize for this format is 5120 bytes.
705 This format is not very portable and should not be used when other formats
707 Inode and device information about a file (used for detecting file hard links
708 by this format) which may be truncated by this format is detected by
712 The System V release 4 cpio.
713 The default blocksize for this format is 5120 bytes.
714 Inode and device information about a file (used for detecting file hard links
715 by this format) which may be truncated by this format is detected by
719 The System V release 4 cpio with file crc checksums.
720 The default blocksize for this format is 5120 bytes.
721 Inode and device information about a file (used for detecting file hard links
722 by this format) which may be truncated by this format is detected by
728 tar format as found in
730 The default blocksize for this format is 10240 bytes.
731 Pathnames stored by this format must be 100 characters or less in length.
735 .Em hard links , soft links ,
738 will be archived (other file system types are not supported).
739 For backwards compatibility with even older tar formats, a
741 option can be used when writing an archive to omit the storage of directories.
742 This option takes the form:
743 .Dl Fl o Cm write_opt=nodir
745 The extended tar interchange format specified in the
748 The default blocksize for this format is 10240 bytes.
749 Pathnames stored by this format must be 250 characters or less in length.
754 utility will detect and report any file that it is unable to store or extract
755 as the result of any specific archive format restrictions.
756 The individual archive formats may impose additional restrictions on use.
757 Typical archive format restrictions include (but are not limited to):
758 file pathname length, file size, link pathname length and the type of the file.
762 to compress (decompress) the archive while writing (reading).
766 Limit the number of bytes written to a single archive volume to
775 to specify multiplication by 1048576 (1M), 1024 (1K) or 512, respectively.
778 limits can be separated by
780 to indicate a product.
783 Only use this option when writing an archive to a device which supports
784 an end of file read condition based on last (or largest) write offset
785 (such as a regular file or a tape drive).
786 The use of this option with a floppy or hard disk is not recommended.
788 This option is the same as the
790 option, except that the file inode change time is checked instead of the
791 file modification time.
792 The file inode change time can be used to select files whose inode information
793 (e.g.\& uid, gid, etc.) is newer than a copy of the file in the destination
796 Limit the number of consecutive read faults while trying to read a flawed
802 will attempt to recover from an archive read error and will
803 continue processing starting with the next file stored in the archive.
808 to stop operation after the first read error is detected on an archive volume.
815 to attempt to recover from read errors forever.
818 is a small positive number of retries.
821 Using this option with
823 should be used with extreme caution as
825 may get stuck in an infinite loop on a very badly flawed archive.
827 Select a file based on its
829 name, or when starting with a
832 A '\\' can be used to escape the
836 options may be supplied and checking stops with the first match.
838 Follow only command line symbolic links while performing a physical file
841 Follow all symbolic links to perform a logical file system traversal.
843 Do not follow symbolic links, perform a physical file system traversal.
844 This is the default mode.
845 .It Fl T Ar [from_date][,to_date][/[c][m]]
846 Allow files to be selected based on a file modification or inode change
847 time falling within a specified time range of
851 (the dates are inclusive).
854 is supplied, all files with a modification or inode change time
855 equal to or younger are selected.
858 is supplied, all files with a modification or inode change time
859 equal to or older will be selected.
864 only files with a modification or inode change time of exactly that
865 time will be selected.
873 mode, the optional trailing field
875 can be used to determine which file time (inode change, file modification or
876 both) are used in the comparison.
877 If neither is specified, the default is to use file modification time only.
880 specifies the comparison of file modification time (the time when
881 the file was last written).
884 specifies the comparison of inode change time (the time when the file
885 inode was last changed; e.g.\& a change of owner, group, mode, etc).
890 are both specified, then the modification and inode change times are
892 The inode change time comparison is useful in selecting files whose
893 attributes were recently changed or selecting files which were recently
894 created and had their modification time reset to an older time (as what
895 happens when a file is extracted from an archive and the modification time
897 Time comparisons using both file times is useful when
899 is used to create a time based incremental archive (only files that were
900 changed during a specified time range will be archived).
902 A time range is made up of six different fields and each field must contain two
905 .Dl [yy[mm[dd[hh]]]]mm[.ss]
908 is the last two digits of the year,
911 is the month (from 01 to 12),
913 is the day of the month (from 01 to 31),
915 is the hour of the day (from 00 to 23),
918 is the minute (from 00 to 59),
921 is the seconds (from 00 to 59).
924 is required, while the other fields are optional and must be added in the
926 .Dl Cm hh , dd , mm , yy .
929 field may be added independently of the other fields.
930 Time ranges are relative to the current time, so
932 would select all files with a modification or inode change time
933 of 12:34 PM today or later.
936 time range can be supplied and checking stops with the first match.
938 Select a file based on its
940 name, or when starting with a
943 A '\\' can be used to escape the
947 options may be supplied and checking stops with the first match.
949 When traversing the file hierarchy specified by a pathname,
950 do not descend into directories that have a different device ID.
953 field as described in
955 for more information about device ID's.
957 This option is the same as the
959 option, except that the inode change time is checked using the
960 pathname created after all the file name modifications have completed.
962 This option is the same as the
964 option, except that the modification time is checked using the
965 pathname created after all the file name modifications have completed.
968 The options that operate on the names of files or archive members
984 When extracting files during a
986 operation, archive members are
988 based only on the user specified pattern operands as modified by the
1001 options will modify in that order, the names of these selected files.
1006 options will be applied based on the final pathname.
1009 option will write the names resulting from these modifications.
1011 When archiving files during a
1013 operation, or copying files during a
1015 operation, archive members are
1017 based only on the user specified pathnames as modified by the
1027 option only applies during a copy operation).
1032 options will modify in that order, the names of these selected files.
1039 options will be applied based on the final pathname.
1042 option will write the names resulting from these modifications.
1044 When one or both of the
1048 options are specified along with the
1050 option, a file is not considered selected unless it is newer
1051 than the file to which it is compared.
1055 utility will exit with one of the following values:
1058 All files were processed successfully.
1064 .Dl "pax -w -f /dev/sa0 ."
1065 copies the contents of the current directory to the device
1069 .Dl pax -v -f filename
1070 gives the verbose table of contents for an archive stored in
1073 The following commands:
1076 .Dl pax -rw .\ /tmp/to
1077 will copy the entire
1079 directory hierarchy to
1083 .Dl pax -r -s ',^//*usr//*,,' -f a.pax
1086 with all files rooted in ``/usr'' into the archive extracted relative to the
1090 .Dl pax -rw -i .\ dest_dir
1091 can be used to interactively select the files to copy from the current
1096 .Dl pax -r -pe -U root -G bin -f a.pax
1097 will extract all files from the archive
1103 and will preserve all file permissions.
1106 .Dl pax -r -w -v -Y -Z home /backup
1107 will update (and list) only those files in the destination directory
1109 which are older (less recent inode change or file modification times) than
1110 files with the same name found in the source file tree
1115 cannot create a file or a link when reading an archive or cannot
1116 find a file when writing an archive, or cannot preserve the user ID,
1117 group ID, or file mode when the
1119 option is specified, a diagnostic message is written to
1121 and a non-zero exit status will be returned, but processing will continue.
1122 In the case where pax cannot create a link to a file,
1124 will not create a second copy of the file.
1126 If the extraction of a file from an archive is prematurely terminated by
1129 may have only partially extracted a file the user wanted.
1130 Additionally, the file modes of extracted files and directories
1131 may have incorrect file bits, and the modification and access times may be
1134 If the creation of an archive is prematurely terminated by a signal or error,
1136 may have only partially created the archive which may violate the specific
1137 archive format specification.
1142 detects a file is about to overwrite itself, the file is not copied,
1143 a diagnostic message is written to
1147 completes it will exit with a non-zero exit status.
1154 utility is a superset of the
1175 and the flawed archive handling during
1179 operations are extensions to the
1189 at the University of California, San Diego
1193 utility does not recognize multibyte characters.
projects / FreeBSD / FreeBSD.git / blob