1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
<!-- Creator : groff version 1.23.0 -->
<!-- CreationDate: Mon Jan 5 10:42:43 2026 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title></title>
</head>
<body>
<hr>
<p><i>ARCHIVE_ENTRY_PERMS</i>(3) Library Functions Manual
<i>ARCHIVE_ENTRY_PERMS</i>(3)</p>
<p style="margin-top: 1em"><b>NAME</b></p>
<p style="margin-left:9%;">archive_entry_gid,
archive_entry_set_gid, archive_entry_uid,
archive_entry_set_uid, archive_entry_perm,
archive_entry_set_perm, archive_entry_strmode,
archive_entry_uname, archive_entry_uname_w,
archive_entry_set_uname, archive_entry_copy_uname,
archive_entry_copy_uname_w, archive_entry_update_uname_utf8,
archive_entry_gname, archive_entry_gname_w,
archive_entry_set_gname, archive_entry_copy_gname,
archive_entry_copy_gname_w, archive_entry_update_gname_utf8,
archive_entry_fflags, archive_entry_fflags_text,
archive_entry_set_fflags, archive_entry_copy_fflags_text,
archive_entry_copy_fflags_text_w — functions for
manipulating ownership and permissions in archive entry
descriptions</p>
<p style="margin-top: 1em"><b>LIBRARY</b></p>
<p style="margin-left:9%;">Streaming Archive Library
(libarchive, -larchive)</p>
<p style="margin-top: 1em"><b>SYNOPSIS</b></p>
<p style="margin-left:9%;"><b>#include
<archive_entry.h></b></p>
<p style="margin-left:9%; margin-top: 1em"><i>gid_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_gid</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_gid</b>(<i>struct archive_entry *a</i>,
<i>gid_t gid</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>uid_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_uid</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_uid</b>(<i>struct archive_entry *a</i>,
<i>uid_t uid</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>mode_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_perm</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_perm</b>(<i>struct archive_entry *a</i>,
<i>mode_t mode</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_strmode</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_gname</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const wchar_t
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_gname_w</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_gname</b>(<i>struct archive_entry *a</i>,
<i>const char *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_gname</b>(<i>struct archive_entry *a</i>,
<i>const char *name</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_gname_w</b>(<i>struct archive_entry *a</i>,
<i>const wchar_t *name</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_entry_update_gname_utf8</b>(<i>struct archive_entry *a</i>,
<i>const char *name</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_uname</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const wchar_t
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_uname_w</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_uname</b>(<i>struct archive_entry *a</i>,
<i>const char *name</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_uname</b>(<i>struct archive_entry *a</i>,
<i>const char *name</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_uname_w</b>(<i>struct archive_entry *a</i>,
<i>const wchar_t *name</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_entry_update_uname_utf8</b>(<i>struct archive_entry *a</i>,
<i>const char *name</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p><b>archive_entry_fflags</b>(<i>struct archive_entry *a</i>,
<i>unsigned long *set_bits</i>,
<i>unsigned long *clear_bits</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_fflags_text</b>(<i>struct archive_entry *a</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>void</i></p>
<p><b>archive_entry_set_fflags</b>(<i>struct archive_entry *a</i>,
<i>unsigned long set_bits</i>,
<i>unsigned long clear_bits</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_fflags_text</b>(<i>struct archive_entry *a</i>,
<i>const char *text</i>);</p>
<p style="margin-left:9%; margin-top: 1em"><i>const wchar_t
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_fflags_text_w</b>(<i>struct archive_entry *a</i>,
<i>const wchar_t *text</i>);</p>
<p style="margin-top: 1em"><b>DESCRIPTION</b></p>
<p style="margin-left:4%;"><b>User id, group id and
mode</b></p>
<p style="margin-left:9%;">The functions
<b>archive_entry_uid</b>(), <b>archive_entry_gid</b>(), and
<b>archive_entry_perm</b>() can be used to extract the user
id, group id and permission from the given entry. The
corresponding functions <b>archive_entry_set_uid</b>(),
<b>archive_entry_set_gid</b>(), and
<b>archive_entry_set_perm</b>() store the given user id,
group id and permission in the entry. The permission is also
set as a side effect of calling
<b>archive_entry_set_mode</b>().</p>
<p style="margin-left:9%; margin-top: 1em"><b>archive_entry_strmode</b>()
returns a string representation of the permission as used by
the long mode of <i>ls</i>(1).</p>
<p style="margin-left:4%; margin-top: 1em"><b>User and
group name</b></p>
<p style="margin-left:9%;">User and group names can be
provided in one of three different ways:</p>
<p style="margin-top: 1em">char *</p>
<p style="margin-left:23%; margin-top: 1em">Multibyte
strings in the current locale.</p>
<p style="margin-top: 1em">wchar_t *</p>
<p style="margin-left:23%; margin-top: 1em">Wide character
strings in the current locale. The accessor functions are
named <b>XXX_w</b>().</p>
<p style="margin-top: 1em">UTF-8</p>
<p style="margin-left:23%; margin-top: 1em">Unicode strings
encoded as UTF-8. These are convenience functions to update
both the multibyte and wide character strings at the same
time.</p>
<p style="margin-left:9%; margin-top: 1em"><b>archive_entry_set_XXX</b>()
is an alias for <b>archive_entry_copy_XXX</b>(). The strings
are copied, and don’t need to outlive the call.</p>
<p style="margin-left:4%; margin-top: 1em"><b>File
Flags</b></p>
<p style="margin-left:9%;">File flags are transparently
converted between a bitmap representation and a textual
format. For example, if you set the bitmap and ask for text,
the library will build a canonical text format. However, if
you set a text format and request a text format, you will
get back the same text, even if it is ill-formed. If you
need to canonicalize a textual flags string, you should
first set the text form, then request the bitmap form, then
use that to set the bitmap form. Setting the bitmap format
will clear the internal text representation and force it to
be reconstructed when you next request the text form.</p>
<p style="margin-left:9%; margin-top: 1em">The bitmap
format consists of two integers, one containing bits that
should be set, the other specifying bits that should be
cleared. Bits not mentioned in either bitmap will be
ignored. Usually, the bitmap of bits to be cleared will be
set to zero. In unusual circumstances, you can force a
fully-specified set of file flags by setting the bitmap of
flags to clear to the complement of the bitmap of flags to
set. (This differs from <i>fflagstostr</i>(3), which only
includes names for set bits.) Converting a bitmap to a
textual string is a platform-specific operation; bits that
are not meaningful on the current platform will be
ignored.</p>
<p style="margin-left:9%; margin-top: 1em">The canonical
text format is a comma-separated list of flag names. The
<b>archive_entry_copy_fflags_text</b>() and
<b>archive_entry_copy_fflags_text_w</b>() functions parse
the provided text and set the internal bitmap values. This
is a platform-specific operation; names that are not
meaningful on the current platform will be ignored. The
function returns a pointer to the start of the first name
that was not recognized, or NULL if every name was
recognized. Note that every name — including names
that follow an unrecognized name — will be evaluated,
and the bitmaps will be set to reflect every name that is
recognized. (In particular, this differs from
<i>strtofflags</i>(3), which stops parsing at the first
unrecognized name.)</p>
<p style="margin-top: 1em"><b>SEE ALSO</b></p>
<p style="margin-left:9%;"><i>archive_entry</i>(3),
<i>archive_entry_acl</i>(3), <i>archive_read_disk</i>(3),
<i>archive_write_disk</i>(3), <i>libarchive</i>(3)</p>
<p style="margin-top: 1em"><b>BUGS</b></p>
<p style="margin-left:9%;">The platform types <i>uid_t</i>
and <i>gid_t</i> are often 16 or 32 bit wide. In this case
it is possible that the ids can not be correctly restored
from archives and get truncated. Debian February 2, 2012
<i>ARCHIVE_ENTRY_PERMS</i>(3)</p>
<hr>
</body>
</html>
|
