← Back to branch summary

~ubuntu-branches/ubuntu/quantal/libarchive/quantal

« back to all changes in this revision

Viewing changes to doc/wiki/ManPageArchiveEntryPaths3.wiki

  • Committer: Package Import Robot
  • Author(s): Andres Mejia
  • Date: 2012-02-23 19:29:24 UTC
  • mfrom: (8.1.10 sid)
  • Revision ID: package-import@ubuntu.com-20120223192924-73n4iedok5fwgsyr
Tags: 3.0.3-5
* Detect if locales or locales-all is installed for use with test suite.
* Bump Standards-Version to 3.9.3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/wiki/ManPageArchiveEntryPaths3.wiki
 
1
#summary ARCHIVE_ENTRY_PATHS 3 manual page
 
2
== NAME ==
 
3
*archive_entry_hardlink*,
 
4
*archive_entry_hardlink_w*,
 
5
*archive_entry_set_hardlink*,
 
6
*archive_entry_copy_hardlink*,
 
7
*archive_entry_copy_hardlink_w*,
 
8
*archve_entry_update_hardlink_utf8*,
 
9
*archive_entry_set_link*,
 
10
*archive_entry_copy_link*,
 
11
*archive_entry_copy_link_w*,
 
12
*archve_entry_update_link_utf8*,
 
13
*archive_entry_pathname*,
 
14
*archive_entry_pathname_w*,
 
15
*archive_entry_set_pathname*,
 
16
*archive_entry_copy_pathname*,
 
17
*archive_entry_copy_pathname_w*,
 
18
*archve_entry_update_pathname_utf8*,
 
19
*archive_entry_sourcepath*,
 
20
*archive_entry_copy_sourcepath*,
 
21
*archive_entry_symlink,*
 
22
*archive_entry_symlink_w,*
 
23
*archive_entry_set_symlink*,
 
24
*archive_entry_copy_symlink*,
 
25
*archive_entry_copy_symlink_w*,
 
26
*archve_entry_update_symlink_utf8*
 
27
- functions for manipulating path names in archive entry descriptions
 
28
== SYNOPSIS ==
 
29
*#include <archive_entry.h>*
 
30
<br>
 
31
*const char `*`*
 
32
<br>
 
33
*archive_entry_hardlink*(_struct archive_entry `*`a_);
 
34
<br>
 
35
*const wchar_t `*`*
 
36
<br>
 
37
*archive_entry_hardlink_w*(_struct archive_entry `*`a_);
 
38
<br>
 
39
*void*
 
40
<br>
 
41
*archive_entry_set_hardlink*(_struct archive_entry `*`a_, _const char `*`path_);
 
42
<br>
 
43
*void*
 
44
<br>
 
45
*archive_entry_copy_hardlink*(_struct archive_entry `*`a_, _const char `*`path_);
 
46
<br>
 
47
*void*
 
48
<br>
 
