Blame doc/text/archive_entry_paths.3.txt

Packit Service 1d0348
ARCHIVE_ENTRY_PATHS(3)	 BSD Library Functions Manual	ARCHIVE_ENTRY_PATHS(3)
Packit Service 1d0348
Packit Service 1d0348
NAME
Packit Service 1d0348
     archive_entry_hardlink, archive_entry_hardlink_w,
Packit Service 1d0348
     archive_entry_set_hardlink, archive_entry_copy_hardlink,
Packit Service 1d0348
     archive_entry_copy_hardlink_w, archive_entry_update_hardlink_utf8,
Packit Service 1d0348
     archive_entry_set_link, archive_entry_copy_link,
Packit Service 1d0348
     archive_entry_copy_link_w, archive_entry_update_link_utf8,
Packit Service 1d0348
     archive_entry_pathname, archive_entry_pathname_w,
Packit Service 1d0348
     archive_entry_set_pathname, archive_entry_copy_pathname,
Packit Service 1d0348
     archive_entry_copy_pathname_w, archive_entry_update_pathname_utf8,
Packit Service 1d0348
     archive_entry_sourcepath, archive_entry_copy_sourcepath,
Packit Service 1d0348
     archive_entry_symlink, archive_entry_symlink_w,
Packit Service 1d0348
     archive_entry_set_symlink, archive_entry_copy_symlink,
Packit Service 1d0348
     archive_entry_copy_symlink_w, archive_entry_update_symlink_utf8 — func‐
Packit Service 1d0348
     tions for manipulating path names in archive entry descriptions
Packit Service 1d0348
Packit Service 1d0348
LIBRARY
Packit Service 1d0348
     Streaming Archive Library (libarchive, -larchive)
Packit Service 1d0348
Packit Service 1d0348
SYNOPSIS
Packit Service 1d0348
     #include <archive_entry.h>
Packit Service 1d0348
Packit Service 1d0348
     const char *
Packit Service 1d0348
     archive_entry_hardlink(struct archive_entry *a);
Packit Service 1d0348
Packit Service 1d0348
     const wchar_t *
Packit Service 1d0348
     archive_entry_hardlink_w(struct archive_entry *a);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_set_hardlink(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_hardlink(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_hardlink_w(struct archive_entry *a, const, wchar_t,
Packit Service 1d0348
	 *path");
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_entry_update_hardlink_utf8(struct archive_entry *a,
Packit Service 1d0348
	 const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_set_link(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_link(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_link_w(struct archive_entry *a, const wchar_t *path);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_entry_update_link_utf8(struct archive_entry *a,
Packit Service 1d0348
	 const char *path);
Packit Service 1d0348
Packit Service 1d0348
     const char *
Packit Service 1d0348
     archive_entry_pathname(struct archive_entry *a);
Packit Service 1d0348
Packit Service 1d0348
     const wchar_t *
Packit Service 1d0348
     archive_entry_pathname_w(struct archive_entry *a);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_set_pathname(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_pathname(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_pathname_w(struct archive_entry *a,
Packit Service 1d0348
	 const wchar_t *path);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_entry_update_pathname_utf8(struct archive_entry *a,
Packit Service 1d0348
	 const char *path);
Packit Service 1d0348
Packit Service 1d0348
     const char *
Packit Service 1d0348
     archive_entry_sourcepath(struct archive_entry *a);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_sourcepath(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     const char *
Packit Service 1d0348
     archive_entry_symlink(struct archive_entry *a);
Packit Service 1d0348
Packit Service 1d0348
     const wchar_t *
Packit Service 1d0348
     archive_entry_symlink_w(struct archive_entry *a);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_set_symlink(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_symlink(struct archive_entry *a, const char *path);
Packit Service 1d0348
Packit Service 1d0348
     void
Packit Service 1d0348
     archive_entry_copy_symlink_w(struct archive_entry *a,
Packit Service 1d0348
	 const wchar_t *path);
Packit Service 1d0348
Packit Service 1d0348
     int
Packit Service 1d0348
     archive_entry_update_symlink_utf8(struct archive_entry *a,
Packit Service 1d0348
	 const char *path);
Packit Service 1d0348
Packit Service 1d0348
DESCRIPTION
Packit Service 1d0348
     Path names supported by archive_entry(3):
Packit Service 1d0348
     hardlink	 Destination of the hardlink.
Packit Service 1d0348
     link	 Update only.  For a symlink, update the destination.  Other‐
Packit Service 1d0348
		 wise, make the entry a hardlink and alter the destination for
Packit Service 1d0348
		 that.
Packit Service 1d0348
     pathname	 Path in the archive
Packit Service 1d0348
     sourcepath  Path on the disk for use by archive_read_disk(3).
Packit Service 1d0348
     symlink	 Destination of the symbolic link.
Packit Service 1d0348
Packit Service 1d0348
     Path names can be provided in one of three different ways:
Packit Service 1d0348
Packit Service 1d0348
     char *	Multibyte strings in the current locale.
Packit Service 1d0348
Packit Service 1d0348
     wchar_t *	Wide character strings in the current locale.  The accessor
Packit Service 1d0348
		functions are named XXX_w().
Packit Service 1d0348
Packit Service 1d0348
     UTF-8	Unicode strings encoded as UTF-8.  This are convience func‐
Packit Service 1d0348
		tions to update both the multibyte and wide character strings
Packit Service 1d0348
		at the same time.
Packit Service 1d0348
Packit Service 1d0348
     The sourcepath is a pure filesystem concept and never stored in an ar‐
Packit Service 1d0348
     chive directly.
Packit Service 1d0348
Packit Service 1d0348
     For that reason, it is only available as multibyte string.  The link path
Packit Service 1d0348
     is a convience function for conditionally setting hardlink or symlink
Packit Service 1d0348
     destination.  It doesn't have a corresponding get accessor function.
Packit Service 1d0348
Packit Service 1d0348
     archive_entry_set_XXX() is an alias for archive_entry_copy_XXX().
Packit Service 1d0348
Packit Service 1d0348
SEE ALSO
Packit Service 1d0348
     archive_entry(3) libarchive(3),
Packit Service 1d0348
Packit Service 1d0348
BSD			       February 2, 2012 			   BSD