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