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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
|
<!-- Creator : groff version 1.19.2 -->
<!-- CreationDate: Sun Mar 14 19:50:13 2010 -->
<!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; }
pre { margin-top: 0; margin-bottom: 0; }
table { margin-top: 0; margin-bottom: 0; }
</style>
<title></title>
</head>
<body>
<hr>
<p valign="top">archive_entry(3) FreeBSD Library Functions
Manual archive_entry(3)</p>
<p style="margin-top: 1em" valign="top"><b>NAME</b></p>
<p style="margin-left:8%;"><b>archive_entry_acl_add_entry</b>,
<b>archive_entry_acl_add_entry_w</b>,
<b>archive_entry_acl_clear</b>,
<b>archive_entry_acl_count</b>,
<b>archive_entry_acl_next</b>,
<b>archive_entry_acl_next_w</b>,
<b>archive_entry_acl_reset</b>,
<b>archive_entry_acl_text_w</b>, <b>archive_entry_atime</b>,
<b>archive_entry_atime_nsec</b>, <b>archive_entry_clear</b>,
<b>archive_entry_clone</b>,
<b>archive_entry_copy_fflags_text</b>,
<b>archive_entry_copy_fflags_text_w</b>,
<b>archive_entry_copy_gname</b>,
<b>archive_entry_copy_gname_w</b>,
<b>archive_entry_copy_hardlink</b>,
<b>archive_entry_copy_hardlink_w</b>,
<b>archive_entry_copy_link</b>,
<b>archive_entry_copy_link_w</b>,
<b>archive_entry_copy_pathname_w</b>,
<b>archive_entry_copy_sourcepath</b>,
<b>archive_entry_copy_stat</b>,
<b>archive_entry_copy_symlink</b>,
<b>archive_entry_copy_symlink_w</b>,
<b>archive_entry_copy_uname</b>,
<b>archive_entry_copy_uname_w</b>, <b>archive_entry_dev</b>,
<b>archive_entry_devmajor</b>,
<b>archive_entry_devminor</b>,
<b>archive_entry_filetype</b>, <b>archive_entry_fflags</b>,
<b>archive_entry_fflags_text</b>, <b>archive_entry_free</b>,
<b>archive_entry_gid</b>, <b>archive_entry_gname</b>,
<b>archive_entry_hardlink</b>, <b>archive_entry_ino</b>,
<b>archive_entry_mode</b>, <b>archive_entry_mtime</b>,
<b>archive_entry_mtime_nsec</b>, <b>archive_entry_nlink</b>,
<b>archive_entry_new</b>, <b>archive_entry_pathname</b>,
<b>archive_entry_pathname_w</b>, <b>archive_entry_rdev</b>,
<b>archive_entry_rdevmajor</b>,
<b>archive_entry_rdevminor</b>,
<b>archive_entry_set_atime</b>,
<b>archive_entry_set_ctime</b>,
<b>archive_entry_set_dev</b>,
<b>archive_entry_set_devmajor</b>,
<b>archive_entry_set_devminor</b>,
<b>archive_entry_set_filetype</b>,
<b>archive_entry_set_fflags</b>,
<b>archive_entry_set_gid</b>,
<b>archive_entry_set_gname</b>,
<b>archive_entry_set_hardlink</b>,
<b>archive_entry_set_link</b>,
<b>archive_entry_set_mode</b>,
<b>archive_entry_set_mtime</b>,
<b>archive_entry_set_pathname</b>,
<b>archive_entry_set_rdevmajor</b>,
<b>archive_entry_set_rdevminor</b>,
<b>archive_entry_set_size</b>,
<b>archive_entry_set_symlink</b>,
<b>archive_entry_set_uid</b>,
<b>archive_entry_set_uname</b>, <b>archive_entry_size</b>,
<b>archive_entry_sourcepath</b>, <b>archive_entry_stat</b>,
<b>archive_entry_symlink</b>, <b>archive_entry_uid</b>,
<b>archive_entry_uname</b> — functions for
manipulating archive entry descriptions</p>
<p style="margin-top: 1em" valign="top"><b>SYNOPSIS</b></p>
<p style="margin-left:8%;"><b>#include
<archive_entry.h></b></p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p valign="top"><b>archive_entry_acl_add_entry</b>(<i>struct archive_entry *</i>,
<i>int type</i>, <i>int permset</i>,
<i>int tag</i>, <i>int qual</i>,
<i>const char *name</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p valign="top"><b>archive_entry_acl_add_entry_w</b>(<i>struct archive_entry *</i>,
<i>int type</i>, <i>int permset</i>,
<i>int tag</i>, <i>int qual</i>,
<i>const wchar_t *name</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_acl_clear</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_entry_acl_count</b>(<i>struct archive_entry *</i>,
<i>int type</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>int</i></p>
<p valign="top"><b>archive_entry_acl_next</b>(<i>struct archive_entry *</i>,
<i>int want_type</i>, <i>int *type</i>,
<i>int *permset</i>, <i>int *tag</i>,
<i>int *qual</i>,
<i>const char **name</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>int</i></p>
<p valign="top"><b>archive_entry_acl_next_w</b>(<i>struct archive_entry *</i>,
<i>int want_type</i>, <i>int *type</i>,
<i>int *permset</i>, <i>int *tag</i>,
<i>int *qual</i>,
<i>const wchar_t **name</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>int</i></p>
<p style="margin-left:14%;"><b>archive_entry_acl_reset</b>(<i>struct archive_entry *</i>,
<i>int want_type</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const wchar_t
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_acl_text_w</b>(<i>struct archive_entry *</i>,
<i>int flags</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>time_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_atime</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>long</i></p>
<p style="margin-left:14%;"><b>archive_entry_atime_nsec</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>struct
archive_entry *</i></p>
<p style="margin-left:14%;"><b>archive_entry_clear</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>struct
archive_entry *</i></p>
<p style="margin-left:14%;"><b>archive_entry_clone</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char *
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_fflags_text_w</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; 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 *</i>,
<i>const wchar_t *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_gname</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_gname_w</b>(<i>struct archive_entry *</i>,
<i>const wchar_t *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_hardlink</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_hardlink_w</b>(<i>struct archive_entry *</i>,
<i>const wchar_t *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_sourcepath</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_pathname_w</b>(<i>struct archive_entry *</i>,
<i>const wchar_t *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_stat</b>(<i>struct archive_entry *</i>,
<i>const struct stat *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_symlink</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_symlink_w</b>(<i>struct archive_entry *</i>,
<i>const wchar_t *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_uname</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_copy_uname_w</b>(<i>struct archive_entry *</i>,
<i>const wchar_t *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>dev_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_dev</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>dev_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_devmajor</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>dev_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_devminor</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>mode_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_filetype</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p valign="top"><b>archive_entry_fflags</b>(<i>struct archive_entry *</i>,
<i>unsigned long *set</i>,
<i>unsigned long *clear</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_fflags_text</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_free</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_gname</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_hardlink</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>ino_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_ino</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>mode_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_mode</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>time_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_mtime</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>long</i></p>
<p style="margin-left:14%;"><b>archive_entry_mtime_nsec</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>unsigned
int</i></p>
<p style="margin-left:14%;"><b>archive_entry_nlink</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>struct
archive_entry *</i></p>
<p style="margin-left:14%;"><b>archive_entry_new</b>(<i>void</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_pathname</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const wchar_t
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_pathname_w</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>dev_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_rdev</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>dev_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_rdevmajor</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>dev_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_rdevminor</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_dev</b>(<i>struct archive_entry *</i>,
<i>dev_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_devmajor</b>(<i>struct archive_entry *</i>,
<i>dev_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_devminor</b>(<i>struct archive_entry *</i>,
<i>dev_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_filetype</b>(<i>struct archive_entry *</i>,
<i>unsigned int</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p valign="top"><b>archive_entry_set_fflags</b>(<i>struct archive_entry *</i>,
<i>unsigned long set</i>,
<i>unsigned long clear</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_gid</b>(<i>struct archive_entry *</i>,
<i>gid_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_gname</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_hardlink</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_ino</b>(<i>struct archive_entry *</i>,
<i>unsigned long</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_link</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_mode</b>(<i>struct archive_entry *</i>,
<i>mode_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_mtime</b>(<i>struct archive_entry *</i>,
<i>time_t</i>, <i>long nanos</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_nlink</b>(<i>struct archive_entry *</i>,
<i>unsigned int</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_pathname</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_rdev</b>(<i>struct archive_entry *</i>,
<i>dev_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_rdevmajor</b>(<i>struct archive_entry *</i>,
<i>dev_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_rdevminor</b>(<i>struct archive_entry *</i>,
<i>dev_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_size</b>(<i>struct archive_entry *</i>,
<i>int64_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_symlink</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_uid</b>(<i>struct archive_entry *</i>,
<i>uid_t</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>void</i></p>
<p style="margin-left:14%;"><b>archive_entry_set_uname</b>(<i>struct archive_entry *</i>,
<i>const char *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>int64_t</i></p>
<p style="margin-left:14%;"><b>archive_entry_size</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_sourcepath</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const struct
stat *</i></p>
<p style="margin-left:14%;"><b>archive_entry_stat</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_symlink</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-left:8%; margin-top: 1em"><i>const char
*</i></p>
<p style="margin-left:14%;"><b>archive_entry_uname</b>(<i>struct archive_entry *</i>);</p>
<p style="margin-top: 1em" valign="top"><b>DESCRIPTION</b></p>
<p style="margin-left:8%;">These functions create and
manipulate data objects that represent entries within an
archive. You can think of a struct archive_entry as a
heavy-duty version of struct stat: it includes everything
from struct stat plus associated pathname, textual group and
user names, etc. These objects are used by libarchive(3) to
represent the metadata associated with a particular entry in
an archive.</p>
<p style="margin-left:8%; margin-top: 1em"><b>Create and
Destroy</b> <br>
There are functions to allocate, destroy, clear, and copy
<i>archive_entry</i> objects:</p>
<p valign="top"><b>archive_entry_clear</b>()</p>
<p style="margin-left:20%;">Erases the object, resetting
all internal fields to the same state as a newly-created
object. This is provided to allow you to quickly recycle
objects without thrashing the heap.</p>
<p valign="top"><b>archive_entry_clone</b>()</p>
<p style="margin-left:20%;">A deep copy operation; all text
fields are duplicated.</p>
<p valign="top"><b>archive_entry_free</b>()</p>
<p style="margin-left:20%;">Releases the struct
archive_entry object.</p>
<p valign="top"><b>archive_entry_new</b>()</p>
<p style="margin-left:20%;">Allocate and return a blank
struct archive_entry object.</p>
<p style="margin-left:8%; margin-top: 1em"><b>Set and Get
Functions</b> <br>
Most of the functions here set or read entries in an object.
Such functions have one of the following forms:</p>
<p valign="top"><b>archive_entry_set_XXXX</b>()</p>
<p style="margin-left:20%;">Stores the provided data in the
object. In particular, for strings, the pointer is stored,
not the referenced string.</p>
<p valign="top"><b>archive_entry_copy_XXXX</b>()</p>
<p style="margin-left:20%;">As above, except that the
referenced data is copied into the object.</p>
<p valign="top"><b>archive_entry_XXXX</b>()</p>
<p style="margin-left:20%;">Returns the specified data. In
the case of strings, a const-qualified pointer to the string
is returned.</p>
<p style="margin-left:8%;">String data can be set or
accessed as wide character strings or normal <i>char</i>
strings. The functions that use wide character strings are
suffixed with <b>_w</b>. Note that these are different
representations of the same data: For example, if you store
a narrow string and read the corresponding wide string, the
object will transparently convert formats using the current
locale. Similarly, if you store a wide string and then store
a narrow string for the same data, the previously-set wide
string will be discarded in favor of the new data.</p>
<p style="margin-left:8%; margin-top: 1em">There are a few
set/get functions that merit additional description:</p>
<p valign="top"><b>archive_entry_set_link</b>()</p>
<p style="margin-left:20%;">This function sets the symlink
field if it is already set. Otherwise, it sets the hardlink
field.</p>
<p style="margin-left:8%; margin-top: 1em"><b>File
Flags</b> <br>
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:8%; 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 fflagstostr(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:8%; 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 sets 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
strtofflags(3), which stops parsing at the first
unrecognized name.)</p>
<p style="margin-left:8%; margin-top: 1em"><b>ACL
Handling</b> <br>
XXX This needs serious help. XXX</p>
<p style="margin-left:8%; margin-top: 1em">An
‘‘Access Control List’’ (ACL) is a
list of permissions that grant access to particular users or
groups beyond what would normally be provided by standard
POSIX mode bits. The ACL handling here addresses some
deficiencies in the POSIX.1e draft 17 ACL specification. In
particular, POSIX.1e draft 17 specifies several different
formats, but none of those formats include both textual
user/group names and numeric UIDs/GIDs.</p>
<p style="margin-left:8%; margin-top: 1em">XXX explain ACL
stuff XXX</p>
<p style="margin-top: 1em" valign="top"><b>SEE ALSO</b></p>
<p style="margin-left:8%;">archive(3)</p>
<p style="margin-top: 1em" valign="top"><b>HISTORY</b></p>
<p style="margin-left:8%;">The <b>libarchive</b> library
first appeared in FreeBSD 5.3.</p>
<p style="margin-top: 1em" valign="top"><b>AUTHORS</b></p>
<p style="margin-left:8%;">The <b>libarchive</b> library
was written by Tim Kientzle
⟨kientzle@acm.org⟩.</p>
<p style="margin-left:8%; margin-top: 1em">FreeBSD 9.0
May 12, 2008 FreeBSD 9.0</p>
<hr>
</body>
</html>
|
