doc/html/archive_entry_paths.3.html

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