Merge commit 'dc97a43d4a70c8773a619f11b95b07a787f6f5b7' into merges
[unleashed.git] / share / man / man3head / tar.h.3head
blob629d66a6147398b9a88e2ec39f1488b09533880d
1 '\" te
2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
3 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
7 .\"  This notice shall appear on any product containing this material.
8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
11 .TH TAR.H 3HEAD "Mar 14, 2006"
12 .SH NAME
13 tar.h, tar \- extended tar definitions
14 .SH SYNOPSIS
15 .LP
16 .nf
17 #include <\fBtar.h\fR>
18 .fi
20 .SH DESCRIPTION
21 .sp
22 .LP
23 The <\fBtar.h\fR> header defines header block definitions as follows.
24 .sp
25 .LP
26 General definitions:
27 .sp
29 .sp
30 .TS
31 c c c
32 l l l .
33 Name    Value   Description
35 \fBTMAGIC\fR    "ustar" ustar plus null byte
36 \fBTMAGLEN\fR   6       length of the above
37 \fBTVERSION\fR  "00"    00 without a null byte
38 \fBTVERSLEN\fR  2       length of the above
39 .TE
41 .sp
42 .LP
43 \fBTypeflag\fR field definitions:
44 .sp
46 .sp
47 .TS
48 c c c
49 l l l .
50 Name    Value   Description
52 \fBREGTYPE\fR   \&'0'   regular file
53 \fBAREGTYPE\fR  \&'\e0' regular file
54 \fBLNKTYPE\fR   \&'1'   link
55 \fBSYMTYPE\fR   \&'2'   symbolic link
56 \fBCHRTYPE\fR   \&'3'   character special
57 \fBBLKTYPE\fR   \&'4'   block special
58 \fBDIRTYPE\fR   \&'5'   directory
59 \fBFIFOTYPE\fR  \&'6'   FIFO special
60 \fBCONTTYPE\fR  \&'7'   reserved
61 .TE
63 .sp
64 .LP
65 \fBMode\fR field bit definitions (octal):
66 .sp
68 .sp
69 .TS
70 c c c
71 l l l .
72 Name    Value   Description
74 \fBTSUID\fR     04000   set UID on execution
75 \fBTSGID\fR     02000   set GID on execution
76 \fBTSVTX\fR     01000   on directories, restricted deletion flag
77 \fBTUREAD\fR    00400   read by owner
78 \fBTUWRITE\fR   00200   write by owner special
79 \fBTUEXEC\fR    00100   execute/search by owner
80 \fBTGREAD\fR    00040   read by group
81 \fBTGWRITE\fR   00020   write by group
82 \fBTGEXEC\fR    00010   execute/search by group
83 \fBTOREAD\fR    00004   read by other
84 \fBTOWRITE\fR   00002   write by other
85 \fBTOEXEC\fR    00001   execute/search by other
86 .TE
88 .sp
89 .LP
90 Types used in ancillary files:
91 .sp
93 .sp
94 .TS
95 c c c
96 l l l .
97 Name    Value   Description
98 \fBACL_HDR\fR   \&'A'   Access Control List
99 .TE
101 .SH ATTRIBUTES
104 See \fBattributes\fR(5) for descriptions of the following attributes:
109 box;
110 c | c
111 l | l .
112 ATTRIBUTE TYPE  ATTRIBUTE VALUE
114 Interface Stability     See below.
119 The general definitions, the \fBtypeflag\fR field definitions, and the
120 \fBmode\fR field bit definitions are Standard. The types used in ancillary
121 files are Evolving.
122 .SH SEE ALSO
125 \fBpax\fR(1), \fBattributes\fR(5), \fBstandards\fR(5)