ManPageArchiveEntryPaths3.wiki 4.9 KB

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