Blame doc/text/archive_entry_paths.3.txt

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