1<!-- Creator     : groff version 1.22.4 -->
2<!-- CreationDate: Sun Aug 22 23:03:25 2021 -->
3<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4"http://www.w3.org/TR/html4/loose.dtd">
5<html>
6<head>
7<meta name="generator" content="groff -Thtml, see www.gnu.org">
8<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9<meta name="Content-Style" content="text/css">
10<style type="text/css">
11       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
12       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
13       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
14       h1      { text-align: center }
15</style>
16<title></title>
17</head>
18<body>
19
20<hr>
21
22
23<p>ARCHIVE_ENTRY_PATHS(3) BSD Library Functions Manual
24ARCHIVE_ENTRY_PATHS(3)</p>
25
26<p style="margin-top: 1em"><b>NAME</b></p>
27
28<p style="margin-left:6%;"><b>archive_entry_hardlink</b>,
29<b>archive_entry_hardlink_w</b>,
30<b>archive_entry_set_hardlink</b>,
31<b>archive_entry_copy_hardlink</b>,
32<b>archive_entry_copy_hardlink_w</b>,
33<b>archive_entry_update_hardlink_utf8</b>,
34<b>archive_entry_set_link</b>,
35<b>archive_entry_copy_link</b>,
36<b>archive_entry_copy_link_w</b>,
37<b>archive_entry_update_link_utf8</b>,
38<b>archive_entry_pathname</b>,
39<b>archive_entry_pathname_w</b>,
40<b>archive_entry_set_pathname</b>,
41<b>archive_entry_copy_pathname</b>,
42<b>archive_entry_copy_pathname_w</b>,
43<b>archive_entry_update_pathname_utf8</b>,
44<b>archive_entry_sourcepath</b>,
45<b>archive_entry_copy_sourcepath</b>,
46<b>archive_entry_symlink</b>,
47<b>archive_entry_symlink_w</b>,
48<b>archive_entry_set_symlink</b>,
49<b>archive_entry_copy_symlink</b>,
50<b>archive_entry_copy_symlink_w</b>,
51<b>archive_entry_update_symlink_utf8</b> &mdash; functions
52for manipulating path names in archive entry
53descriptions</p>
54
55<p style="margin-top: 1em"><b>LIBRARY</b></p>
56
57<p style="margin-left:6%;">Streaming Archive Library
58(libarchive, -larchive)</p>
59
60<p style="margin-top: 1em"><b>SYNOPSIS</b></p>
61
62<p style="margin-left:6%;"><b>#include
63&lt;archive_entry.h&gt;</b></p>
64
65<p style="margin-left:6%; margin-top: 1em"><i>const char
66*</i></p>
67
68
69<p style="margin-left:12%;"><b>archive_entry_hardlink</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
70
71<p style="margin-left:6%; margin-top: 1em"><i>const wchar_t
72*</i></p>
73
74
75<p style="margin-left:12%;"><b>archive_entry_hardlink_w</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
76
77<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
78
79
80<p style="margin-left:12%;"><b>archive_entry_set_hardlink</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
81<i>const&nbsp;char&nbsp;*path</i>);</p>
82
83<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
84
85
86<p style="margin-left:12%;"><b>archive_entry_copy_hardlink</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
87<i>const&nbsp;char&nbsp;*path</i>);</p>
88
89<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
90
91
92<p style="margin-left:12%;"><b>archive_entry_copy_hardlink_w</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
93<i>const</i>, <i>wchar_t</i>, <i>*path&quot;</i>);</p>
94
95<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
96
97
98<p style="margin-left:12%;"><b>archive_entry_update_hardlink_utf8</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
99<i>const&nbsp;char&nbsp;*path</i>);</p>
100
101<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
102
103
104<p style="margin-left:12%;"><b>archive_entry_set_link</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
105<i>const&nbsp;char&nbsp;*path</i>);</p>
106
107<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
108
109
110<p style="margin-left:12%;"><b>archive_entry_copy_link</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
111<i>const&nbsp;char&nbsp;*path</i>);</p>
112
113<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
114
115
116<p style="margin-left:12%;"><b>archive_entry_copy_link_w</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
117<i>const&nbsp;wchar_t&nbsp;*path</i>);</p>
118
119<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
120
121
122<p style="margin-left:12%;"><b>archive_entry_update_link_utf8</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
123<i>const&nbsp;char&nbsp;*path</i>);</p>
124
125<p style="margin-left:6%; margin-top: 1em"><i>const char
126*</i></p>
127
128
129<p style="margin-left:12%;"><b>archive_entry_pathname</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
130
131<p style="margin-left:6%; margin-top: 1em"><i>const wchar_t
132*</i></p>
133
134
135<p style="margin-left:12%;"><b>archive_entry_pathname_w</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
136
137<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
138
139
140<p style="margin-left:12%;"><b>archive_entry_set_pathname</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
141<i>const&nbsp;char&nbsp;*path</i>);</p>
142
143<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
144
145
146<p style="margin-left:12%;"><b>archive_entry_copy_pathname</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
147<i>const&nbsp;char&nbsp;*path</i>);</p>
148
149<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
150
151
152<p style="margin-left:12%;"><b>archive_entry_copy_pathname_w</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
153<i>const&nbsp;wchar_t&nbsp;*path</i>);</p>
154
155<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
156
157
158<p style="margin-left:12%;"><b>archive_entry_update_pathname_utf8</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
159<i>const&nbsp;char&nbsp;*path</i>);</p>
160
161<p style="margin-left:6%; margin-top: 1em"><i>const char
162*</i></p>
163
164
165<p style="margin-left:12%;"><b>archive_entry_sourcepath</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
166
167<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
168
169
170<p style="margin-left:12%;"><b>archive_entry_copy_sourcepath</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
171<i>const&nbsp;char&nbsp;*path</i>);</p>
172
173<p style="margin-left:6%; margin-top: 1em"><i>const char
174*</i></p>
175
176
177<p style="margin-left:12%;"><b>archive_entry_symlink</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
178
179<p style="margin-left:6%; margin-top: 1em"><i>const wchar_t
180*</i></p>
181
182
183<p style="margin-left:12%;"><b>archive_entry_symlink_w</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>);</p>
184
185<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
186
187
188<p style="margin-left:12%;"><b>archive_entry_set_symlink</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
189<i>const&nbsp;char&nbsp;*path</i>);</p>
190
191<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
192
193
194<p style="margin-left:12%;"><b>archive_entry_copy_symlink</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
195<i>const&nbsp;char&nbsp;*path</i>);</p>
196
197<p style="margin-left:6%; margin-top: 1em"><i>void</i></p>
198
199
200<p style="margin-left:12%;"><b>archive_entry_copy_symlink_w</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
201<i>const&nbsp;wchar_t&nbsp;*path</i>);</p>
202
203<p style="margin-left:6%; margin-top: 1em"><i>int</i></p>
204
205
206<p style="margin-left:12%;"><b>archive_entry_update_symlink_utf8</b>(<i>struct&nbsp;archive_entry&nbsp;*a</i>,
207<i>const&nbsp;char&nbsp;*path</i>);</p>
208
209<p style="margin-top: 1em"><b>DESCRIPTION</b></p>
210
211<p style="margin-left:6%;">Path names supported by
212archive_entry(3):</p>
213
214<p>hardlink</p>
215
216<p style="margin-left:22%; margin-top: 1em">Destination of
217the hardlink.</p>
218
219<p>link</p>
220
221<p style="margin-left:22%; margin-top: 1em">Update only.
222For a symlink, update the destination. Otherwise, make the
223entry a hardlink and alter the destination for that.</p>
224
225<p>pathname</p>
226
227<p style="margin-left:22%; margin-top: 1em">Path in the
228archive</p>
229
230<p>sourcepath</p>
231
232<p style="margin-left:22%; margin-top: 1em">Path on the
233disk for use by archive_read_disk(3).</p>
234
235<p>symlink</p>
236
237<p style="margin-left:22%; margin-top: 1em">Destination of
238the symbolic link.</p>
239
240<p style="margin-left:6%; margin-top: 1em">Path names can
241be provided in one of three different ways:</p>
242
243<p style="margin-top: 1em">char *</p>
244
245<p style="margin-left:21%; margin-top: 1em">Multibyte
246strings in the current locale.</p>
247
248<p style="margin-top: 1em">wchar_t *</p>
249
250<p style="margin-left:21%; margin-top: 1em">Wide character
251strings in the current locale. The accessor functions are
252named <b>XXX_w</b>().</p>
253
254<p style="margin-top: 1em">UTF-8</p>
255
256<p style="margin-left:21%; margin-top: 1em">Unicode strings
257encoded as UTF-8. These are convenience functions to update
258both the multibyte and wide character strings at the same
259time.</p>
260
261<p style="margin-left:6%; margin-top: 1em">The sourcepath
262is a pure filesystem concept and never stored in an archive
263directly.</p>
264
265<p style="margin-left:6%; margin-top: 1em">For that reason,
266it is only available as multibyte string. The link path is a
267convenience function for conditionally setting hardlink or
268symlink destination. It doesn&rsquo;t have a corresponding
269get accessor function.</p>
270
271
272<p style="margin-left:6%; margin-top: 1em"><b>archive_entry_set_XXX</b>()
273is an alias for <b>archive_entry_copy_XXX</b>().</p>
274
275<p style="margin-top: 1em"><b>SEE ALSO</b></p>
276
277<p style="margin-left:6%;">archive_entry(3),
278libarchive(3)</p>
279
280<p style="margin-left:6%; margin-top: 1em">BSD
281February&nbsp;2, 2012 BSD</p>
282<hr>
283</body>
284</html>
285