49
*archive_entry_copy_hardlink_w*(_struct archive_entry `*`a _, _const_, _wchar_t_, _`*`path"_);
 
50
<br>
 
51
*int*
 
52
<br>
 
53
*archive_entry_update_hardlink_utf8*(_struct archive_entry `*`a_, _const char `*`path_);
 
54
<br>
 
55
*void*
 
56
<br>
 
57
*archive_entry_set_link*(_struct archive_entry `*`a_, _const char `*`path_);
 
58
<br>
 
59
*void*
 
60
<br>
 
61
*archive_entry_copy_link*(_struct archive_entry `*`a_, _ const char `*`path_);
 
62
<br>
 
63
*void*
 
64
<br>
 
65
*archive_entry_copy_link_w*(_struct archive_entry `*`a_, _ const wchar_t `*`path_);
 
66
<br>
 
67
*int*
 
68
<br>
 
69
*archive_entry_update_link_utf8*(_struct archive_entry `*`a_, _ const char `*`path_);
 
70
<br>
 
71
*const char `*`*
 
72
<br>
 
73
*archive_entry_pathname*(_struct archive_entry `*`a_);
 
74
<br>
 
75
*const wchar_t `*`*
 
76
<br>
 
77
*archive_entry_pathname_w*(_struct archive_entry `*`a_);
 
78
<br>
 
79
*void*
 
80
<br>
 
81
*archive_entry_set_pathname*(_struct archive_entry `*`a_, _const char `*`path_);
 
82
<br>
 
83
*void*
 
84
<br>
 
85
*archive_entry_copy_pathname*(_struct archive_entry `*`a_, _const char `*`path_);
 
86
<br>
 
87
*void*
 
88
<br>
 
89
*archive_entry_copy_pathname_w*(_struct archive_entry `*`a_, _const wchar_t `*`path_);
 
90
<br>
 
91
*int*
 
92
<br>
 
93
*archive_entry_update_pathname_utf8*(_struct archive_entry `*`a_, _const char `*`path_);
 
94
<br>
 
95
*const char `*`*
 
96
<br>
 
97
*archive_entry_sourcepath*(_struct archive_entry `*`a_);
 
98
<br>
 
99
*void*
 
100
<br>
 
101
*archive_entry_copy_sourcepath*(_struct archive_entry `*`a_, _const char `*`path_);
 
102
<br>
 
103
*const char `*`*
 
104
<br>
 
105
*archive_entry_symlink*(_struct archive_entry `*`a_);
 
106
<br>
 
107
*const wchar_t `*`*
 
108
<br>
 
109
*archive_entry_symlink_w*(_struct archive_entry `*`a_);
 
110
<br>
 
111
*void*
 
112
<br>
 
113
*archive_entry_set_symlink*(_struct archive_entry `*`a_, _const char `*`path_);
 
114
<br>
 
115
*void*
 
116
<br>
 
117
*archive_entry_copy_symlink*(_struct archive_entry `*`a_, _const char `*`path_);
 
118
<br>
 
119
*void*
 
120
<br>
 
121
*archive_entry_copy_symlink_w*(_struct archive_entry `*`a_, _const wchar_t `*`path_);
 
122
<br>
 
123
*int*
 
124
<br>
 
125
*archive_entry_update_symlink_utf8*(_struct archive_entry `*`a_, _const char `*`path_);
 
126
== DESCRIPTION ==
 
127
Path names supported by
 
128
*archive_entry*(3):
 
129
<dl>
 
130
<dt>hardlink</dt><dd>
 
131
Destination of the hardlink.
 
132
</dd><dt>link</dt><dd>
 
133
Update only.
 
134
For a symlink, update the destination.
 
135
Otherwise, make the entry a hardlink and alter
 
136
the destination for that.
 
137
</dd><dt>pathname</dt><dd>
 
138
Path in the archive
 
139
</dd><dt>sourcepath</dt><dd>
 
140
Path on the disk for use by
 
141
*archive_read_disk*(3).
 
142
</dd><dt>symlink</dt><dd>
 
143
Destination of the symbolic link.
 
144
</dd></dl>
 
145
 
 
146
Path names can be provided in one of three different ways:
 
147
<dl>
 
148
<dt>char *</dt><dd>
 
149
Multibyte strings in the current locale.
 
150
</dd><dt>wchar_t *</dt><dd>
 
151
Wide character strings in the current locale.
 
152
The accessor functions are named
 
153
*XXX_w*().
 
154
</dd><dt>UTF-8</dt><dd>
 
155
Unicode strings encoded as UTF-8.
 
156
This are convience functions to update both the multibyte and wide
 
157
character strings at the same time.
 
158
</dd></dl>
 
159
 
 
160
The sourcepath is a pure filesystem concept and never stored in an
 
161
archive directly.
 
162
 
 
163
For that reason, it is only available as multibyte string.
 
164
The link path is a convience function for conditionally setting
 
165
hardlink or symlink destination.
 
166
It doesn't have a corresponding get accessor function.
 
167
 
 
168
*archive_entry_set_XXX*()
 
169
is an alias for 
 
170
*archive_entry_copy_XXX*().
 
171
== SEE ALSO ==
 
172
*archive*(3),
 
173
*archive_entry*(3)