Add description of archive_entry_perm/archive_entry_set_perm and

the interaction with archive_entry_set_mode. Move the description of
the latter to archive_entry_stat.3, where archive_entry_filetype and co
are.

SVN-Revision: 1959

1 files changed, 21 insertions, 0 deletions

diff --git a/libarchive/archive_entry_stat.3 b/libarchive/archive_entry_stat.3
index 63d67153..b4391234 100644
--- a/libarchive/archive_entry_stat.3
+++ b/libarchive/archive_entry_stat.3
@@ -30,6 +30,8 @@
 .Nm archive_entry_copy_stat ,
 .Nm archive_entry_filetype ,
 .Nm archive_entry_set_filetype ,
+.Nm archive_entry_mode ,
+.Nm archive_entry_set_mode ,
 .Nm archive_entry_size ,
 .Nm archive_entry_size_is_set ,
 .Nm archive_entry_set_size ,
@@ -62,6 +64,10 @@
 .Fn archive_entry_filetype "struct archive_entry *a"
 .Ft void
 .Fn archive_entry_set_filetype "struct archive_entry *a" "unsigned int type"
+.Ft mode_t
+.Fn archive_entry_mode "struct archive_entry *a"
+.Ft void
+.Fn archive_entry_set_mode "struct archive_entry *a" "mode_t mode"
 .Ft int64_t
 .Fn archive_entry_size "struct archive_entry *a"
 .Ft int
@@ -153,6 +159,21 @@ The constants used by
 .Xr stat 2
 may have different numeric value.
 .Pp
+The functions
+.Fn archive_entry_mode
+and
+.Fn archive_entry_set_mode
+get/set a combination of file type and permissions.
+Use of
+.Fn archive_entry_filetype
+and
+.Fn archive_entry_perm
+for getting and
+.Fn archive_entry_set_filetype
+and
+.Fn archive_entry_set_perm
+for setting is recommented.
+.Pp
 The function
 .Fn archive_entry_size
 returns the file size, if it has been set, and 0 otherwise.