README

   1 libtar - C library for manipulating tar files
   2 ======
   3
   4 libtar is a library for manipulating tar files from within C programs.
   5 Here are some of its features:
   6
   7   * Handles both POSIX tar file format and the GNU extensions.
   8   * API provides functions for easy use, such as tar_extract_all().
   9   * Also provides functions for more granular use, such as
  10     tar_append_regfile().
  11
  12
  13 Installation
  14 ------------
  15
  16 To build libtar, you should be able to simply run these commands:
  17
  18    ./configure
  19    make
  20    make install
  21
  22
  23 Encap Package Support
  24 ---------------------
  25
  26 To build this software as an Encap package, you can pass the
  27 --enable-encap option to configure.  This will be automatically
  28 enabled if the epkg or mkencap programs are detected on the system,
  29 but can be overridden by the --disable-encap option.
  30
  31 When building an Encap package, the configure script will automatically
  32 adjust the installation prefix to use an appropriate Encap package
  33 directory.  It does this using a heuristic algorithm which examines the
  34 values of the ${ENCAP_SOURCE} and ${ENCAP_TARGET} environment variables
  35 and the argument to configure's --prefix option.
  36
  37 If mkencap was detected on the system, it will be automatically run during
  38 "make install".  By default, epkg will also be run, but this can be
  39 inhibited with the --disable-epkg-install configure option.
  40
  41 For information on the Encap package management system, see the WSG
  42 Encap Archive:
  43
  44    http://www.encap.org/
  45
  46
  47 zlib Support
  48 ------------
  49
  50 The configure script will attempt to find the zlib library on your system
  51 for use with the libtar driver program.  The zlib package is available from:
  52
  53    http://www.gzip.org/zlib/
  54
  55 If zlib is installed on your system, but you do not wish to use it,
  56 specify the --without-zlib option when you invoke configure.
  57
  58
  59 More Information
  60 ----------------
  61
  62 For documentation of the libtar API, see the enclosed manpages.  For more
  63 information on the libtar package, see:
  64
  65    http://www.feep.net/libtar/
  66
  67 Source code for the latest version of libtar will be available there, as
  68 well as Encap binary distributions for many common platforms.
  69
  70
  71 Supported Platforms
  72 -------------------
  73
  74 I develop and test libtar on the following platforms:
  75
  76    AIX 4.3.3 and 5.1
  77    HP-UX 11.00
  78    IRIX 6.5
  79    RedHat Linux 7.2
  80    Solaris 8 and 9
  81
  82 It should also build on the following platforms, but I do not actively
  83 support them:
  84
  85    AIX 3.2.5
  86    AIX 4.2.1
  87    Cygwin
  88    FreeBSD
  89    HP-UX 10.20
  90    Linux/libc5
  91    OpenBSD
  92    Solaris 2.5
  93    Solaris 2.6
  94    Solaris 7
  95
  96 If you successfully build libtar on another platform, please email me a
  97 patch and/or configuration information.
  98
  99
 100 Compatibility Code
 101 ------------------
 102
 103 libtar depends on some library calls which are not available or not
 104 usable on some platforms.  To accomodate these systems, I've included
 105 a version of these calls in the compat subdirectory.
 106
 107 I've slightly modified these functions for integration into this source
 108 tree, but the functionality has not been modified from the original
 109 source.  Please note that while this code should work for you, I didn't
 110 write it, so please don't send me bug reports on it.
 111
 112
 113 Author
 114 ------
 115
 116 Feedback and bug reports are welcome.
 117
 118 Mark D. Roth <roth@uiuc.edu>
 119 Campus Information Technologies and Educational Services
 120 University of Illinois at Urbana-Champaign
 121