usr/src/man/man3head/tar.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH TAR.H 3HEAD "Mar 14, 2006"
  47 .SH NAME
  48 tar.h, tar \- extended tar definitions
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBtar.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBtar.h\fR> header defines header block definitions as follows.
  59 .sp
  60 .LP
  61 General definitions:
  62 .sp
  63
  64 .sp
  65 .TS
  66 c c c
  67 l l l .
  68 Name    Value   Description
  69 _
  70 \fBTMAGIC\fR    "ustar" ustar plus null byte
  71 \fBTMAGLEN\fR   6       length of the above
  72 \fBTVERSION\fR  "00"    00 without a null byte
  73 \fBTVERSLEN\fR  2       length of the above
  74 .TE
  75
  76 .sp
  77 .LP
  78 \fBTypeflag\fR field definitions:
  79 .sp
  80
  81 .sp
  82 .TS
  83 c c c
  84 l l l .
  85 Name    Value   Description
  86 _
  87 \fBREGTYPE\fR   \&'0'   regular file
  88 \fBAREGTYPE\fR  \&'\e0' regular file
  89 \fBLNKTYPE\fR   \&'1'   link
  90 \fBSYMTYPE\fR   \&'2'   symbolic link
  91 \fBCHRTYPE\fR   \&'3'   character special
  92 \fBBLKTYPE\fR   \&'4'   block special
  93 \fBDIRTYPE\fR   \&'5'   directory
  94 \fBFIFOTYPE\fR  \&'6'   FIFO special
  95 \fBCONTTYPE\fR  \&'7'   reserved
  96 .TE
  97
  98 .sp
  99 .LP
 100 \fBMode\fR field bit definitions (octal):
 101 .sp
 102
 103 .sp
 104 .TS
 105 c c c
 106 l l l .
 107 Name    Value   Description
 108 _
 109 \fBTSUID\fR     04000   set UID on execution
 110 \fBTSGID\fR     02000   set GID on execution
 111 \fBTSVTX\fR     01000   on directories, restricted deletion flag
 112 \fBTUREAD\fR    00400   read by owner
 113 \fBTUWRITE\fR   00200   write by owner special
 114 \fBTUEXEC\fR    00100   execute/search by owner
 115 \fBTGREAD\fR    00040   read by group
 116 \fBTGWRITE\fR   00020   write by group
 117 \fBTGEXEC\fR    00010   execute/search by group
 118 \fBTOREAD\fR    00004   read by other
 119 \fBTOWRITE\fR   00002   write by other
 120 \fBTOEXEC\fR    00001   execute/search by other
 121 .TE
 122
 123 .sp
 124 .LP
 125 Types used in ancillary files:
 126 .sp
 127
 128 .sp
 129 .TS
 130 c c c
 131 l l l .
 132 Name    Value   Description
 133 \fBACL_HDR\fR   \&'A'   Access Control List
 134 \fBLBL_TYPE\fR  \&'L'   Trusted Extensions file label
 135 \fBDIR_TYPE\fR  \&'D'   Trusted Extensions directory label
 136 .TE
 137
 138 .sp
 139 .LP
 140 Attribute types used in Trusted Solaris ancillary files that are interpreted by
 141 Trusted Extensions for backward compatibility:
 142 .sp
 143
 144 .sp
 145 .TS
 146 c c c
 147 l l l .
 148 Name    Value   Description
 149 \fBSLD_TYPE\fR  \&'S'   Single-level directory component
 150 \fBPATH_TYPE\fR \&'P'   Path component
 151 \fBMLD_TYPE\fR  \&'M'   Multi-level directory component
 152 \fBFILE_TYPE\fR \&'F'   Must handle files differently
 153 \fBAPRIV_TYPE\fR        \&'P'   Allowed privileges data type in file
 154 \fBFPRIV_TYPE\fR        \&'p'   Forced privileges data type in file
 155 \fBCOMP_TYPE\fR \&'C'   Path components, use for MLD
 156 \fBATTR_FLAG_TYPE\fR    \&'F'   File attribute flag bytes data type
 157 \fBLK_COMP_TYPE\fR      \&'K'   Link data path component
 158 .TE
 159
 160 .SH ATTRIBUTES
 161 .sp
 162 .LP
 163 See \fBattributes\fR(5) for descriptions of the following attributes:
 164 .sp
 165
 166 .sp
 167 .TS
 168 box;
 169 c | c
 170 l | l .
 171 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 172 _
 173 Interface Stability     See below.
 174 .TE
 175
 176 .sp
 177 .LP
 178 The general definitions, the \fBtypeflag\fR field definitions, and the
 179 \fBmode\fR field bit definitions are Standard. The types used in ancillary
 180 files and the attribute types used in Trusted Solaris ancillary files are
 181 Evolving.
 182 .SH SEE ALSO
 183 .sp
 184 .LP
 185 \fBpax\fR(1), \fBattributes\fR(5), \fBstandards\fR(5)