xref: /plan9/sys/src/ape/cmd/pax/README (revision 9a747e4fd48b9f4522c70c07e8f882a15030f964)
1*9a747e4fSDavid du ColombierPAX - Portable Archive Interchange
2*9a747e4fSDavid du Colombier
3*9a747e4fSDavid du ColombierCopyright (C) 1989 Mark H. Colburn
4*9a747e4fSDavid du ColombierAll Rights Reserved.
5*9a747e4fSDavid du Colombier
6*9a747e4fSDavid du Colombier
7*9a747e4fSDavid du ColombierIntroduction
8*9a747e4fSDavid du Colombier
9*9a747e4fSDavid du Colombier    This is version 1.2 of Pax, an archiving utility.
10*9a747e4fSDavid du Colombier
11*9a747e4fSDavid du Colombier    Pax is an archiving utility that reads and writes tar and cpio formats,
12*9a747e4fSDavid du Colombier    both the traditional ones and the extended formats specified in IEEE
13*9a747e4fSDavid du Colombier    1003.1.  It handles multi-volume archives and automatically determines
14*9a747e4fSDavid du Colombier    the format of an archive while reading it.  Three user interfaces are
15*9a747e4fSDavid du Colombier    supported: tar, cpio, and pax.  The pax interface was designed by IEEE
16*9a747e4fSDavid du Colombier    1003.2 as a compromise in the chronic controversy over which of tar or
17*9a747e4fSDavid du Colombier    cpio is best.
18*9a747e4fSDavid du Colombier
19*9a747e4fSDavid du Colombier    The USENIX Association provided some support for the initial
20*9a747e4fSDavid du Colombier    implementation of this product.  As a result, the Pax utility is being
21*9a747e4fSDavid du Colombier    distributed free of charge and may be redistributed by others in either
22*9a747e4fSDavid du Colombier    source or binary form.  (See the liscensing section for restrictions)
23*9a747e4fSDavid du Colombier
24*9a747e4fSDavid du Colombier    The source for Pax has been posted to comp.sources.unix on USENET and
25*9a747e4fSDavid du Colombier    will also be available by anonymous FTP on the Internet from uunet.uu.net,
26*9a747e4fSDavid du Colombier    moon.src.honeywell.com and from ucb-arpa.berkeley.edu.  The source
27*9a747e4fSDavid du Colombier    to Pax is also available via anonymous UUCP from jhereg.mn.org, the
28*9a747e4fSDavid du Colombier    author's home machine and possibly other sites.
29*9a747e4fSDavid du Colombier
30*9a747e4fSDavid du Colombier    The source for Pax will continue to change as long as the definition of
31*9a747e4fSDavid du Colombier    the utility is modified by the 1003.2 working group.  (For example,
32*9a747e4fSDavid du Colombier    there are a number of changes in Draft 8 which will be incorporated as
33*9a747e4fSDavid du Colombier    soon as Draft 8 is available).  Additional modifications will be made
34*9a747e4fSDavid du Colombier    based on user input, such as request for support of additional archive
35*9a747e4fSDavid du Colombier    formats, etc.  Patches and new releases will be made as new functionality
36*9a747e4fSDavid du Colombier    is added or problems are diagnosed and fixed.
37*9a747e4fSDavid du Colombier
38*9a747e4fSDavid du Colombier
39*9a747e4fSDavid du ColombierInstallation
40*9a747e4fSDavid du Colombier
41*9a747e4fSDavid du Colombier    In order to install Pax, you must first edit the Makefile and the
42*9a747e4fSDavid du Colombier    config.h file according to the directions in each of the files.
43*9a747e4fSDavid du Colombier    These two files provide the configuration information for most
44*9a747e4fSDavid du Colombier    commonly available machines.  Please be sure to read through all
45*9a747e4fSDavid du Colombier    the directions in each of these files before attempting to compile
46*9a747e4fSDavid du Colombier    Pax.
47*9a747e4fSDavid du Colombier
48*9a747e4fSDavid du Colombier
49*9a747e4fSDavid du ColombierPortability
50*9a747e4fSDavid du Colombier
51*9a747e4fSDavid du Colombier    Pax is intended to run on as many systems as possible.  If you have
52*9a747e4fSDavid du Colombier    problems getting Pax to compile or run on your system, please let me
53*9a747e4fSDavid du Colombier    know so that the source or the installation procedure can be modified.
54*9a747e4fSDavid du Colombier
55*9a747e4fSDavid du Colombier    Pax has been tested and appears to run correctly on the following
56*9a747e4fSDavid du Colombier    machines:
57*9a747e4fSDavid du Colombier
58*9a747e4fSDavid du Colombier        Machine                 Operating System/Release
59*9a747e4fSDavid du Colombier	---------------------------------------------------
60*9a747e4fSDavid du Colombier	Altos 586		System III (2.3)
61*9a747e4fSDavid du Colombier	AT&T UNIX PC		System V.2 (Release 3.51)
62*9a747e4fSDavid du Colombier        Convergent S/320	CTIX/68k 6.1, UNIX SysV 3.1
63*9a747e4fSDavid du Colombier	Cray 2			UNICOS
64*9a747e4fSDavid du Colombier	Encore CC		02.00.r088
65*9a747e4fSDavid du Colombier	HP 9000			HP/UX 6.0.1
66*9a747e4fSDavid du Colombier        IBM PC/AT		Microport SV/AT V2.4
67*9a747e4fSDavid du Colombier	Mac II 			A/UX 1.0
68*9a747e4fSDavid du Colombier	NCR Tower		System V.2
69*9a747e4fSDavid du Colombier	Pyramid			AT&T and Berkeley universe
70*9a747e4fSDavid du Colombier	Sequent Symetry		Dynix 3.0
71*9a747e4fSDavid du Colombier	SGI Iris 4D/60G		UNIX 3.0
72*9a747e4fSDavid du Colombier	SGI Iris 4D/70G		UNIX 3.0
73*9a747e4fSDavid du Colombier	SCO Xenix 386 		2.3.2
74*9a747e4fSDavid du Colombier	SCO Unix 386 		3.2
75*9a747e4fSDavid du Colombier	Sun 2			SunOS 3.4
76*9a747e4fSDavid du Colombier	Sun 2			SunOS 3.5
77*9a747e4fSDavid du Colombier	Sun 3			SunOS 3.4
78*9a747e4fSDavid du Colombier	Sun 3			SunOS 3.5
79*9a747e4fSDavid du Colombier	Sun 3			SunOS 4.0
80*9a747e4fSDavid du Colombier	Sun 4			SunOS 4.0
81*9a747e4fSDavid du Colombier	VAX 8750		BSD 4.3 (Mt. Xinu)
82*9a747e4fSDavid du Colombier	VAX 8650		BSD 4.3 (Mt. Xinu)
83*9a747e4fSDavid du Colombier	VAX 780			BSD 4.3 (Berkeley)
84*9a747e4fSDavid du Colombier	---------------------------------------------------
85*9a747e4fSDavid du Colombier
86*9a747e4fSDavid du Colombier    In future releases, the source will be moving toward ANSI C and POSIX
87*9a747e4fSDavid du Colombier    compatibility.  This should allow for portability over any system
88*9a747e4fSDavid du Colombier    supporting both ANSI and POSIX.  In addition, POSIX/ANSI portability
89*9a747e4fSDavid du Colombier    library routines will be developed which will allow the code to run on
90*9a747e4fSDavid du Colombier    the standard machines available now.
91*9a747e4fSDavid du Colombier
92*9a747e4fSDavid du Colombier
93*9a747e4fSDavid du ColombierCredit Where Credit is Due
94*9a747e4fSDavid du Colombier
95*9a747e4fSDavid du Colombier    Parts of the code which makes up Pax were gleaned from a number of
96*9a747e4fSDavid du Colombier    different sources: the directory access routines in paxdir.h are
97*9a747e4fSDavid du Colombier    modified copies of Doug Gwyn's dirent library; the regular expression
98*9a747e4fSDavid du Colombier    matching routines in regexp.c are from Henry Spencer, some of the tar
99*9a747e4fSDavid du Colombier    archive routines were initially written by John Gilmore for his PDTAR;
100*9a747e4fSDavid du Colombier    and finally afio, written by Mark Brukhartz at Lachman Associates, was
101*9a747e4fSDavid du Colombier    the basis for the buffering schemes used in pax.
102*9a747e4fSDavid du Colombier
103*9a747e4fSDavid du Colombier
104*9a747e4fSDavid du ColombierLicensing
105*9a747e4fSDavid du Colombier
106*9a747e4fSDavid du Colombier    Copyright (c) 1989 Mark H. Colburn.
107*9a747e4fSDavid du Colombier    All rights reserved.
108*9a747e4fSDavid du Colombier
109*9a747e4fSDavid du Colombier    Redistribution and use in source and binary forms are permitted
110*9a747e4fSDavid du Colombier    provided that the above copyright notice is duplicated in all such
111*9a747e4fSDavid du Colombier    forms and that any documentation, advertising materials, and other
112*9a747e4fSDavid du Colombier    materials related to such distribution and use acknowledge that the
113*9a747e4fSDavid du Colombier    software was developed by Mark H. Colburn and sponsored by The
114*9a747e4fSDavid du Colombier    USENIX Association.
115*9a747e4fSDavid du Colombier
116*9a747e4fSDavid du Colombier    THE SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
117*9a747e4fSDavid du Colombier    IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
118*9a747e4fSDavid du Colombier    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
119*9a747e4fSDavid du Colombier
120*9a747e4fSDavid du ColombierPlease report any bug or problems to:
121*9a747e4fSDavid du Colombier
122*9a747e4fSDavid du ColombierMark Colburn
123*9a747e4fSDavid du ColombierMinnetech Consulting, Inc.
124*9a747e4fSDavid du Colombier117 Mackubin St., Suite 1
125*9a747e4fSDavid du ColombierSt. Paul MN   55102
126*9a747e4fSDavid du Colombiermark@jhereg.MN.ORG
127