home *** CD-ROM | disk | FTP | other *** search
/ Garbo / Garbo.cdr / pc / unix / pax2exe.zoo / README < prev    next >
Encoding:
Text File  |  1990-02-27  |  9.6 KB  |  236 lines
  1. PAX - Portable Archive Interchange
  2.  
  3. Copyright (C) 1989 Mark H. Colburn
  4. All Rights Reserved.
  5.  
  6.  
  7. Introduction
  8.  
  9.     This is version 2.0 of Pax, an archiving utility.  
  10.     
  11.     Pax is an archiving utility that reads and writes tar and cpio formats, 
  12.     both the traditional ones and the extended formats specified in IEEE 
  13.     1003.1.  It handles multi-volume archives and automatically determines 
  14.     the format of an archive while reading it.  Three user interfaces are 
  15.     supported: tar, cpio, and pax.  The pax interface was designed by IEEE 
  16.     1003.2 as a compromise in the chronic controversy over which of tar or 
  17.     cpio is best.
  18.  
  19.     The Pax utility is being distributed free of charge and may be 
  20.     redistributed by others in either source or binary form.  (See the 
  21.     liscensing section for restrictions)
  22.  
  23.     The source for Pax has been posted to comp.sources.unix on USENET and 
  24.     will also be available by anonymous FTP on the Internet from uunet.uu.net,
  25.     moon.src.honeywell.com and from ucb-arpa.berkeley.edu.  The source
  26.     to Pax is also available via anonymous UUCP from minnetech.mn.org, the 
  27.     author's home machine and possibly other sites.
  28.  
  29.     The source for Pax will continue to change as long as the definition of 
  30.     the utility is modified by the 1003.2 working group.  (For example, 
  31.     there are a number of changes in Draft 8 which will be incorporated as 
  32.     soon as Draft 8 is available).  Additional modifications will be made 
  33.     based on user input, such as request for support of additional archive 
  34.     formats, etc.  Patches and new releases will be made as new functionality 
  35.     is added or problems are diagnosed and fixed.
  36.  
  37.  
  38. Installation
  39.  
  40.     In order to install Pax, you must run the Configure script.
  41.     In addition, if your systems does not have at least a somewhat POSIX
  42.     compliant <limits.h>, then you may have to tweak some of the values in
  43.     limits.h.
  44.  
  45. Portability
  46.  
  47.     Pax is intended to run on as many systems as possible.  If you have
  48.     problems getting Pax to compile or run on your system, please let me 
  49.     know so that the source or the installation procedure can be modified.
  50.  
  51.     Pax has been tested and appears to run correctly on the following 
  52.     machines:
  53.  
  54.         Machine                 Operating System/Release
  55.     ---------------------------------------------------
  56.     Altos 586        System III (2.3)
  57.     AT&T UNIX PC        System V.2 (Release 3.51)
  58.         Convergent S/320    CTIX/68k 6.1, UNIX SysV 3.1
  59.         Convergent S/80        CTIX/68k 6.1, UNIX SysV 3.1
  60.     Cray 2            UNICOS
  61.     Encore CC        02.00.r088
  62.     HP 9000            HP/UX 6.0.1
  63.         IBM PC/AT        Microport SV/AT V2.4
  64.     Mac II             A/UX 1.0
  65.     NCR Tower        System V.2
  66.     Pyramid            AT&T and Berkeley universe
  67.     Sequent Symetry        Dynix 3.0
  68.     SGI Iris 4D/60G        UNIX 3.0
  69.     SGI Iris 4D/70G        UNIX 3.0
  70.     SCO Xenix 386         2.3.2
  71.     SCO Unix 386         3.2
  72.     Sun 2            SunOS 3.4
  73.     Sun 2            SunOS 3.5
  74.     Sun 3            SunOS 3.4
  75.     Sun 3            SunOS 3.5
  76.     Sun 3            SunOS 4.0
  77.     Sun 4            SunOS 4.0
  78.     VAX 8750        BSD 4.3 (Mt. Xinu)
  79.     VAX 8650        BSD 4.3 (Mt. Xinu)
  80.     VAX 780            BSD 4.3 (Berkeley)
  81.     ---------------------------------------------------
  82.  
  83.     In future releases, the source will be moving toward ANSI C and POSIX 
  84.     compatibility.  This should allow for portability over any system 
  85.     supporting both ANSI and POSIX.  In addition, POSIX/ANSI portability 
  86.     library routines will be developed which will allow the code to run on 
  87.     the standard machines available now.
  88.  
  89.  
  90. DOS stuff:
  91.  
  92.     It has been tested only with the Microsoft C V5.1 compiler and
  93.     MASM V5.1.  It supports both the DOS filesystem and the raw
  94.     "tape on a disk" system used by micro UN*X systems.  For more
  95.     details, see below. This will allow for easy transfer of files
  96.     to and from UN*X systems.  Multiple volumes and the tar append
  97.     option are supported.
  98.  
  99.     To get PAX.EXE and CPIO.EXE just copy TAR.EXE to PAX.EXE and
  100.     CPIO.EXE. Since MSDOS 2.X does not report the file name to the
  101.     program, those users (and anyone else that wants to) can set the
  102.     environment variable PAXNAM to the program name that they want
  103.     (ie. set PAXNAM=tar). Note that both tar and cpio archives can
  104.     be accessed through the pax interface.
  105.  
  106.     This program does not do ANY translation on data files.  File and
  107.     directory names have their backslashes changed to forward slashes and
  108.     uppercase changed to lowercase when writing an archive on an MSDOS
  109.     machine.  File and directory names are truncated to an 8 character name
  110.     and a 3 character extension on extraction from an archive along with
  111.     translation of '.' to '_' where appropriate and translation to
  112.     monocase.
  113.  
  114.     Unix style shell regular expressions are now supported on the command
  115.     line. To prevent expansion enclose the argument in single quotes
  116.     (backslashes don't work, they are simply translated into forward
  117.     slashes).  If a *.* is encountered, the program warns the user that to
  118.     get all the files he needs to use a * instead and proceeds to archive
  119.     filenames with a period in them.  A trailing slash on a filename 
  120.     matches a directory.  Arguments with spaces in them need to be
  121.     enclosed in double quotes (ie. "'with space'").
  122.  
  123.     True dos character device support (eg. a tape drive with a
  124.     character device driver, inspired by John B. Theil) has been
  125.     added, but is only available when the archive filename is
  126.     supplied on the command line (not stdin-stdout).
  127.  
  128.     To use the raw "tape on a disk" feature give an archive filename
  129.     of "a:dio" or "b:dio" (dio stands for direct I/O) for floppy
  130.     drives "a" and "b".  This program will support any media
  131.     supported by DOS, but you MUST do a DIR on an MSDOS formatted
  132.     disk at the density you want to use before using PAX, TAR, or
  133.     CPIO with direct I/O.  Note that the direct I/O destroys the
  134.     logical structure of the disk.  
  135.  
  136.     Floppy disk type specification is now supported on the
  137.     command line for the raw disk interface. This gets rid of
  138.     having to do the disk exchange, although the disk exchange
  139.     method still works.  The following floppy disk types are
  140.     supported under pax, tar, and cpio.
  141.  
  142.     Abbreviation        Type
  143.           ld      DSDD 360k 5 1/4 inch
  144.           hd      DSHD 1.2M 5 1/4 inch
  145.           l3      DSSD 720k 3 1/2 inch
  146.           h3      DSDD 1.44M 3 1/2 inch
  147.  
  148.     The abbreviation is tacked onto the end of [ab]:dio?? like
  149.     a:diold or b:diohd.  Examples are given below.
  150.  
  151.     The default blocking factor for tar has been changed to 20.
  152.  
  153.     Examples:
  154.  
  155.     Using direct i/o on a floppy with tar.exe and a high density
  156.     formatted 5 1/4 inch floppy disk (a:diohd and b:diohd are special)
  157.     
  158.         1) Put the formatted high density floppy in drive "a"
  159.         2) tar cvf a:diohd .
  160.  
  161.     Using direct i/o on a floppy with tar.exe (a:dio and b:dio are special)
  162.     
  163.         1) Put high or low density MSDOS formatted floppy in drive "a".
  164.         2) Do a DIR (this is a required step)
  165.         3) Remove the floppy
  166.         4) Put a floppy in drive "a" with the same density as step 1
  167.         5) tar cvf a:dio .
  168.     
  169.     Using direct i/o on a floppy with cpio.exe (a:dio and b:dio are special)
  170.     
  171.         1) Put high or low density MSDOS formatted floppy in drive "a".
  172.         2) Do a DIR (this is a required step)
  173.         3) Remove the floppy
  174.         4) Put a floppy in drive "a" with the same density as step 1
  175.         5) find . -print | cpio -ocvBD a:dio
  176.              (note the undocumented D option to specify the
  177.               archive, works on reads too)
  178.     
  179.     Using direct i/o on a floppy with pax.exe and the tar archive format 
  180.     (a:dio and b:dio are special)
  181.     
  182.         1) Put high or low density MSDOS formatted floppy in drive "a".
  183.         2) Do a DIR (this is a required step)
  184.         3) Remove the floppy
  185.         4) Put a floppy in drive "a" with the same density as step 1
  186.         5) pax -w -b 20b -f a:dio .
  187.     
  188.     Using tar.exe within the MSDOS filesystem (the filename does not matter)
  189.     Will not destroy the logical structure of the disk.  Similarly for
  190.     cpio.exe and pax.exe. 
  191.     
  192.         1) Put high or low density MSDOS formatted floppy in drive "a".
  193.         2) tar cvf a:whatever.tar .
  194.     
  195.     Using tar.exe within the MSDOS filesystem to a character device like a
  196.     tape drive.
  197.     
  198.         1) Put tape in tape drive
  199.         2) tar cvf /dev/tape .
  200.  
  201.     
  202. Credit Where Credit is Due
  203.  
  204.     Parts of the code which makes up Pax were gleaned from a number of
  205.     different sources: the directory access routines in ./dirent/ are
  206.     copies of Doug Gwyn's dirent library; some of the tar archive
  207.     routines were initially written by John Gilmore for his PDTAR;
  208.     Harold Walters provided the basis for the MSDOS support and
  209.     finally afio, written by Mark Brukhartz at Lachman Associates, was
  210.     the basis for the buffering schemes used in pax.
  211.  
  212.  
  213. Licensing
  214.  
  215.     Copyright (c) 1989 Mark H. Colburn.  
  216.     All rights reserved.
  217.  
  218.     Redistribution and use in source and binary forms are permitted
  219.     provided that the above copyright notice is duplicated in all such 
  220.     forms and that any documentation, advertising materials, and other 
  221.     materials related to such distribution and use acknowledge that the 
  222.     software was developed by Mark H. Colburn.
  223.  
  224.     THE SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  225.     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  226.     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  227.  
  228. Please report any bug or problems to:
  229.  
  230. Mark Colburn
  231. Open Systems Architects, Inc.
  232. 7555 Marketplace Drive
  233. Eden Prairie, MN 55344
  234.  
  235. mark@minnetech.MN.ORG
  236.