Annotation of coherent/d/usr/bin/pax/shipping/pax.man, revision 1.1.1.1

1.1       root        1:      PAX         COHERENT (USENIX Association)         PAX
                      2:      NAME
                      3:           pax - portable archive exchange
                      4:      SYNOPSIS
                      5:           pax [-cimopuvy] [-f archive] [-s replstr] [-t device]
                      6:               [pattern...]
                      7:           pax -r [-cimnopuvy] [-f archive] [-s replstr] [-t device]
                      8:                  [pattern...]
                      9:           pax -w [-adimuvy] [-b blocking] [-f archive] [-s replstr]
                     10:                  [-t device] [-x format] [pathname...]
                     11:           pax -rw [-ilmopuvy] [-s replstr] [pathname...] directory
                     12:      DESCRIPTION
                     13:           Pax reads and writes archive files which conform to the
                     14:           Archive/Interchange File Format specified in IEEE Std.
                     15:           1003.1-1988.  Pax can also read, but not write, a number of
                     16:           other file formats in addition to those specified in the
                     17:           Archive/Interchange File Format description.  Support for
                     18:           these traditional file formats, such as V7 tar and System V
                     19:           binary cpio format archives, is provided for backward
                     20:           compatibility and to maximize portability.
                     21:           Pax will also support traditional cpio and System V tar
                     22:           interfaces if invoked with the name "cpio" or "ustar"
                     23:           respectively.  See the cpio or ustar manual pages for
                     24:           more details.
                     25:           Combinations of the -r and -w command line arguments specify
                     26:           whether pax will read, write or list the contents of the
                     27:           specified archive, or move the specified files to another
                     28:           directory.
                     29:           The command line arguments are:
                     30:           -w   writes the files and directories specified by pathname
                     31:                operands to the standard output together with the
                     32:                pathname and status information prescribed by the
                     33:                archive format used.  A directory pathname operand
                     34:                refers to the files and (recursively) subdirectories of
                     35:                that directory.  If no pathname operands are given,
                     36:                then the standard input is read to get a list of
                     37:                pathnames to copy, one pathname per line.  In this
                     38:                case, only those pathnames appearing on the standard
                     39:                input are copied.
                     40:           -r   Pax reads an archive file from the standard input.
                     41:                Only files with names that match any of the pattern
                     42:                operands are selected for extraction.  The selected
                     43:                files are conditionally created and copied relative to
                     44:      Page 1                                          (printed 5/24/90)
                     45:      PAX         COHERENT (USENIX Association)         PAX
                     46:                the current directory tree, subject to the options
                     47:                described below.  By default, the owner and group of
                     48:                selected files will be that of the invoking process,
                     49:                and the permissions and modification times will be the
                     50:                sames as those in the archive.
                     51:                The supported archive formats are automatically
                     52:                detected on input.  The default output format is ustar,
                     53:                but may be overridden by the -x format option described
                     54:                below.
                     55:           -rw  Pax reads the files and directories named in the
                     56:                pathname operands and copies them to the destination
                     57:                directory.  A directory pathname operand refers to the
                     58:                files and (recursively) subdirectories of that
                     59:                directory.  If no pathname operands are given, the
                     60:                standard input is read to get a list of pathnames to
                     61:                copy, one pathname per line.  In this case, only those
                     62:                pathnames appearing on the standard input are copied.
                     63:                The directory named by the directory operand must exist
                     64:                and have the proper permissions before the copy can
                     65:                occur.
                     66:           If neither the -r or -w options are given, then pax will
                     67:           list the contents of the specified archive.  In this mode,
                     68:           pax lists normal files one per line, hard link pathnames as
                     69:                     pathname == linkname
                     70:           and symbolic link pathnames (if supported by the
                     71:           implementation) as
                     72:                     pathname -> linkname
                     73:           where pathname is the name of the file being extracted, and
                     74:           linkname is the name of a file which appeared earlier in the
                     75:           archive.
                     76:           If the -v option is specified, then pax list normal
                     77:           pathnames in the same format used by the ls utility with the
                     78:           -l option.  Hard links are shown as
                     79:                     <ls -l listing> == linkname
                     80:           and symbolic links (if supported) are shown as
                     81:                     <ls -l listing> -> linkname
                     82:           Pax is capable of reading and writing archives which span
                     83:           multiple physical volumes.  Upon detecting an end of medium
                     84:           on an archive which is not yet completed, pax will prompt
                     85:      Page 2                                          (printed 5/24/90)
                     86:      PAX         COHERENT (USENIX Association)         PAX
                     87:           the user for the next volume of the archive and will allow
                     88:           the user to specify the location of the next volume.
                     89:         Options
                     90:           The following options are available:
                     91:           -a        The files specified by pathname are appended to
                     92:                     the specified archive.
                     93:           -b blocking
                     94:                     Block the output at blocking bytes per write to
                     95:                     the archive file.  A k suffix multiplies blocking
                     96:                     by 1024, a b suffix multiplies blocking by 512 and
                     97:                     a m suffix multiplies blocking by 1048576 (1
                     98:                     megabyte).  If not specified, blocking is
                     99:                     automatically determined on input and is ignored
                    100:                     for -rw.
                    101:           -c        Complement the match sense of the the pattern
                    102:                     operands.
                    103:           -d        Intermediate directories not explicitly listed in
                    104:                     the archive are not created.  This option is
                    105:                     ignored unless the -r option is specified.
                    106:           -f archive
                    107:                     The archive option specifies the pathname of the
                    108:                     input or output archive, overriding the default of
                    109:                     standard input for -r or standard output for -w.
                    110:           -i        Interactively rename files.  Substitutions
                    111:                     specified by -s options (described below) are
                    112:                     performed before requesting the new file name from
                    113:                     the user.  A file is skipped if an empty line is
                    114:                     entered and pax exits with an exit status of 0 if
                    115:                     EOF is encountered.
                    116:           -l        Files are linked rather than copied when possible.
                    117:           -m        File modification times are not retained.
                    118:           -n        When -r is specified, but -w is not, the pattern
                    119:                     arguments are treated as ordinary file names.
                    120:                     Only the first occurrence of each of these files
                    121:                     in the input archive is read.  The pax utility
                    122:                     exits with a zero exit status after all files in
                    123:                     the list have been read.  If one or more files in
                    124:                     the list is not found, pax writes a diagnostic to
                    125:                     standard error for each of the files and exits
                    126:                     with a non-zero exit status.  the file names are
                    127:                     compared before any of the -i, -s, or -y options
                    128:                     are applied.
                    129:      Page 3                                          (printed 5/24/90)
                    130:      PAX         COHERENT (USENIX Association)         PAX
                    131:           -o        Restore file ownership as specified in the
                    132:                     archive.  The invoking process must have
                    133:                     appropriate privileges to accomplish this.
                    134:           -p        Preserve the access time of the input files after
                    135:                     they have been copied.
                    136:           -s replstr
                    137:                     File names are modified according to the
                    138:                     substitution expression using the syntax of ed
                    139:                     as shown:
                    140:                               -s /old/new/[gp]
                    141:                     Any non null character may be used as a delimiter
                    142:                     (a / is used here as an example).  Multiple -s
                    143:                     expressions may be specified; the expressions are
                    144:                     applied in the order specified terminating with
                    145:                     the first successful substitution.  The optional
                    146:                     trailing p causes successful mappings to be listed
                    147:                     on standard error.  The optional trailing g causes
                    148:                     the old expression to be replaced each time it
                    149:                     occurs in the source string.  Files that
                    150:                     substitute to an empty string are ignored both on
                    151:                     input and output.
                    152:           -t device The device option argument is an implementation-
                    153:                     defined identifier that names the input or output
                    154:                     archive device, overriding the default of standard
                    155:                     input for -r and standard output for -w.
                    156:           -u        Copy each file only if it is newer than a pre-
                    157:                     existing file with the same name.  This implies
                    158:                     -a.
                    159:           -v        List file names as they are encountered.  Produces
                    160:                     a verbose table of contents listing on the
                    161:                     standard output when both -r and -w are omitted,
                    162:                     otherwise the file names are printed to standard
                    163:                     error as they are encountered in the archive.
                    164:           -x format Specifies the output archive format.  The input
                    165:                     format, which must be one of the following, is
                    166:                     automatically determined when the -r option is
                    167:                     used.  The supported formats are:
                    168:           cpio      The extended CPIO interchange format specified in
                    169:                     Extended CPIO Format in IEEE Std. 1003.1-1988.
                    170:           ustar     The extended TAR interchange format specified in
                    171:                     Extended TAR Format in IEEE Std. 1003.1-1988. This
                    172:                     is the default archive format.
                    173:      Page 4                                          (printed 5/24/90)
                    174:      PAX         COHERENT (USENIX Association)         PAX
                    175:           -y        Interactively prompt for the disposition of each
                    176:                     file.  Substitutions specified by -s options
                    177:                     (described above) are performed before prompting
                    178:                     the user for disposition.  EOF or an input line
                    179:                     starting with the character q caused pax to exit.
                    180:                     Otherwise, an input line starting with anything
                    181:                     other than y causes the file to be ignored.  This
                    182:                     option cannot be used in conjunction with the -i
                    183:                     option.
                    184:           Only the last of multiple -f or -t options take effect.
                    185:           When writing to an archive, the standard input is used as a
                    186:           list of pathnames if no pathname operands are specified.
                    187:           The format is one pathname per line.  Otherwise, the
                    188:           standard input is the archive file, which is formatted
                    189:           according to one of the specifications in
                    190:           Archive/Interchange File format in IEEE Std. 1003.1-1988, or
                    191:           some other implementation-defined format.
                    192:           The user ID and group ID of the process, together with the
                    193:           appropriate privileges, affect the ability of pax to restore
                    194:           ownership and permissions attributes of the archived files.
                    195:           (See format-reading utility in Archive/Interchange File
                    196:           Format in IEEE Std. 1003.1-1988.)
                    197:           The options -a, -c, -d, -i, -l, -p, -t, -u, and -y are
                    198:           provided for functional compatibility with the historical
                    199:           cpio and tar utilities.  The option defaults were chosen
                    200:           based on the most common usage of these options, therefore,
                    201:           some of the options have meanings different than those of
                    202:           the historical commands.
                    203:         Operands
                    204:           The following operands are available:
                    205:           directory The destination directory pathname for copies when
                    206:                     both the -r and -w options are specified.  The
                    207:                     directory must exist and be writable before the
                    208:                     copy or and error results.
                    209:           pathname  A file whose contents are used instead of the
                    210:                     files named on the standard input.  When a
                    211:                     directory is named, all of its files and
                    212:                     (recursively) subdirectories are copied as well.
                    213:           pattern   A pattern is given in the standard shell pattern
                    214:                     matching notation.  The default if no pattern is
                    215:                     specified is *, which selects all files.
                    216:      EXAMPLES
                    217:           The following command
                    218:      Page 5                                          (printed 5/24/90)
                    219:      PAX         COHERENT (USENIX Association)         PAX
                    220:                     pax -w -f /dev/rmt0 .
                    221:           copies the contents of the current directory to tape drive
                    222:           0.
                    223:           The commands
                    224:                     mkdir newdir
                    225:                     cd olddir
                    226:                     pax -rw . newdir
                    227:           copies the contents of olddir to newdir .
                    228:           The command
                    229:                     pax -r -s ',//*usr//*,,' -f pax.out
                    230:           reads the archive pax.out with all files rooted in "/usr" in
                    231:           the archive extracted relative to the current directory.
                    232:      FILES
                    233:           /dev/tty  used to prompt the user for information when the
                    234:                     -i or -y options are specified.
                    235:      SEE ALSO
                    236:           cpio, find, ustar
                    237:      DIAGNOSTICS
                    238:           Pax will terminate immediately, without processing any
                    239:           additional files on the command line or in the archive.
                    240:      EXIT CODES
                    241:           Pax will exit with one of the following values:
                    242:           0    All files in the archive were processed successfully.
                    243:           >0   Pax aborted due to errors encountered during operation.
                    244:      BUGS
                    245:           Special permissions may be required to copy or extract
                    246:           special files.
                    247:           Device, user ID, and group ID numbers larger than 65535
                    248:           cause additional header records to be output.  These records
                    249:           are ignored by some historical version of cpio and
                    250:           tar.
                    251:           The archive formats described in Archive/Interchange File
                    252:           Format have certain restrictions that have been carried over
                    253:           from historical usage.  For example, there are restrictions
                    254:           on the length of pathnames stored in the archive.
                    255:      Page 6                                          (printed 5/24/90)
                    256:      PAX         COHERENT (USENIX Association)         PAX
                    257:           When getting an "ls -l" style listing on tar format
                    258:           archives, link counts are listed as zero since the ustar
                    259:           archive format does not keep link count information.
                    260: 
                    261:      COPYRIGHT
                    262:           Copyright (c) 1989 Mark H. Colburn.
                    263:          COHERENT pax/ustar/cpio are based on original code for pax
                    264:          which is sponsored by The USENIX Association.
                    265: 
                    266:      Page 7                                          (printed 5/24/90)

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.