Imported Upstream version 3.3.0
[platform/upstream/libarchive.git] / doc / text / archive_entry_time.3.txt
1 ARCHIVE_ENTRY_TIME(3)    BSD Library Functions Manual    ARCHIVE_ENTRY_TIME(3)
2
3 NAME
4      archive_entry_atime, archive_entry_atime_nsec,
5      archive_entry_atime_is_set, archive_entry_set_atime,
6      archive_entry_unset_atime, archive_entry_birthtime,
7      archive_entry_birthtime_nsec, archive_entry_birthtime_is_set,
8      archive_entry_set_birthtime, archive_entry_unset_birthtime,
9      archive_entry_ctime, archive_entry_ctime_nsec,
10      archive_entry_ctime_is_set, archive_entry_set_ctime,
11      archive_entry_unset_ctime, archive_entry_mtime, archive_entry_mtime_nsec,
12      archive_entry_mtime_is_set, archive_entry_set_mtime,
13      archive_entry_unset_mtime, — functions for manipulating times in archive
14      entry descriptions
15
16 LIBRARY
17      Streaming Archive Library (libarchive, -larchive)
18
19 SYNOPSIS
20      #include <archive_entry.h>
21
22      time_t
23      archive_entry_atime(struct archive_entry *a);
24
25      long
26      archive_entry_atime_nsec(struct archive_entry *a);
27
28      int
29      archive_entry_atime_is_set(struct archive_entry *a);
30
31      void
32      archive_entry_set_atime(struct archive_entry *a, time_t sec,
33          long nanosec);
34
35      void
36      archive_entry_unset_atime(struct archive_entry *a);
37
38      time_t
39      archive_entry_birthtime(struct archive_entry *a);
40
41      long
42      archive_entry_birthtime_nsec(struct archive_entry *a);
43
44      int
45      archive_entry_birthtime_is_set(struct archive_entry *a);
46
47      void
48      archive_entry_set_birthtime(struct archive_entry *a, time_t sec,
49          long nanosec);
50
51      void
52      archive_entry_unset_birthtime(struct archive_entry *a);
53
54      time_t
55      archive_entry_ctime(struct archive_entry *a);
56
57      long
58      archive_entry_ctime_nsec(struct archive_entry *a);
59
60      int
61      archive_entry_ctime_is_set(struct archive_entry *a);
62
63      void
64      archive_entry_set_ctime(struct archive_entry *a, time_t sec,
65          long nanosec);
66
67      void
68      archive_entry_unset_ctime(struct archive_entry *a);
69
70      time_t
71      archive_entry_mtime(struct archive_entry *a);
72
73      long
74      archive_entry_mtime_nsec(struct archive_entry *a);
75
76      int
77      archive_entry_mtime_is_set(struct archive_entry *a);
78
79      void
80      archive_entry_set_mtime(struct archive_entry *a, time_t sec,
81          long nanosec);
82
83      void
84      archive_entry_unset_mtime(struct archive_entry *a);
85
86 DESCRIPTION
87      These functions create and manipulate the time fields in an
88      archive_entry.  Supported time fields are atime (access time), birthtime
89      (creation time), ctime (last time an inode property was changed) and
90      mtime (modification time).
91
92      libarchive(3) provides a high-resolution interface.  The timestamps are
93      truncated automatically depending on the archive format (for archiving)
94      or the filesystem capabilities (for restoring).
95
96      All timestamp fields are optional.  The XXX_unset() functions can be used
97      to mark the corresponding field as missing.  The current state can be
98      queried using XXX_is_set().  Unset time fields have a second and nanosec‐
99      ond field of 0.
100
101 SEE ALSO
102      archive_entry(3) libarchive(3),
103
104 HISTORY
105      The libarchive library first appeared in FreeBSD 5.3.
106
107 AUTHORS
108      The libarchive library was written by Tim Kientzle <kientzle@acm.org>.
109
110 BSD                            February 2, 2012                            BSD