2a63a371b375678152113aebd917f108a6d4c05c
[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 1mNAME0m
4      1marchive_entry_atime22m, 1marchive_entry_atime_nsec22m,
5      1marchive_entry_atime_is_set22m, 1marchive_entry_set_atime22m,
6      1marchive_entry_unset_atime22m, 1marchive_entry_birthtime22m,
7      1marchive_entry_birthtime_nsec22m, 1marchive_entry_birthtime_is_set22m,
8      1marchive_entry_set_birthtime22m, 1marchive_entry_unset_birthtime22m,
9      1marchive_entry_ctime22m, 1marchive_entry_ctime_nsec22m,
10      1marchive_entry_ctime_is_set22m, 1marchive_entry_set_ctime22m,
11      1marchive_entry_unset_ctime22m, 1marchive_entry_mtime22m, 1marchive_entry_mtime_nsec22m,
12      1marchive_entry_mtime_is_set22m, 1marchive_entry_set_mtime22m,
13      1marchive_entry_unset_mtime22m, — functions for manipulating times in archive
14      entry descriptions
15
16 1mLIBRARY0m
17      Streaming Archive Library (libarchive, -larchive)
18
19 1mSYNOPSIS0m
20      1m#include <archive_entry.h>0m
21
22      4mtime_t0m
23      1marchive_entry_atime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
24
25      4mlong0m
26      1marchive_entry_atime_nsec22m(4mstruct24m 4marchive_entry24m 4m*a24m);
27
28      4mint0m
29      1marchive_entry_atime_is_set22m(4mstruct24m 4marchive_entry24m 4m*a24m);
30
31      4mvoid0m
32      1marchive_entry_set_atime22m(4mstruct24m 4marchive_entry24m 4m*a24m, 4mtime_t24m 4msec24m,
33          4mlong24m 4mnanosec24m);
34
35      4mvoid0m
36      1marchive_entry_unset_atime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
37
38      4mtime_t0m
39      1marchive_entry_birthtime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
40
41      4mlong0m
42      1marchive_entry_birthtime_nsec22m(4mstruct24m 4marchive_entry24m 4m*a24m);
43
44      4mint0m
45      1marchive_entry_birthtime_is_set22m(4mstruct24m 4marchive_entry24m 4m*a24m);
46
47      4mvoid0m
48      1marchive_entry_set_birthtime22m(4mstruct24m 4marchive_entry24m 4m*a24m, 4mtime_t24m 4msec24m,
49          4mlong24m 4mnanosec24m);
50
51      4mvoid0m
52      1marchive_entry_unset_birthtime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
53
54      4mtime_t0m
55      1marchive_entry_ctime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
56
57      4mlong0m
58      1marchive_entry_ctime_nsec22m(4mstruct24m 4marchive_entry24m 4m*a24m);
59
60      4mint0m
61      1marchive_entry_ctime_is_set22m(4mstruct24m 4marchive_entry24m 4m*a24m);
62
63      4mvoid0m
64      1marchive_entry_set_ctime22m(4mstruct24m 4marchive_entry24m 4m*a24m, 4mtime_t24m 4msec24m,
65          4mlong24m 4mnanosec24m);
66
67      4mvoid0m
68      1marchive_entry_unset_ctime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
69
70      4mtime_t0m
71      1marchive_entry_mtime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
72
73      4mlong0m
74      1marchive_entry_mtime_nsec22m(4mstruct24m 4marchive_entry24m 4m*a24m);
75
76      4mint0m
77      1marchive_entry_mtime_is_set22m(4mstruct24m 4marchive_entry24m 4m*a24m);
78
79      4mvoid0m
80      1marchive_entry_set_mtime22m(4mstruct24m 4marchive_entry24m 4m*a24m, 4mtime_t24m 4msec24m,
81          4mlong24m 4mnanosec24m);
82
83      4mvoid0m
84      1marchive_entry_unset_mtime22m(4mstruct24m 4marchive_entry24m 4m*a24m);
85
86 1mDESCRIPTION0m
87      These functions create and manipulate the time fields in an
88      4marchive_entry24m.  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 1mXXX_unset22m() functions can be used
97      to mark the corresponding field as missing.  The current state can be
98      queried using 1mXXX_is_set22m().  Unset time fields have a second and nanosec‐
99      ond field of 0.
100
101 1mSEE ALSO0m
102      archive_entry(3) libarchive(3),
103
104 1mHISTORY0m
105      The 1mlibarchive 22mlibrary first appeared in FreeBSD 5.3.
106
107 1mAUTHORS0m
108      The 1mlibarchive 22mlibrary was written by Tim Kientzle <kientzle@acm.org>.
109
110 BSD                            February 2, 2012                            BSD