libtar-1.2.11 tarball sources, taken from Debian's orig tar
[libtar.git] / doc / th_get_pathname.3
blob41b532a5db4273f00e2706f4e95909dcb22619b2
1 .TH th_get_pathname 3 "Jan 2001" "University of Illinois" "C Library Calls"
2 .SH NAME
3 th_get_pathname, th_get_uid, th_get_gid, th_get_mode, th_get_crc, th_get_size, th_get_mtime, th_get_devmajor, th_get_devminor, th_get_linkname \- extract individual fields of a tar header
5 TH_ISREG, TH_ISLNK, TH_ISSYM, TH_ISCHR, TH_ISBLK, TH_ISDIR, TH_ISFIFO \- determine what kind of file a tar header refers to
7 TH_ISLONGNAME, TH_ISLONGLINK \- determine whether the GNU extensions are in use
8 .SH SYNOPSIS
9 .B #include <libtar.h>
11 .BI "char *th_get_linkname(TAR *" t ");"
13 .BI "char *th_get_pathname(TAR *" t ");"
15 .BI "mode_t th_get_mode(TAR *" t ");"
17 .BI "uid_t th_get_uid(TAR *" t ");"
19 .BI "gid_t th_get_gid(TAR *" t ");"
21 .BI "int th_get_crc(TAR *" t ");"
23 .BI "off_t th_get_size(TAR *" t ");"
25 .BI "time_t th_get_mtime(TAR *" t ");"
27 .BI "major_t th_get_devmajor(TAR *" t ");"
29 .BI "minor_t th_get_devminor(TAR *" t ");"
31 .BI "int TH_ISREG(TAR *" t ");"
33 .BI "int TH_ISLNK(TAR *" t ");"
35 .BI "int TH_ISSYM(TAR *" t ");"
37 .BI "int TH_ISCHR(TAR *" t ");"
39 .BI "int TH_ISBLK(TAR *" t ");"
41 .BI "int TH_ISDIR(TAR *" t ");"
43 .BI "int TH_ISFIFO(TAR *" t ");"
45 .BI "int TH_ISLONGNAME(TAR *" t ");"
47 .BI "int TH_ISLONGLINK(TAR *" t ");"
48 .SH VERSION
49 This man page documents version 1.2 of \fBlibtar\fP.
50 .SH DESCRIPTION
51 The \fBth_get_*\fP() functions extract individual fields from the current
52 tar header associated with the \fITAR\fP handle \fIt\fP.
54 The \fBTH_IS*\fP() macros are used to evaluate what kind of file is
55 pointed to by the current tar header associated with the \fITAR\fP
56 handle \fIt\fP.
58 The \fBTH_ISLONGNAME\fP() and \fBTH_ISLONGLINK\fP() macros evaluate
59 whether or not the GNU extensions are used by the current tar header
60 associated with the \fITAR\fP handle \fIt\fP.  This is only relevant
61 if the \fBTAR_GNU\fP option was used when \fItar_open\fP() was called.
62 .SH SEE ALSO
63 .BR tar_open (3)