blob: 91f466cbe4e0efd3ed4804d17c2df1f2820c175d [file] [log] [blame]
bigbiff bigbiff9c754052013-01-09 09:09:08 -05001libtar - C library for manipulating tar files
2======
3
4libtar is a library for manipulating tar files from within C programs.
5Here 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
13Installation
14------------
15
16To build libtar, you should be able to simply run these commands:
17
18 ./configure
19 make
20 make install
21
22
23Encap Package Support
24---------------------
25
26To build this software as an Encap package, you can pass the
27--enable-encap option to configure. This will be automatically
28enabled if the epkg or mkencap programs are detected on the system,
29but can be overridden by the --disable-encap option.
30
31When building an Encap package, the configure script will automatically
32adjust the installation prefix to use an appropriate Encap package
33directory. It does this using a heuristic algorithm which examines the
34values of the ${ENCAP_SOURCE} and ${ENCAP_TARGET} environment variables
35and the argument to configure's --prefix option.
36
37If 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
39inhibited with the --disable-epkg-install configure option.
40
41For information on the Encap package management system, see the WSG
42Encap Archive:
43
44 http://www.encap.org/
45
46
47zlib Support
48------------
49
50The configure script will attempt to find the zlib library on your system
51for use with the libtar driver program. The zlib package is available from:
52
53 http://www.gzip.org/zlib/
54
55If zlib is installed on your system, but you do not wish to use it,
56specify the --without-zlib option when you invoke configure.
57
58
59More Information
60----------------
61
62For documentation of the libtar API, see the enclosed manpages. For more
63information on the libtar package, see:
64
65 http://www-dev.cites.uiuc.edu/libtar/
66
67Source code for the latest version of libtar will be available there, as
68well as Encap binary distributions for many common platforms.
69
70
71Supported Platforms
72-------------------
73
74I 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
82It should also build on the following platforms, but I do not actively
83support 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
96If you successfully build libtar on another platform, please email me a
97patch and/or configuration information.
98
99
100Compatibility Code
101------------------
102
103libtar depends on some library calls which are not available or not
104usable on some platforms. To accomodate these systems, I've included
105a version of these calls in the compat subdirectory.
106
107I've slightly modified these functions for integration into this source
108tree, but the functionality has not been modified from the original
109source. Please note that while this code should work for you, I didn't
110write it, so please don't send me bug reports on it.
111
112
113Author
114------
115
116Feedback and bug reports are welcome.
117
118Mark D. Roth <roth@uiuc.edu>
119Campus Information Technologies and Educational Services
120University of Illinois at Urbana-Champaign
121