1 .\" Copyright (c) 2010 Joerg Sonnenberger
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .Dt ARCHIVE_ENTRY_PATHS 3
29 .Nm archive_entry_hardlink ,
30 .Nm archive_entry_hardlink_w ,
31 .Nm archive_entry_set_hardlink ,
32 .Nm archive_entry_copy_hardlink ,
33 .Nm archive_entry_copy_hardlink_w ,
34 .Nm archve_entry_update_hardlink_utf8 ,
35 .Nm archive_entry_set_link ,
36 .Nm archive_entry_copy_link ,
37 .Nm archive_entry_copy_link_w ,
38 .Nm archve_entry_update_link_utf8 ,
39 .Nm archive_entry_pathname ,
40 .Nm archive_entry_pathname_w ,
41 .Nm archive_entry_set_pathname ,
42 .Nm archive_entry_copy_pathname ,
43 .Nm archive_entry_copy_pathname_w ,
44 .Nm archve_entry_update_pathname_utf8 ,
45 .Nm archive_entry_sourcepath ,
46 .Nm archive_entry_copy_sourcepath ,
47 .Nm archive_entry_symlink,
48 .Nm archive_entry_symlink_w,
49 .Nm archive_entry_set_symlink ,
50 .Nm archive_entry_copy_symlink ,
51 .Nm archive_entry_copy_symlink_w ,
52 .Nm archve_entry_update_symlink_utf8
53 .Nd functions for manipulating path names in archive entry descriptions
55 Streaming Archive Library (libarchive, -larchive)
59 .Fn archive_entry_hardlink "struct archive_entry *a"
61 .Fn archive_entry_hardlink_w "struct archive_entry *a"
63 .Fn archive_entry_set_hardlink "struct archive_entry *a" "const char *path"
65 .Fn archive_entry_copy_hardlink "struct archive_entry *a" "const char *path"
67 .Fn archive_entry_copy_hardlink_w "struct archive_entry *a "const wchar_t *path"
69 .Fn archive_entry_update_hardlink_utf8 "struct archive_entry *a" "const char *path"
71 .Fn archive_entry_set_link "struct archive_entry *a" "const char *path"
73 .Fn archive_entry_copy_link "struct archive_entry *a" " const char *path"
75 .Fn archive_entry_copy_link_w "struct archive_entry *a" " const wchar_t *path"
77 .Fn archive_entry_update_link_utf8 "struct archive_entry *a" " const char *path"
79 .Fn archive_entry_pathname "struct archive_entry *a"
81 .Fn archive_entry_pathname_w "struct archive_entry *a"
83 .Fn archive_entry_set_pathname "struct archive_entry *a" "const char *path"
85 .Fn archive_entry_copy_pathname "struct archive_entry *a" "const char *path"
87 .Fn archive_entry_copy_pathname_w "struct archive_entry *a" "const wchar_t *path"
89 .Fn archive_entry_update_pathname_utf8 "struct archive_entry *a" "const char *path"
91 .Fn archive_entry_sourcepath "struct archive_entry *a"
93 .Fn archive_entry_copy_sourcepath "struct archive_entry *a" "const char *path"
95 .Fn archive_entry_symlink "struct archive_entry *a"
97 .Fn archive_entry_symlink_w "struct archive_entry *a"
99 .Fn archive_entry_set_symlink "struct archive_entry *a" "const char *path"
101 .Fn archive_entry_copy_symlink "struct archive_entry *a" "const char *path"
103 .Fn archive_entry_copy_symlink_w "struct archive_entry *a" "const wchar_t *path"
105 .Fn archive_entry_update_symlink_utf8 "struct archive_entry *a" "const char *path"
107 Path names supported by
108 .Xr archive_entry 3 :
109 .Bl -tag -width "sourcepath" -compact
111 Destination of the hardlink.
114 For a symlink, update the destination.
115 Otherwise, make the entry a hardlink and alter
116 the destination for that.
120 Path on the disk for use by
121 .Xr archive_read_disk 3 .
123 Destination of the symbolic link.
126 Path names can be provided in one of three different ways:
127 .Bl -tag -width "wchar_t *"
129 Multibyte strings in the current locale.
131 Wide character strings in the current locale.
132 The accessor functions are named
135 Unicode strings encoded as UTF-8.
136 This are convience functions to update both the multibyte and wide
137 character strings at the same time.
140 The sourcepath is a pure filesystem concept and never stored in an
143 For that reason, it is only available as multibyte string.
144 The link path is a convience function for conditionally setting
145 hardlink or symlink destination.
146 It doesn't have a corresponding get accessor function.
148 .Fn archive_entry_set_XXX
150 .Fn archive_entry_copy_XXX .