1 .\" Copyright (c) 1992 Keith Muller.
2 .\" Copyright (c) 1992, 1993
3 .\" The Regents of the University of California. All rights reserved.
5 .\" This code is derived from software contributed to Berkeley by
6 .\" Keith Muller of the University of California, San Diego.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\" must display the following acknowledgement:
18 .\" This product includes software developed by the University of
19 .\" California, Berkeley and its contributors.
20 .\" 4. Neither the name of the University nor the names of its contributors
21 .\" may be used to endorse or promote products derived from this software
22 .\" without specific prior written permission.
24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .\" @(#)pax.1 8.4 (Berkeley) 4/18/94
37 .\" $FreeBSD: src/bin/pax/pax.1,v 1.12.2.10 2003/02/23 17:46:34 keramida Exp $
44 .Nd read and write file archives and copy directory hierarchies
112 .Op Fl b Ar blocksize
153 .Op Fl diklntuvDHLPXYZ
184 utility will read, write, and list the members of an archive file,
185 and will copy directory hierarchies.
186 These operations are independent of the specific archive format,
187 and support a wide variety of different archive formats.
188 A list of supported archive formats can be found under the description of the
196 options specifies which of the following functional modes
199 .Em list , read , write ,
207 a table of contents of the members of the archive file read from
209 whose pathnames match the specified
211 The table of contents contains one filename per line
212 and is written using single line buffering.
215 Extract the members of the archive file read from the
217 with pathnames matching the specified
219 The archive format and blocking is automatically determined on input.
220 When an extracted file is a directory, the entire file hierarchy
221 rooted at that directory is extracted.
222 All extracted files are created relative to the current file hierarchy.
223 The setting of ownership, access and modification times, and file mode of
224 the extracted files are discussed in more detail under the
229 Write an archive containing the
233 using the specified archive format.
236 operands are specified, a list of files to copy with one per line is read from
240 operand is also a directory, the entire file hierarchy rooted
241 at that directory will be included.
246 operands to the destination
250 operands are specified, a list of files to copy with one per line is read from
255 operand is also a directory the entire file
256 hierarchy rooted at that directory will be included.
259 is as if the copied files were written to an archive file and then
260 subsequently extracted, except that there may be hard links between
261 the original and the copied files (see the
268 must not be one of the
270 operands or a member of a file hierarchy rooted at one of the
275 under these conditions is unpredictable.
278 While processing a damaged archive during a
284 will attempt to recover from media defects and will search through the archive
285 to locate and process the largest number of archive members possible (see the
287 option for more details on error handling).
291 operand specifies a destination directory pathname.
294 operand does not exist, or it is not writable by the user,
295 or it is not of type directory,
297 will exit with a non-zero exit status.
301 operand is used to select one or more pathnames of archive members.
302 Archive members are selected using the pattern matching notation described
307 operand is not supplied, all members of the archive will be selected.
310 matches a directory, the entire file hierarchy rooted at that directory will
314 operand does not select at least one archive member,
318 operands in a diagnostic message to
320 and then exit with a non-zero exit status.
324 operand specifies the pathname of a file to be copied or archived.
327 operand does not select at least one archive member,
331 operand pathnames in a diagnostic message to
333 and then exit with a non-zero exit status.
335 The following options are supported:
338 Read an archive file from
340 and extract the specified
342 If any intermediate directories are needed in order to extract an archive
343 member, these directories will be created as if
345 was called with the bitwise inclusive
348 .Dv S_IRWXU , S_IRWXG ,
351 as the mode argument.
352 When the selected archive format supports the specification of linked
353 files and these files cannot be linked while the archive is being extracted,
355 will write a diagnostic message to
357 and exit with a non-zero exit status at the completion of operation.
361 in the specified archive format.
364 operands are specified,
366 is read for a list of pathnames with one per line without any leading or
372 to the end of an archive that was previously written.
373 If an archive format is not specified with a
375 option, the format currently being used in the archive will be selected.
376 Any attempt to append to an archive in a format different from the
377 format already used in the archive will cause
380 with a non-zero exit status.
381 The blocking size used in the archive volume where writing starts
382 will continue to be used for the remainder of that archive volume.
385 Many storage devices are not able to support the operations necessary
386 to perform an append operation.
387 Any attempt to append to an archive stored on such a device may damage the
388 archive or have other unpredictable results.
389 Tape drives in particular are more likely to not support an append operation.
390 An archive stored in a regular file system file or on a disk device will
391 usually support an append operation.
392 .It Fl b Ar blocksize
396 block the output at a positive decimal integer number of
397 bytes per write to the archive file.
400 must be a multiple of 512 bytes with a maximum of 64512 bytes.
401 Archives larger than 32256 bytes violate the
403 standard and will not be portable to all systems.
410 to specify multiplication by 1024 (1K) or 512, respectively.
415 to indicate a product.
416 A specific archive device may impose additional restrictions on the size
417 of blocking it will support.
418 When blocking is not specified, the default
420 is dependent on the specific archive format being used (see the
424 Match all file or archive members
426 those specified by the
432 Cause files of type directory being copied or archived, or archive members of
433 type directory being extracted, to match only the directory file or archive
434 member and not the file hierarchy rooted at the directory.
438 as the pathname of the input or output archive, overriding the default
448 A single archive may span multiple files and different archive devices.
451 will prompt for the pathname of the file or device of the next volume in the
454 Interactively rename files or archive members.
455 For each archive member matching a
457 operand or each file matching a
463 giving the name of the file, its file mode and its modification time.
466 utility will then read a line from
468 If this line is blank, the file or archive member is skipped.
469 If this line consists of a single period, the
470 file or archive member is processed with no modification to its name.
471 Otherwise, its name is replaced with the contents of the line.
474 utility will immediately exit with a non-zero exit status if
476 is encountered when reading a response or if
478 cannot be opened for reading and writing.
480 Do not overwrite existing files.
488 hard links are made between the source and destination file hierarchies
491 Select the first archive member that matches each
494 No more than one archive member is matched for each
496 When members of type directory are matched, the file hierarchy rooted at that
497 directory is also matched (unless
501 Information to modify the algorithm for extracting or writing archive files
502 which is specific to the archive format specified by
509 Specify one or more file characteristic options (privileges).
512 option-argument is a string specifying file characteristics to be retained or
513 discarded on extraction.
514 The string consists of the specification characters
518 Multiple characteristics can be concatenated within the same string
521 options can be specified.
522 The meaning of the specification characters are as follows:
525 Do not preserve file access times.
526 By default, file access times are preserved whenever possible.
528 .Sq Preserve everything ,
529 the user ID, group ID, file mode bits,
530 file access time, and file modification time.
531 This is intended to be used by
533 someone with all the appropriate privileges, in order to preserve all
534 aspects of the files as they are recorded in the archive.
537 flag is the sum of the
543 Do not preserve file modification times.
544 By default, file modification times are preserved whenever possible.
546 Preserve the user ID and group ID.
550 This intended to be used by a
552 with regular privileges who wants to preserve all aspects of the file other
554 The file times are preserved by default, but two other flags are offered to
555 disable this and use the time of extraction instead.
558 In the preceding list,
560 indicates that an attribute stored in the archive is given to the
561 extracted file, subject to the permissions of the invoking
563 Otherwise the attribute of the extracted file is determined as
564 part of the normal file creation action.
569 specification character is specified, or the user ID and group ID are not
570 preserved for any reason,
578 bits of the file mode.
579 If the preservation of any of these items fails for any reason,
581 will write a diagnostic message to
583 Failure to preserve these items will affect the final exit status,
584 but will not cause the extracted file to be deleted.
585 If the file characteristic letters in any of the string option-arguments are
586 duplicated or conflict with each other, the one(s) given last will take
590 is specified, file modification times are still preserved.
592 Modify the file or archive member names specified by the
596 operands according to the substitution expression
598 using the syntax of the
600 utility regular expressions.
601 The format of these regular expressions are:
606 is a basic regular expression and
608 can contain an ampersand (&), \\n (where n is a digit) back-references,
609 or subexpression matching.
612 string may also contain
615 Any non-null character can be used as a delimiter (/ is shown here).
618 expressions can be specified.
619 The expressions are applied in the order they are specified on the
620 command line, terminating with the first successful substitution.
621 The optional trailing
623 continues to apply the substitution expression to the pathname substring
624 which starts with the first character following the end of the last successful
626 The first unsuccessful substitution stops the operation of the
629 The optional trailing
631 will cause the final result of a successful substitution to be written to
633 in the following format:
634 .Dl <original pathname> >> <new pathname>
635 File or archive member names that substitute to the empty string
636 are not selected and will be skipped.
638 Reset the access times of any file or directory read or accessed by
640 to be the same as they were before being read or accessed by
643 Ignore files that are older (having a less recent file modification time)
644 than a pre-existing file or archive member with the same name.
647 an archive member with the same name as a file in the file system will be
648 extracted if the archive member is newer than the file.
651 a file system member with the same name as an archive member will be
652 written to the archive if it is newer than the archive member.
655 the file in the destination hierarchy is replaced by the file in the source
656 hierarchy or by a link to the file in the source hierarchy if the file in
657 the source hierarchy is newer.
661 operation, produce a verbose table of contents using the format of the
666 For pathnames representing a hard link to a previous member of the archive,
667 the output has the format:
668 .Dl <ls -l listing> == <link name>
669 For pathnames representing a symbolic link, the output has the format:
670 .Dl <ls -l listing> => <link name>
671 Where <ls -l listing> is the output format specified by the
673 utility when used with the
676 Otherwise for all the other operational modes
680 pathnames are written and flushed to
684 as soon as processing begins on that file or
688 is not buffered, and is written only after the file has been read or written.
690 Specify the output archive format, with the default format being
694 utility currently supports the following formats:
695 .Bl -tag -width "sv4cpio"
697 The extended cpio interchange format specified in the
700 The default blocksize for this format is 5120 bytes.
701 Inode and device information about a file (used for detecting file hard links
702 by this format) which may be truncated by this format is detected by
706 The old binary cpio format.
707 The default blocksize for this format is 5120 bytes.
708 This format is not very portable and should not be used when other formats
710 Inode and device information about a file (used for detecting file hard links
711 by this format) which may be truncated by this format is detected by
715 The System V release 4 cpio.
716 The default blocksize for this format is 5120 bytes.
717 Inode and device information about a file (used for detecting file hard links
718 by this format) which may be truncated by this format is detected by
722 The System V release 4 cpio with file crc checksums.
723 The default blocksize for this format is 5120 bytes.
724 Inode and device information about a file (used for detecting file hard links
725 by this format) which may be truncated by this format is detected by
731 tar format as found in
733 The default blocksize for this format is 10240 bytes.
734 Pathnames stored by this format must be 100 characters or less in length.
738 .Em hard links , soft links ,
741 will be archived (other file system types are not supported).
742 For backwards compatibility with even older tar formats, a
744 option can be used when writing an archive to omit the storage of directories.
745 This option takes the form:
746 .Dl Fl o Cm write_opt=nodir
748 The extended tar interchange format specified in the
751 The default blocksize for this format is 10240 bytes.
752 Pathnames stored by this format must be 250 characters or less in length.
757 utility will detect and report any file that it is unable to store or extract
758 as the result of any specific archive format restrictions.
759 The individual archive formats may impose additional restrictions on use.
760 Typical archive format restrictions include (but are not limited to):
761 file pathname length, file size, link pathname length and the type of the file.
765 to compress (decompress) the archive while writing (reading).
769 Limit the number of bytes written to a single archive volume to
778 to specify multiplication by 1048576 (1M), 1024 (1K) or 512, respectively.
781 limits can be separated by
783 to indicate a product.
786 Only use this option when writing an archive to a device which supports
787 an end of file read condition based on last (or largest) write offset
788 (such as a regular file or a tape drive).
789 The use of this option with a floppy or hard disk is not recommended.
791 This option is the same as the
793 option, except that the file inode change time is checked instead of the
794 file modification time.
795 The file inode change time can be used to select files whose inode information
796 (e.g. uid, gid, etc.) is newer than a copy of the file in the destination
799 Limit the number of consecutive read faults while trying to read a flawed
805 will attempt to recover from an archive read error and will
806 continue processing starting with the next file stored in the archive.
811 to stop operation after the first read error is detected on an archive volume.
818 to attempt to recover from read errors forever.
821 is a small positive number of retries.
824 Using this option with
826 should be used with extreme caution as
828 may get stuck in an infinite loop on a very badly flawed archive.
830 Select a file based on its
832 name, or when starting with a
835 A '\\' can be used to escape the
839 options may be supplied and checking stops with the first match.
841 Follow only command line symbolic links while performing a physical file
844 Follow all symbolic links to perform a logical file system traversal.
846 Do not follow symbolic links, perform a physical file system traversal.
847 This is the default mode.
848 .It Fl T Ar [from_date][,to_date][/[c][m]]
849 Allow files to be selected based on a file modification or inode change
850 time falling within a specified time range of
854 (the dates are inclusive).
857 is supplied, all files with a modification or inode change time
858 equal to or younger are selected.
861 is supplied, all files with a modification or inode change time
862 equal to or older will be selected.
867 only files with a modification or inode change time of exactly that
868 time will be selected.
876 mode, the optional trailing field
878 can be used to determine which file time (inode change, file modification or
879 both) are used in the comparison.
880 If neither is specified, the default is to use file modification time only.
883 specifies the comparison of file modification time (the time when
884 the file was last written).
887 specifies the comparison of inode change time (the time when the file
888 inode was last changed; e.g. a change of owner, group, mode, etc).
893 are both specified, then the modification and inode change times are
895 The inode change time comparison is useful in selecting files whose
896 attributes were recently changed or selecting files which were recently
897 created and had their modification time reset to an older time (as what
898 happens when a file is extracted from an archive and the modification time
900 Time comparisons using both file times is useful when
902 is used to create a time based incremental archive (only files that were
903 changed during a specified time range will be archived).
905 A time range is made up of six different fields and each field must contain two
908 .Dl [yy[mm[dd[hh]]]]mm[.ss]
911 is the last two digits of the year,
914 is the month (from 01 to 12),
916 is the day of the month (from 01 to 31),
918 is the hour of the day (from 00 to 23),
921 is the minute (from 00 to 59),
924 is the seconds (from 00 to 59).
927 is required, while the other fields are optional and must be added in the
929 .Dl Cm hh , dd , mm , yy .
932 field may be added independently of the other fields.
933 Time ranges are relative to the current time, so
935 would select all files with a modification or inode change time
936 of 12:34 PM today or later.
939 time range can be supplied and checking stops with the first match.
941 Select a file based on its
943 name, or when starting with a
946 A '\\' can be used to escape the
950 options may be supplied and checking stops with the first match.
952 When traversing the file hierarchy specified by a pathname,
953 do not descend into directories that have a different device ID.
956 field as described in
958 for more information about device ID's.
960 This option is the same as the
962 option, except that the inode change time is checked using the
963 pathname created after all the file name modifications have completed.
965 This option is the same as the
967 option, except that the modification time is checked using the
968 pathname created after all the file name modifications have completed.
971 The options that operate on the names of files or archive members
987 When extracting files during a
989 operation, archive members are
991 based only on the user specified pattern operands as modified by the
1004 options will modify in that order, the names of these selected files.
1009 options will be applied based on the final pathname.
1012 option will write the names resulting from these modifications.
1014 When archiving files during a
1016 operation, or copying files during a
1018 operation, archive members are
1020 based only on the user specified pathnames as modified by the
1030 option only applies during a copy operation).
1035 options will modify in that order, the names of these selected files.
1042 options will be applied based on the final pathname.
1045 option will write the names resulting from these modifications.
1047 When one or both of the
1051 options are specified along with the
1053 option, a file is not considered selected unless it is newer
1054 than the file to which it is compared.
1057 .Dl "pax -w -f /dev/rst0 ."
1058 copies the contents of the current directory to the device
1062 .Dl pax -v -f filename
1063 gives the verbose table of contents for an archive stored in
1066 The following commands:
1069 .Dl pax -rw .\ /tmp/to
1070 will copy the entire
1072 directory hierarchy to
1076 .Dl pax -r -s ',^//*usr//*,,' -f a.pax
1079 with all files rooted in ``/usr'' into the archive extracted relative to the
1083 .Dl pax -rw -i .\ dest_dir
1084 can be used to interactively select the files to copy from the current
1089 .Dl pax -r -pe -U root -G bin -f a.pax
1090 will extract all files from the archive
1096 and will preserve all file permissions.
1099 .Dl pax -r -w -v -Y -Z home /backup
1100 will update (and list) only those files in the destination directory
1102 which are older (less recent inode change or file modification times) than
1103 files with the same name found in the source file tree
1108 utility is a superset of the
1129 and the flawed archive handling during
1133 operations are extensions to the
1146 at the University of California, San Diego
1150 utility will exit with one of the following values:
1153 All files were processed successfully.
1160 cannot create a file or a link when reading an archive or cannot
1161 find a file when writing an archive, or cannot preserve the user ID,
1162 group ID, or file mode when the
1164 option is specified, a diagnostic message is written to
1166 and a non-zero exit status will be returned, but processing will continue.
1167 In the case where pax cannot create a link to a file,
1169 will not create a second copy of the file.
1171 If the extraction of a file from an archive is prematurely terminated by
1174 may have only partially extracted a file the user wanted.
1175 Additionally, the file modes of extracted files and directories
1176 may have incorrect file bits, and the modification and access times may be
1179 If the creation of an archive is prematurely terminated by a signal or error,
1181 may have only partially created the archive which may violate the specific
1182 archive format specification.
1187 detects a file is about to overwrite itself, the file is not copied,
1188 a diagnostic message is written to
1192 completes it will exit with a non-zero exit status.
tuxillo's projects / dragonfly.git / blob